Public
Documentation Settings
No Environment
Double Column
cURL - cURL
SplitIt Web API
Introduction
POST
1. Login
POST
2. Initiate
POST
3. Create
POST
4. Approve
POST
5. StartInstallments
POST
6. UpdatePlan
POST
7. Cancel
POST
8. Refund
POST
9. Get
POST
10. VerifyPayment

SplitIt Web API

Welcome

Welcome to the Splitit API reference; Before using this document, it is recommended to read our solution overview in order to choose the best solution for your needs.

Prerequisite  

 

In order to start working you will need the following data:

  • UserName - The username of your API user in Splitit system
  • Password - The password of your API user in Splitit system
  • ApiKey - Your terminal API key

You must receive this data from your Splitit onboarding contact. If you need assistance, please email us at onboarding@splitit.com

Sandbox and Production environments

Development should be done in our sandbox environment. Once development is complete, please contact your onboarding contact for approval and credentials to our production environment.

API Reference content

Each service contains the following details:

  • Service endpoint route
  • General description of the service 
  • Detailed request parameters description
  • Detailed response parameters description
  • Data required to be sent in the request header 
  • Example for Json data body required to be sent in body
  • Code example (choose your preferred language on the selection list located in the right bar)

 

 

General 

Splitit services are implemented as simple and standard HTTP POST requests with 1 header parameter (Content-Type = application/json) and Json body with specific schema for each request.

 

Request

Each request body (other than login) must contain an element called RequestHeader which contains the following parameters:

  • SessionId - the session received by the login request (see request below)
  • ApiKey – use the terminal API key received by your Splitit onboarding contact

 

 

Response

Each response contains an element called ResponseHeader which includes the following parameters:

  • Succeeded - boolean parameter indicating if the request succeeded or failed (true - succeeded, false - failed).
  • Errors – An array of errors, populated whenever the response failed (succeeded = false). Each element in the errors contains an error code and error description. Error descriptions can be displayed to users. 
  • Remark - on current version, only first element in error collection is populated.  

 

Important: Each response must be verified it succeeded as following:

1) HTTP Status code = 200 - indicating there was no network or infrastructure error

2) ResponseHeader.Succeeded= true - applicative check indicating all business validation succeeded and the operation was done successfully.

 Please refer to your specific request after choosing your solution from our documentation.

 

 

 

 

 

Loading