PlanData

Parameter Name
Type
Required
Description
Amount
Amount
​
The order total amount, includes Value (decimal). Example - 305.50 CurrencyCode (string) - should be in a format of ISO 4217 currency. Example - USD
PurchaseMethod
string
ECommerce
The method of purchasing, choose one of the following: InStore – physical store purchase; PhoneOrder – phone order; Ecommerce – purchase on ecommerce site
RefOrderNumber
string
​
Reference merchant order number
AutoCapture
bool
Default
Indicates whether to capture the first installment automatically when creating the plan or whether to wait for an explicit indication to do the first capture. * The default behavior was defined in your merchant account at Splitit.
FirstInstallmentAmount
Amount
​
The first installment amount. Should be populated only if the first installment amount is different from the following installment amounts (ex: includes shipping amount as part of the first installment).
FirstChargeDate
Date
​
The first installment date. Should be populated only if the first installment date is not scheduled for the plan creation date.
Attempt3DSecure
bool
false
Indicate whether to try and attempt running 3D secure transactions. Please note: 1) Check with Splitit support to determine if your account settings allow the performing of 3D secure transactions. 2) In order to run 3D secure, you will need to populate redirect URLs (Success\Error), please follow the documentation regarding RedirectUrls below.
ExtendedParams
ExtendedParams
​
Any merchant parameter you would like to capture on the plan (ex: secondary order number). Those parameters can later be queried. Example: "ExtendedParams": { "AnyParameterKey1": " AnyParameterVal1", "AnyParameterKey2": " AnyParameterVal2"}

Parameter Name	Type	Required	Description
Amount	Amount		The order total amount, includes Value (decimal). Example - 305.50 CurrencyCode (string) - should be in a format of ISO 4217 currency. Example - USD
PurchaseMethod	string	ECommerce	The method of purchasing, choose one of the following: InStore – physical store purchase; PhoneOrder – phone order; Ecommerce – purchase on ecommerce site
RefOrderNumber	string		Reference merchant order number
AutoCapture	bool	Default	Indicates whether to capture the first installment automatically when creating the plan or whether to wait for an explicit indication to do the first capture. * The default behavior was defined in your merchant account at Splitit.
FirstInstallmentAmount	Amount		The first installment amount. Should be populated only if the first installment amount is different from the following installment amounts (ex: includes shipping amount as part of the first installment).
FirstChargeDate	Date		The first installment date. Should be populated only if the first installment date is not scheduled for the plan creation date.
Attempt3DSecure	bool	false	Indicate whether to try and attempt running 3D secure transactions. Please note: 1) Check with Splitit support to determine if your account settings allow the performing of 3D secure transactions. 2) In order to run 3D secure, you will need to populate redirect URLs (Success\Error), please follow the documentation regarding RedirectUrls below.
ExtendedParams	ExtendedParams		Any merchant parameter you would like to capture on the plan (ex: secondary order number). Those parameters can later be queried. Example: "ExtendedParams": { "AnyParameterKey1": " AnyParameterVal1", "AnyParameterKey2": " AnyParameterVal2"}

Last modified 5mo ago