Skip to main content

Fetch Plan by Number

GET 
/:installmentPlanNumber

Retrieve an installment plan's information by providing its number in your path.

Request​

Path Parameters

    installmentPlanNumber stringrequired

    The number of the installment plan for which you'd like information

Header Parameters

    X-Splitit-IdempotencyKey string

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

    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

    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

    Installments

    object[]

  • Array [

    • InstallmentNumberint32required
    Amountdecimalrequired
    ProcessDateTimedate-time
    Statusstringrequired

    Possible values: [Pending, Processed, Canceled]

  • ]

    • Refunds

    object[]

  • Array [

    • RefundIdstring
    SubmitDatedate-timerequired
    TotalAmountdecimalrequired
    Statusstringrequired

    Possible values: [Pending, Succeeded, Failed]

    NonCreditRefundAmountdecimalrequired
    CreditRefundAmountdecimalrequired

  • ]

    • Links

    object

    Checkoutstring
    LearnMorestring
    TermsConditionsstring
    PrivacyPolicystring