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-TestMode string

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

Body

    AutoCaptureboolean

    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)

    Attempt3dSecureboolean

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

    TermsAndConditionsAcceptedbooleanrequired

    Indicates that the shopper accepted your Terms and Conditions

    Shopper

    object

    required

    FullNamestring
    Emailstringrequired
    PhoneNumberstring
    Culturestring

    PlanData

    object

    required

    TotalAmountdecimalrequired

    The total order amount

    Currencystringrequired
    NumberOfInstallmentsint32required

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

    TerminalIdstringrequired

    The merchant terminal identifier

    PurchaseMethodstring

    How purchase was made (default is ECommerce)

    Possible values: [InStore, PhoneOrder, ECommerce]

    RefOrderNumberstring

    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
    FirstInstallmentAmountdecimal
    FirstInstallmentDatedate-time

    BillingAddress

    object

    AddressLine1string
    AddressLine2string
    Citystring
    Countrystring

    ISO 3166-3 code

    Statestring

    ISO 3166-2 code

    Zipstring

    PaymentMethod

    object

    required

    Type

    Possible values: [Card, SplititToken]

    Card

    object

    required

    CardHolderFullNamestring
    CardNumberstringrequired
    CardExpYearstringrequired
    CardExpMonthstringrequired
    CardCvvstring
    CardBrandstring

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

    CardTypestring

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

    Tokenstring

    RedirectUrls

    object

    AuthorizeSucceededstring
    Succeededstring
    AuthorizeFailedstring
    Failedstring

    EventsEndpoints

    object

    CreateSucceededstring

Responses​

Success

Schema

    InstallmentPlanNumberstring
    DateCreateddate-timerequired
    RefOrderNumberstring
    PurchaseMethodstring

    How purchase was made (default is ECommerce)

    Possible values: [InStore, PhoneOrder, ECommerce]

    Statusstringrequired

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

    Currencystring
    OriginalAmountdecimal
    Amountdecimal

    ExtendedParams

    object

    property name*string

    Authorization

    object

    Statusstringrequired

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

    Datedate-time
    SplititErrorResultCodestring
    GatewayTransactionIDstring
    GatewayResultCodestring
    GatewayResultMessagestring

    ThreeDSRedirect

    object

    Urlstring
    Verbstring

    Params

    object

    property name*string
    CAVVstring
    ECIstring

    Shopper

    object

    FullNamestring
    Emailstringrequired
    PhoneNumberstring
    Culturestring

    BillingAddress

    object

    AddressLinestring
    AddressLine2string
    Citystring
    Countrystring

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

    Statestring

    ISO 3166-2 State

    Zipstring

    PaymentMethod

    object

    Type

    Possible values: [Card, SplititToken]

    Card

    object

    required

    CardHolderFullNamestring
    CardNumberstringrequired
    CardExpYearstringrequired
    CardExpMonthstringrequired
    CardCvvstring
    CardBrandstring

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

    CardTypestring

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

    Tokenstring

    Installments

    object[]

  • Array [

    • InstallmentNumberint32required
    Amountdecimalrequired
    ProcessDateTimedate-time
    Statusstringrequired

    Possible values: [Pending, Processed, Canceled]

  • ]

    • Links

    object

    Checkoutstring
    LearnMorestring
    TermsConditionsstring
    PrivacyPolicystring