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

Responses

200

Success

application/json

Schema

Schema

PlanList

object[]

Array [

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

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

]

Example (from schema)

{
  "PlanList": [
    {
      "InstallmentPlanNumber": "string",
      "DateCreated": "2024-07-29T15:51:28.071Z",
      "RefOrderNumber": "string",
      "PurchaseMethod": "InStore",
      "Status": "Initialized",
      "Currency": "string",
      "OriginalAmount": 0,
      "Amount": 0,
      "Authorization": {
        "Status": "NA",
        "Date": "2024-07-29T15:51:28.071Z",
        "SplititErrorResultCode": "string",
        "GatewayTransactionID": "string",
        "GatewayResultCode": "string",
        "GatewayResultMessage": "string",
        "ThreeDSRedirect": {
          "Url": "string",
          "Verb": "string",
          "Params": {}
        },
        "CAVV": "string",
        "ECI": "string"
      },
      "Shopper": {
        "FullName": "string",
        "Email": "string",
        "PhoneNumber": "string",
        "Culture": "string"
      },
      "BillingAddress": {
        "AddressLine": "string",
        "AddressLine2": "string",
        "City": "string",
        "Country": "string",
        "State": "string",
        "Zip": "string"
      },
      "PaymentMethod": {
        "Card": {
          "CardHolderFullName": "string",
          "CardNumber": "string",
          "CardExpYear": "string",
          "CardExpMonth": "string",
          "CardCvv": "string",
          "CardBrand": "Mastercard",
          "CardType": "Credit"
        },
        "Token": "string"
      },
      "ExtendedParams": {},
      "Installments": [
        {
          "InstallmentNumber": 0,
          "Amount": 0,
          "ProcessDateTime": "2024-07-29T15:51:28.071Z",
          "Status": "Pending"
        }
      ],
      "Refunds": [
        {
          "RefundId": "string",
          "SubmitDate": "2024-07-29T15:51:28.071Z",
          "TotalAmount": 0,
          "Status": "Pending",
          "NonCreditRefundAmount": 0,
          "CreditRefundAmount": 0
        }
      ],
      "Links": {
        "Checkout": "string",
        "LearnMore": "string",
        "TermsConditions": "string",
        "PrivacyPolicy": "string"
      }
    }
  ]
}

401

Unauthorized Request: Token is not authorized or is expired

application/json

Schema

Schema

TraceIdstring

Error

object

Codestring

Messagestring

AdditionalInfostring

ExtraData

object

property name*string

Example (from schema)

{
  "TraceId": "string",
  "Error": {
    "Code": "string",
    "Message": "string",
    "AdditionalInfo": "string",
    "ExtraData": {}
  }
}

403

application/json

Schema

Schema

TraceIdstring

Error

object

Codestring

Messagestring

AdditionalInfostring

ExtraData

object

property name*string

Example (from schema)

{
  "TraceId": "string",
  "Error": {
    "Code": "string",
    "Message": "string",
    "AdditionalInfo": "string",
    "ExtraData": {}
  }
}

404

Resource Does Not Exist: Plan or service does not exist; for all APIs, if an invalid plan number is passed in the URL, this error will be returned

application/json

Schema

Schema

TraceIdstring

Error

object

Codestring

Messagestring

AdditionalInfostring

ExtraData

object

property name*string

Example (from schema)

{
  "TraceId": "string",
  "Error": {
    "Code": "string",
    "Message": "string",
    "AdditionalInfo": "string",
    "ExtraData": {}
  }
}

422

application/json

Schema

Schema

TraceIdstring

Error

object

Codestring

Messagestring

AdditionalInfostring

ExtraData

object

property name*string

Example (from schema)

{
  "TraceId": "string",
  "Error": {
    "Code": "string",
    "Message": "string",
    "AdditionalInfo": "string",
    "ExtraData": {}
  }
}

500

General Server Error: Server encountered an unexpected condition

application/json

Schema

Schema

TraceIdstring

Error

object

Codestring

Messagestring

AdditionalInfostring

ExtraData

object

property name*string

Example (from schema)

{
  "TraceId": "string",
  "Error": {
    "Code": "string",
    "Message": "string",
    "AdditionalInfo": "string",
    "ExtraData": {}
  }
}

400-599

General Error: Sorry. There has been an error. Please try again.

application/json

Schema

Schema

TraceIdstring

Error

object

Codestring

Messagestring

AdditionalInfostring

ExtraData

object

property name*string

Example (from schema)

{
  "TraceId": "string",
  "Error": {
    "Code": "string",
    "Message": "string",
    "AdditionalInfo": "string",
    "ExtraData": {}
  }
}