Skip to main content

Initiate Installment Plan

POST 

/initiate

Initiate establishes an installment plan but doesn't finalize it, and is thus intended for use with Splitit premade checkout solutions such as Payment Forms or Flex Form. Initiate only requires SAQ-A certification. You can call it multiple times for the same installment plan, since each time a new API call is made, existing data will be updated and new values will be appended to the existing plan. Note that for funded plans, a customer's BillingAddress object must be filled out.

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 booleanrequired

    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)

    Shopper

    object

    FullName string
    Email string
    PhoneNumber string
    Culture string

    PlanData

    object

    required

    TotalAmount decimal

    The total order amount

    Currency stringrequired
    NumberOfInstallments int32

    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

    RedirectUrls

    object

    Used for 3DS redirection back to success or failure page

    Succeeded string
    Failed string
    Cancel string

    UxSettings

    object

    DisplayedInstallmentOptions int32[]

    EventsEndpoints

    object

    CreateSucceeded string

Responses

Success

Schema

    InstallmentPlanNumber string
    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
    Amount decimal

    ExtendedParams

    object

    property name* 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
    CheckoutUrl string
Loading...