Skip to main content

Create Installment Plan

POST 

/

Once you are ready to check your customer out, you can use the Create endpoint. Create enables you to pass in PCI sensitive data directly to the Splitit API, and thus requires SAQ-D PCI certification.

A successful Create operation creates an authorization on a customer's credit card, and if AutoCapture has been set to true within the request body, both authorization and capture of the first installment will be completed (if AutoCapture is set to false, you will have to call Update Plan later). If Splitit is unable to successfully secure an authorization on a credit card, an error message will be returned in the response. Note that for funded plans, a customer's BillingAddress object must be filled out. In addition, if you are completely managing the input of PCI sensitive data on your side, it’s essential to ensure your customer has approved the Splitit specific terms and conditions.

Request

Header Parameters

    X-Splitit-IdempotencyKey string
    X-Splitit-Idempotency-Behaviour string

    Possible values: [DisableReprocessingOnError, AllowReprocessingOnError]

    AllowReprocessingOnError is the default, which means that if you have a failed response or a timeout, the original request is marked as having failed, but a new request can be sent using the same key and will be reprocessed; if you set it to DisableReprocessingOnError, a request with the same key will not be reprocessed after a failure, and if the key is used again, you will get the same error response you got the first time

    X-Splitit-TestMode string

    Possible values: [None, Regular, Fast, Automation]

Body

    AutoCapture boolean

    Indicates whether to capture the first installment automatically when creating the plan, or to wait for explicit indication to do the first capture (the default is true)

    Attempt3dSecure boolean

    Indicates whether to run a 3D secure verification (default is false)

    TermsAndConditionsAccepted booleanrequired

    Indicates that the shopper accepted your Terms and Conditions

    Shopper

    object

    required

    FullName string
    Email stringrequired
    PhoneNumber string
    Culture string

    PlanData

    object

    required

    TotalAmount decimalrequired

    The total order amount

    Currency stringrequired
    NumberOfInstallments int32required

    When populated will be used to display as default in Payment Form

    TerminalId stringrequired

    The merchant terminal identifier

    PurchaseMethod string

    Possible values: [InStore, PhoneOrder, ECommerce]

    How purchase was made (default is ECommerce)

    RefOrderNumber string

    Reference order number for merchant's use

    ExtendedParams

    object

    Additional data that can be added as key/value pair parameters by merchant (and later can be retrieved by GET)

    property name* string
    FirstInstallmentAmount decimal
    FirstInstallmentDate date-time

    BillingAddress

    object

    AddressLine1 string
    AddressLine2 string
    City string
    Country string

    ISO 3166-3 code

    State string

    ISO 3166-2 code

    Zip string

    PaymentMethod

    object

    required

    Type

    Possible values: [Card, SplititToken]

    Card

    object

    required

    CardHolderFullName string
    CardNumber stringrequired
    CardExpYear stringrequired
    CardExpMonth stringrequired
    CardCvv string
    CardBrand string

    Possible values: [Mastercard, Visa, AmericanExpress, Maestro, JCB, CUP, UPI, Discover, Other]

    CardType string

    Possible values: [Credit, Debit, Charge, Other, Prepaid, VisaDeferredDebit, NetworkOnly]

    Token string

    RedirectUrls

    object

    AuthorizeSucceeded string
    Succeeded string
    AuthorizeFailed string
    Failed string

    EventsEndpoints

    object

    CreateSucceeded string

Responses

Success

Schema

    InstallmentPlanNumber string
    DateCreated date-timerequired
    RefOrderNumber string
    PurchaseMethod string

    Possible values: [InStore, PhoneOrder, ECommerce]

    How purchase was made (default is ECommerce)

    Status stringrequired

    Possible values: [Initialized, PendingCapture, Active, Cleared, Canceled]

    Currency string
    OriginalAmount decimal
    Amount decimal

    ExtendedParams

    object

    property name* string

    Authorization

    object

    Status stringrequired

    Possible values: [NA, Succeeded, Pending3DS, Failed]

    Date date-time
    SplititErrorResultCode string
    GatewayTransactionID string
    GatewayResultCode string
    GatewayResultMessage string

    ThreeDSRedirect

    object

    Url string
    Verb string

    Params

    object

    property name* string
    CAVV string
    ECI string

    Shopper

    object

    FullName string
    Email stringrequired
    PhoneNumber string
    Culture string

    BillingAddress

    object

    AddressLine string
    AddressLine2 string
    City string
    Country string

    ISO 3166 Country name OR 2-character code OR 3-character code

    State string

    ISO 3166-2 State

    Zip string

    PaymentMethod

    object

    Type

    Possible values: [Card, SplititToken]

    Card

    object

    required

    CardHolderFullName string
    CardNumber stringrequired
    CardExpYear stringrequired
    CardExpMonth stringrequired
    CardCvv string
    CardBrand string

    Possible values: [Mastercard, Visa, AmericanExpress, Maestro, JCB, CUP, UPI, Discover, Other]

    CardType string

    Possible values: [Credit, Debit, Charge, Other, Prepaid, VisaDeferredDebit, NetworkOnly]

    Token string

    Installments

    object[]

  • Array [

  • InstallmentNumber int32required
    Amount decimalrequired
    ProcessDateTime date-time
    Status stringrequired

    Possible values: [Pending, Processed, Canceled]

  • ]

  • Links

    object

    Checkout string
    LearnMore string
    TermsConditions string
    PrivacyPolicy string
Loading...