Links

Initiate

Initiate establishes an installment plan but doesn't finalize it. It doesn't transmit PCI sensitive data via API, but rather via highly secure Splitit IFrames. Thus it only requires SAQ-A certification. Initiate is used by both Flex Fields and Hosted Payment Solution.
To call Initiate, in addition to being authenticated, you will need a Payment Terminal API Key.
Initiate can be called multiple times for the same installment plan. Each time a new API call is made, existing data will be updated and new values will be appended to the existing plan. Note that for funded plans, a customer's BillingAddress object must be filled out.
post
https://webapi.{environment}.splitit.com
/api/InstallmentPlan/Initiate
Initiate

Example Requests

cURL
curl --request POST \
--url https://webapi.sandbox.splitit.com/api/InstallmentPlan/Initiate \
--header 'Authorization: Basic QVXAVXNlcjAwMDAzMjIwMDp0QjJyam9XeTdjWDdiQnlkTUZiWWo2UUZ2OFU5M1NvWlBZeHdTdFN3TVhqUTVYZTJaMA==' \
--header 'Content-Type: application/json' \
--data '{
"RequestHeader": {
"ApiKey": "5cd7654d-6858-47f3-9e19-97cbc06c14f1",
},
"PlanData": {
"Amount": {"Value": 121,"CurrencyCode": "USD"},
"RefOrderNumber": "xxxxxx",
"AutoCapture": true,
"ExtendedParams": {
"AnyParameterKey1": "AnyParameterVal1",
"AnyParameterKey2": "AnyParameterVal2"
}
},
"BillingAddress": {
"AddressLine": "1st Street",
"AddressLine2": "Apartment 1",
"City": "New York",
"State": "NY",
"Country": "USA",
"Zip": "10016"
},
"ConsumerData": {
"FullName": "John Smith",
"Email": "[email protected]",
"PhoneNumber": "1-844-775-4848",
"CultureName": "en-us"
},
"CreditCardDetails": {
"CardCvv": "123",
"CardHolderFullName": "John Smith",
"CardNumber": "4111111111111111",
"CardExpYear": "2029",
"CardExpMonth": "8"
},
"PaymentWizardData": {
"RequestedNumberOfInstallments": "1,2"
},
"RedirectUrls": {
"Succeeded": "http://localhost/Succeeded",
"Failed": "http://localhost/Failed",
"Canceled": "http://localhost/Canceled"
},
"EventsEndpoints": {
"CreateSucceeded": "https://www.async-success.com/"
}
// "ResponseElements":{
// "DisplaySchedules": true
// }
}'
Last modified 3mo ago