Fetch Plan by Number

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

Path Parameters
installmentPlanNumber string — REQUIRED The number of the installment plan for which you'd like information

Header Parameters
X-Splitit-IdempotencyKey string

Responses
200 Success Schema — OPTIONAL InstallmentPlanNumber string — OPTIONAL DateCreated date-time RefOrderNumber string — OPTIONAL PurchaseMethod string — OPTIONAL Possible values: [InStore, PhoneOrder, ECommerce] How purchase was made (default is ECommerce) Status string Possible values: [Initialized, PendingCapture, Active, Cleared, Canceled] Currency string — OPTIONAL OriginalAmount decimal — OPTIONAL Amount decimal — OPTIONAL Authorization object — OPTIONAL Status string Possible values: [NA, Succeeded, Pending3DS, Failed] Date date-time — OPTIONAL SplititErrorResultCode string — OPTIONAL GatewayTransactionID string — OPTIONAL GatewayResultCode string — OPTIONAL GatewayResultMessage string — OPTIONAL ThreeDSRedirect object — OPTIONAL Url string — OPTIONAL Verb string — OPTIONAL Params object — OPTIONAL CAVV string — OPTIONAL ECI string — OPTIONAL Shopper object — OPTIONAL FullName string — OPTIONAL Email string PhoneNumber string — OPTIONAL Culture string — OPTIONAL BillingAddress object — OPTIONAL AddressLine string — OPTIONAL AddressLine2 string — OPTIONAL City string — OPTIONAL Country string — OPTIONAL ISO 3166 Country name OR 2-character code OR 3-character code State string — OPTIONAL ISO 3166-2 State Zip string — OPTIONAL PaymentMethod object — OPTIONAL Type — OPTIONAL Possible values: [Card, SplititToken] Card object CardHolderFullName string — OPTIONAL CardNumber string CardExpYear string CardExpMonth string CardCvv string — OPTIONAL CardBrand string — OPTIONAL Possible values: [Mastercard, Visa, AmericanExpress, Maestro, JCB, CUP, UPI, Discover, Other] CardType string — OPTIONAL Possible values: [Credit, Debit, Charge, Other, Prepaid, VisaDeferredDebit, NetworkOnly] Token string — OPTIONAL ExtendedParams object — OPTIONAL Additional data that can be added as key/value pair parameters by merchant (and later can be retrieved by GET) Installments object[] — OPTIONAL InstallmentNumber int32 Amount decimal ProcessDateTime date-time — OPTIONAL Status string Possible values: [Pending, Processed, Canceled] Refunds object[] — OPTIONAL RefundId string — OPTIONAL SubmitDate date-time TotalAmount decimal Status string Possible values: [Pending, Succeeded, Failed] NonCreditRefundAmount decimal CreditRefundAmount decimal Links object — OPTIONAL Checkout string — OPTIONAL LearnMore string — OPTIONAL TermsConditions string — OPTIONAL PrivacyPolicy string — OPTIONAL
401 Unauthorized Request: Token is not authorized or is expired Schema — OPTIONAL TraceId string — OPTIONAL Error object — OPTIONAL Code string — OPTIONAL Message string — OPTIONAL AdditionalInfo string — OPTIONAL ExtraData object — OPTIONAL
403 Schema — OPTIONAL TraceId string — OPTIONAL Error object — OPTIONAL Code string — OPTIONAL Message string — OPTIONAL AdditionalInfo string — OPTIONAL ExtraData object — OPTIONAL
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 Schema — OPTIONAL TraceId string — OPTIONAL Error object — OPTIONAL Code string — OPTIONAL Message string — OPTIONAL AdditionalInfo string — OPTIONAL ExtraData object — OPTIONAL
500 General Server Error: Server encountered an unexpected condition Schema — OPTIONAL TraceId string — OPTIONAL Error object — OPTIONAL Code string — OPTIONAL Message string — OPTIONAL AdditionalInfo string — OPTIONAL ExtraData object — OPTIONAL
400-599 General Error: Sorry. There has been an error. Please try again. Schema — OPTIONAL TraceId string — OPTIONAL Error object — OPTIONAL Code string — OPTIONAL Message string — OPTIONAL AdditionalInfo string — OPTIONAL ExtraData object — OPTIONAL