Skip to main content

Fetch Plan(s) by Alternate Field

GET 

/search

Retrieves a plan by RefOrderNumber or ExtendedParams. Note that RefOrderNumber or ExtendedParams were optionally specified by you upon plan creation.

Request

Query Parameters

    refOrderNumber string
    extendedParams object

    Specify the key and value you used when establishing the plan. For example ExtendedParams["MerchantInternalID"]="5345532"

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

Responses

Success

Schema

    PlanList

    object[]

  • Array [

  • 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

    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

    ExtendedParams

    object

    property name* string

    Installments

    object[]

  • Array [

  • InstallmentNumber int32required
    Amount decimalrequired
    ProcessDateTime date-time
    Status stringrequired

    Possible values: [Pending, Processed, Canceled]

  • ]

  • Refunds

    object[]

  • Array [

  • RefundId string
    SubmitDate date-timerequired
    TotalAmount decimalrequired
    Status stringrequired

    Possible values: [Pending, Succeeded, Failed]

    NonCreditRefundAmount decimalrequired
    CreditRefundAmount decimalrequired
  • ]

  • Links

    object

    Checkout string
    LearnMore string
    TermsConditions string
    PrivacyPolicy string
  • ]

Loading...