{"info":{"_postman_id":"480e2bab-1acd-d320-06b0-4ad453001414","name":"SplitIt API","description":"

Welcome

Welcome to Splitit API reference, this document details the supported services and the parameters required to be sent to each of our services.

Before starting to use 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 credentials:

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 can receive the credentials from your Splitit onboarding contact. please don't hesitate and shoot us an email at onboarding@splitit.com

Sandbox and Production environments

Development should be done on our sandbox environment, once development completed, please contact your onboarding reference for approval and credentials to the production environment

Sandbox:\n
- URL - https://web-api-sandbox.splitit.com
- Test Cards (any other card will result an error \"Unrecognized card\" ) :\n
  - Visa: 4111 1111 1111 1111
  - Master Card: 5555 5555 5555 4444
  \n
\n
Production\n
- URL - https://web-api.splitit.com
\n

API Reference content

Each service contains the following details:

Service rout
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)

Common overview (for all Requests and Responses)

General

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

Request

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

SessionId - the session received by the login request (see request below)
ApiKey - the terminal api key received by your Splitit onboarding contact.

Response

Each response contain element called ResponseHeader which contain the following parameters:

Succeeded - boolean parameter indicating if the request succeeded or failed (true - succeeded, false-failed).
Errors - Array of errors, populated whenever response failed (succeeded=false) , each element in the errors contain error code and error description, error description 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 done successfully.

********************End of introduction:********************

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

","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"795699","collectionId":"480e2bab-1acd-d320-06b0-4ad453001414","publishedId":"2Qpqqj","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"e542f4"},"publishDate":"2016-12-07T09:52:32.000Z"},"item":[{"name":"1. Login","event":[{"listen":"test","script":{"type":"text/javascript","exec":["var data = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"SessionId\", data.SessionId);",""]}}],"id":"b152da1d-39f1-a67e-935e-d80bd97c2f4f","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \n \"UserName\":\"{{UserName}}\",\n \"Password\":\"{{Password}}\"\n}\n"},"url":"{{url}}/api/Login?format=json","description":"

Description:

The authentication will allow your server\\application to connect with Splitit services by session returned from the Login service.

Authentication should be done with API credentials (Username and Password) you must receive from your Splitit onboarding contact. If you are looking to get your credentials, please don't hesitate and shoot us an email at onboarding@splitit.com.

Please notice:

1) The credentials and the resulted session should be kept secured on your server and should never be exposed to client side.

2) Splitit session is valid for 20 min.

Request parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Default	Description
Username required	String		The username of your API user in Splitit system
Password required	String		The password of your API user in Splitit system

Response:

* for information about response header, please check response header description in introduction.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
SessionId	String	The response SessionId

","urlObject":{"path":["api","Login"],"host":["{{url}}"],"query":[{"key":"format","value":"json"}],"variable":[]}},"response":[{"id":"16883e2d-f34f-7eb5-9e0e-3baaea06e7d5","name":"Login - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","enabled":true,"description":"The mime type of this content"}],"body":{"mode":"raw","raw":"{ \n \"UserName\":\"{{UserName}}\",\n \"Password\":\"{{Password}}\"\n}\n"},"url":{"raw":"{{url}}/api/Login?format=json","host":["{{url}}"],"path":["api","Login"],"query":[{"key":"format","value":"json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"Content-Type","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, OPTIONS","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Content-Length","key":"Content-Length","value":"102","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json; charset=utf-8","description":""},{"name":"Date","key":"Date","value":"Wed, 07 Dec 2016 23:06:39 GMT","description":""},{"name":"Server","key":"Server","value":"","description":""},{"name":"X-ASPNET-VERSION","key":"X-ASPNET-VERSION","value":"","description":""},{"name":"X-MiniProfiler-Ids","key":"X-MiniProfiler-Ids","value":"[\"df7a40a4c1d64f0e99acca28ef7bf5a3\",\"8a65a2d6207e4b50bb457f9b3e287313\",\"50053e17668842068c95d2b534c0df69\",\"8bd67c08b5ca4a41a2fe3619b57b5c82\",\"85571fa98df340c5991ebc2fe7148cca\",\"65e6b68495d642b9a1f332656f1cfeff\",\"04bce61aa04840e3a241c5707e9a4e98\",\"9f7819b4d2344858ba76e3b9f4e05773\",\"b7252f7ae2774560b54aa21a658fa56d\",\"77275042448b425fb876fa77bd50cecb\",\"c038d75adb5440a3b940574e5487a90c\",\"fca21d3a70174ec8a292845a342ddbf5\",\"cc5467824b2045d6af3985140ae835d5\",\"e6fa23755d7343ff9770d31f51121e42\",\"eec577d62e1948bcb7e219fa86395280\",\"27730be823d14992860b945fa613a784\",\"021795eb555d44c28a00c22f35f96950\",\"5290d590a4054e60839e9f67938bf1db\",\"8e6f12e3992349c691aa4dc26155410b\",\"dbb533626d35434496bb3c499ce5bcd6\",\"cfcbea7049164cf88db92625df401093\",\"4fd38cb0d1b548f8b8c52300a07b53a7\",\"afdc3e53828b443fa926e406420fdaf6\",\"709e0bff9ff14bc7a6fe251ad33cc1c8\",\"6e99fd3cb5f34657a4e2474130841c2a\",\"38cc0d7716a1436d976ca3364dda1449\",\"e797842eafa34175bd63f43d90890f97\",\"b7fd517e0c5b4cec85d18c38ec160a59\",\"ce30e490c7854800b4b0655582580451\",\"4e1b10640c82448893eb12a23551621f\",\"e8914b0455cc4d038e95eb9c94845949\",\"4b7f8084da0c40bd9f14efa90d60f291\",\"a4b7279340bf4956ae27c03420fc1f92\",\"43fb0b13c25b4e219c8e6a1fa2fc046f\",\"5a0db666cb9b42668e12951e1b97c79c\",\"9615d8863882447aba512e0e4414bb28\",\"129f92c9cfd841aca38712a19ba86b11\",\"fa60b42defde48fca56ad160e05f7bda\",\"0b20b6b3229b48f3b84b66a0c8aa6540\",\"d88269dcd55545d2a3fe4d4743df346c\",\"e4b55862d37c4f039b503faca307b44b\",\"79bef5516daf47dcbe19841e0965c5de\",\"88b0ba47fc29463fb1424592394d9c72\",\"01cd357bc2844901bb2c0e3baea8fbc6\",\"68ce7aeb78b249ffbdd36a0eeaa3825a\"]","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"","description":""},{"name":"X-SourceFiles","key":"X-SourceFiles","value":"=?UTF-8?B?QzpcRGV2ZWxvcG1lbnRcU3BsaXRJdFxNYWluXFRydW5rXFNlcnZlclxTcmNcV2ViXFBJUy5XZWIuQVBJXGFwaVxMb2dpbg==?=","description":""}],"cookie":[],"responseTime":"286","body":"{\"ResponseHeader\":{\"Succeeded\":true,\"Errors\":null},\"SessionId\":\"70cb6c88-549a-486b-9f4f-6b6bafc9aa6f\"}"},{"id":"92c0e5d1-db34-123c-145f-11cfc57ee6e3","name":"Login - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","enabled":true,"description":"The mime type of this content"}],"body":{"mode":"raw","raw":"{ \n \"UserName\":\"{{UserName}}\",\n \"Password\":\"{{Password}}\"\n}\n"},"url":{"raw":"{{url}}/api/Login?format=json","host":["{{url}}"],"path":["api","Login"],"query":[{"key":"format","value":"json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"Access-Control-Allow-Headers","key":"Access-Control-Allow-Headers","value":"Content-Type","description":""},{"name":"Access-Control-Allow-Methods","key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, OPTIONS","description":""},{"name":"Access-Control-Allow-Origin","key":"Access-Control-Allow-Origin","value":"*","description":""},{"name":"Cache-Control","key":"Cache-Control","value":"private","description":""},{"name":"Content-Length","key":"Content-Length","value":"138","description":""},{"name":"Content-Type","key":"Content-Type","value":"application/json; charset=utf-8","description":""},{"name":"Date","key":"Date","value":"Wed, 07 Dec 2016 23:07:10 GMT","description":""},{"name":"Server","key":"Server","value":"","description":""},{"name":"X-ASPNET-VERSION","key":"X-ASPNET-VERSION","value":"","description":""},{"name":"X-MiniProfiler-Ids","key":"X-MiniProfiler-Ids","value":"[\"df7a40a4c1d64f0e99acca28ef7bf5a3\",\"8a65a2d6207e4b50bb457f9b3e287313\",\"50053e17668842068c95d2b534c0df69\",\"8bd67c08b5ca4a41a2fe3619b57b5c82\",\"85571fa98df340c5991ebc2fe7148cca\",\"65e6b68495d642b9a1f332656f1cfeff\",\"04bce61aa04840e3a241c5707e9a4e98\",\"9f7819b4d2344858ba76e3b9f4e05773\",\"b7252f7ae2774560b54aa21a658fa56d\",\"77275042448b425fb876fa77bd50cecb\",\"c038d75adb5440a3b940574e5487a90c\",\"fca21d3a70174ec8a292845a342ddbf5\",\"cc5467824b2045d6af3985140ae835d5\",\"e6fa23755d7343ff9770d31f51121e42\",\"eec577d62e1948bcb7e219fa86395280\",\"27730be823d14992860b945fa613a784\",\"021795eb555d44c28a00c22f35f96950\",\"5290d590a4054e60839e9f67938bf1db\",\"8e6f12e3992349c691aa4dc26155410b\",\"dbb533626d35434496bb3c499ce5bcd6\",\"cfcbea7049164cf88db92625df401093\",\"4fd38cb0d1b548f8b8c52300a07b53a7\",\"afdc3e53828b443fa926e406420fdaf6\",\"709e0bff9ff14bc7a6fe251ad33cc1c8\",\"6e99fd3cb5f34657a4e2474130841c2a\",\"38cc0d7716a1436d976ca3364dda1449\",\"e797842eafa34175bd63f43d90890f97\",\"b7fd517e0c5b4cec85d18c38ec160a59\",\"ce30e490c7854800b4b0655582580451\",\"4e1b10640c82448893eb12a23551621f\",\"e8914b0455cc4d038e95eb9c94845949\",\"4b7f8084da0c40bd9f14efa90d60f291\",\"a4b7279340bf4956ae27c03420fc1f92\",\"43fb0b13c25b4e219c8e6a1fa2fc046f\",\"5a0db666cb9b42668e12951e1b97c79c\",\"9615d8863882447aba512e0e4414bb28\",\"129f92c9cfd841aca38712a19ba86b11\",\"fa60b42defde48fca56ad160e05f7bda\",\"0b20b6b3229b48f3b84b66a0c8aa6540\",\"d88269dcd55545d2a3fe4d4743df346c\",\"e4b55862d37c4f039b503faca307b44b\",\"79bef5516daf47dcbe19841e0965c5de\",\"88b0ba47fc29463fb1424592394d9c72\",\"01cd357bc2844901bb2c0e3baea8fbc6\",\"68ce7aeb78b249ffbdd36a0eeaa3825a\",\"7edf312515de4bbe8d1b802fcbe606be\"]","description":""},{"name":"X-Powered-By","key":"X-Powered-By","value":"","description":""},{"name":"X-SourceFiles","key":"X-SourceFiles","value":"=?UTF-8?B?QzpcRGV2ZWxvcG1lbnRcU3BsaXRJdFxNYWluXFRydW5rXFNlcnZlclxTcmNcV2ViXFBJUy5XZWIuQVBJXGFwaVxMb2dpbg==?=","description":""}],"cookie":[],"responseTime":"241","body":"{\"ResponseHeader\":{\"Succeeded\":false,\"Errors\":[{\"ErrorCode\":\"700\",\"Message\":\"Invalid credentials\",\"AdditionalInfo\":\"\"}]},\"SessionId\":null}"}],"_postman_id":"b152da1d-39f1-a67e-935e-d80bd97c2f4f"},{"name":"2. Initiate","event":[{"listen":"test","script":{"type":"text/javascript","exec":["var data = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"InstallmentPlanNumber\", data.InstallmentPlan.InstallmentPlanNumber);",""]}}],"id":"0b657e82-6451-bce4-f73e-2aaa7c0561d4","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"RequestHeader\": {\r\n \"SessionId\": \"{{SessionId}}\",\r\n \"ApiKey\": \"{{ApiKey}}\"\r\n },\r\n \"PlanData\": {\r\n \"Amount\": {\"Value\": 50,\"CurrencyCode\": \"USD\"},\r\n \"NumberOfInstallments\": 3, \r\n \"RefOrderNumber\": \"012AB\",\r\n \"AutoCapture\": true,\r\n \"ExtendedParams\": {\r\n \"AnyParameterKey1\": \"AnyParameterVal1\",\r\n \"AnyParameterKey2\": \"AnyParameterVal2\"\r\n }\r\n },\r\n \"BillingAddress\": {\r\n \"AddressLine\": \"260 Madison Avenue.\",\r\n \"AddressLine2\": \"Appartment 1\",\r\n \"City\": \"New York\",\r\n \"State\": \"NY\",\r\n \"Country\": \"USA\",\r\n \"Zip\": \"10016\"\r\n },\r\n \"ConsumerData\": {\r\n \"FullName\": \"John Smith\",\r\n \"Email\": \"JohnS@splitit.com\",\r\n \"PhoneNumber\": \"1-844-775-4848\",\r\n \"CultureName\": \"en-us\"\r\n },\r\n \"PaymentWizardData\": {\r\n \"RequestedNumberOfInstallments\": \"2,3,4\"\r\n },\r\n \"RedirectUrls\": {\r\n \"Succeeded\": \"https://www.success.com/\",\r\n \"Failed\": \"https://www.failed.com/\",\r\n \"Canceled\": \"https://www.canceled.com/\"\r\n },\r\n \"EventsEndpoints\": {\r\n \"CreateSucceeded\": \"https://www.async-success.com/\"\r\n }\r\n}"},"url":"{{url}}/api/InstallmentPlan/Initiate?format=json","description":"

Description:

The initiate service allows your server\\application to start transaction with Splitit.

Common use case for running Initiate request is to open Splitit payment wizard (see hosted payment solution) from merchant checkout - in that case, the initiate should be called with all available data related to the order (ex: Order number, Amount) , shopper information (name, email, billing address) and Exit URLs (Success\\Cancel\\Error) that will redirect the wizard back to the merchant checkout for each state.

As part of a success response, you will get a checkout URL which will open Splitit payment wizard where shopper will enter credit card details and complete the order.

Initiate can be called single time or many times, each time with additional data, so if your checkout contains few sections\\pages you may call Initate each section and get Splitit validations response immediately.

Request parameters :

* For information about request header that need to be sent as part of every transaction, please check request header description in introduction.

Plan Data

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

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

Consumer Data

* Consume data element is not mandatory as part of the initiate service, If consumer data is not supplied as part of initiate service, it will need to be added later (manually by shopper in payment wizard or by API create service).

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Default	Description
FullName required	String		Shopper full name
\n Email \n required \n	String		Shopper email
\n PhoneNumber \n	String		\n Shopper number \n
\n CultureName \n	String	\n en-us \n	\n Shopper culture \n Notice - All Splitit interactions with shopper (payment wizard language, emails, shopper portal) will be affected from this choice. shopper will be able to change this option from shopper portal. \n Contact splitit support for complete list of supported cultures \n

Billing Address

* Billing address element is not mandatory as part of the initiate service, If billing address not supplied in initiate and is required as part of merchant policy, billing address will need to be added later (manually by shopper in payment wizard or by API create service).

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Default	Description
AddressLine required	String		\n Street, Number. (free text) \n
AddressLine2	String		\n Apartment, Suit etc (free text) \n
\n City \n required \n	String		\n City name (free text) \n
\n State \n required \n	String	\n \n	\n Can be one of the following options: \n \n ISO 3166-2 codes of each state (Example: \"NY\") \n English short state name officially used by the ISO 3166 (Example: \"New York\") \n \n
\n Country \n required \n	String		\n Can be one of the following options: \n \n ISO 3166-1 alpha-2 code (Example: \"US\") \n ISO 3166-1 alpha-3 (Example: \"USA\") \n English short country name officially used by the ISO 3166 \n \n
\n Zip \n required \n	String		\n Zip code \n

Payment Wizard Data

* Payment wizard data is only required when working in hosted payment solution in order to indicate some parameters related to the payment wizard

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Default	Description
RequestedNumberOfInstallments	String		\n Comma separated string contains all options to display to shopper in payment wizard, if not supplied will display default configuration on merchant from terminal. \n

RedirectUrls

* Redirect URLs are only required when working with hosted payment solution or with 3D secure mode

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
Succeeded	String	\n Relevant both when working with payment form or 3D secure \n The URL shopper will be redirected from payment wizard or 3d secure redirection when order is completed successfully \n
\n Canceled \n	String	\n Relevant only when working with payment form \n The URL shopper will be redirected from payment wizard when shopper clicks cancel on payment wizard \n \n
\n Failed \n	String	\n Relevant only when working with 3d secure \n The URL shopper will be redirected from 3d secure when 3d secured declines the transaction \n \n

Parameter

Type

Default

Description

Succeeded

String

Relevant both when working with payment form or 3D secure

The URL shopper will be redirected from payment wizard or 3d secure redirection when order is completed successfully

Canceled

String

Relevant only when working with payment form

The URL shopper will be redirected from payment wizard when shopper clicks cancel on payment wizard

Failed

String

Relevant only when working with 3d secure

The URL shopper will be redirected from 3d secure when 3d secured declines the transaction

EventsEndpoints

Used to notify about events that happen during the lifetime of installment plan. Currently only registration to CreateSucceeded event is supported by API , for full list of optional events , please refer to webhooks documentation

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Default	Description
CreateSucceeded	String		\n URL that will be called from Splitit server after transaction is created on Splitit, This URL will be called asynchronous to make sure the caller got notified that the plan was created successfully and finalize the order. This URL will also be concatenated with unique installment plan number parameter and the order reference number sent originally in the initiate request. \n example: \n [CreateSucceededURL] \n &RefOrderNumber=a123 \n &InstallmentPlanNumber=013434). \n This URL will be called each hour for 24 hours until http response 200 will be returned from caller \n

Parameter

Type

Default

Description

CreateSucceeded

String

URL that will be called from Splitit server after transaction is created on Splitit, This URL will be called asynchronous to make sure the caller got notified that the plan was created successfully and finalize the order. This URL will also be concatenated with unique installment plan number parameter and the order reference number sent originally in the initiate request.

example:

[CreateSucceededURL]

&RefOrderNumber=a123

&InstallmentPlanNumber=013434).

This URL will be called each hour for 24 hours until http response 200 will be returned from caller

Response:

* For important information about checking the response validity in response header, please check response header description in introduction.

* Please notice that only small part of the response is described below, for full API description, please refer to the following documentation

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
CheckoutUrl	String	URL that opens Splitit wizard that enables complete the order payment by shopper
PublicToken	String	Token that can be used as a session to additional limited API services (Create\\Approve\\Get) for the specific installment plan
\n InstallmentPlanNumber \n (Part of InstallmentPlan entity) \n	String	Unique installment plan number that identify this transaction.

Parameter

Type

Description

CheckoutUrl

String

URL that opens Splitit wizard that enables complete the order payment by shopper

PublicToken

String

Token that can be used as a session to additional limited API services (Create\\Approve\\Get) for the specific installment plan

InstallmentPlanNumber

(Part of InstallmentPlan entity)

String

Unique installment plan number that identify this transaction.

","urlObject":{"path":["api","InstallmentPlan","Initiate"],"host":["{{url}}"],"query":[{"key":"format","value":"json"}],"variable":[]}},"response":[{"id":"d6f5682d-6fce-2297-2f89-727930e42e80","name":"Initiate-Example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"RequestHeader\": {\r\n \"SessionId\": \"{{SessionId}}\",\r\n \"ApiKey\": \"{{ApiKey}}\"\r\n },\r\n \"PlanData\": {\r\n \"Amount\": {\r\n \"Value\": 50,\r\n \"CurrencyCode\": \"USD\"\r\n },\r\n \"RefOrderNumber\": \"012AB\",\r\n \"AutoCapture\": true,\r\n \"ExtendedParams\": {\r\n \"AnyParameterKey1\": \"AnyParameterVal1\",\r\n \"AnyParameterKey2\": \"AnyParameterVal2\"\r\n }\r\n },\r\n \"BillingAddress\": {\r\n \"AddressLine\": \"260 Madison Avenue.\",\r\n \"AddressLine2\": \"Appartment 1\",\r\n \"City\": \"New York\",\r\n \"State\": \"NY\",\r\n \"Country\": \"USA\",\r\n \"Zip\": \"10016\"\r\n },\r\n \"ConsumerData\": {\r\n \"FullName\": \"John Smith\",\r\n \"Email\": \"JohnS@splitit.com\",\r\n \"PhoneNumber\": \"1-844-775-4848\",\r\n \"CultureName\": \"en-us\"\r\n },\r\n \"PaymentWizardData\": {\r\n \"RequestedNumberOfInstallments\": \"2,3,4\"\r\n },\r\n \"RedirectUrls\": {\r\n \"Succeeded\": \"https://www.success.com/\",\r\n \"Failed\": \"https://www.failed.com/\",\r\n \"Canceled\": \"https://www.canceled.com/\"\r\n },\r\n \"EventsEndpoints\": {\r\n \"CreateSucceeded\": \"https://www.async-success.com/\"\r\n }\r\n}"},"url":{"raw":"{{url}}/api/InstallmentPlan/Initiate?format=json","host":["{{url}}"],"path":["api","InstallmentPlan","Initiate"],"query":[{"key":"format","value":"json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Content-Type","name":"Access-Control-Allow-Headers","description":""},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, OPTIONS","name":"Access-Control-Allow-Methods","description":""},{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":""},{"key":"Cache-Control","value":"private","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Length","value":"1944","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Wed, 30 May 2018 15:48:05 GMT","name":"Date","description":""},{"key":"Server","value":"","name":"Server","description":""},{"key":"X-AspNet-Version","value":"","name":"X-AspNet-Version","description":""},{"key":"X-AspNetMvc-Version","value":"X-AspNet-Version:","name":"X-AspNetMvc-Version","description":""},{"key":"X-Powered-By","value":"","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":"423","body":"{\"CheckoutUrl\":\"https://checkout.splitit.com/CheckoutPaymentDetails.html?token=f72e7728-36d7-46df-b585-ad903315c933&culture=en-US\",\"ApprovalUrl\":\"\",\"TermsAndConditionsUrl\":\"https://www.splitit.com/legal/customers-terms-and-conditions/\",\"InstallmentPlanInfoUrl\":\"https://admin1.splitit.com/en-US/InstallmentPlan/ShowAgreement/?PublicToken=f72e7728-36d7-46df-b585-ad903315c933\",\"PublicToken\":\"f72e7728-36d7-46df-b585-ad903315c933\",\"ResponseHeader\":{\"Succeeded\":true,\"Errors\":[]},\"InstallmentPlan\":{\"InstallmentPlanNumber\":\"77377762524182382687\",\"InstallmentPlanStatus\":{\"Id\":11,\"Code\":\"Initializing\",\"Description\":\"Initializing\"},\"Amount\":{\"Value\":50,\"Currency\":{\"Symbol\":\"US$\",\"Id\":1,\"Code\":\"USD\",\"Description\":\"US Dollar\"}},\"OutstandingAmount\":{\"Value\":50,\"Currency\":{\"Symbol\":\"US$\",\"Id\":1,\"Code\":\"USD\",\"Description\":\"US Dollar\"}},\"NumberOfInstallments\":0,\"NumberOfProcessedInstallments\":0,\"OriginalAmount\":{\"Value\":50,\"Currency\":{\"Symbol\":\"US$\",\"Id\":1,\"Code\":\"USD\",\"Description\":\"US Dollar\"}},\"RefundAmount\":{\"Value\":0,\"Currency\":{\"Symbol\":\"US$\",\"Id\":1,\"Code\":\"USD\",\"Description\":\"US Dollar\"}},\"Consumer\":{\"Id\":\"0\",\"UserName\":\"JohnS\",\"FullName\":\"John Smith\",\"Email\":\"JohnS@splitit.com\",\"PhoneNumber\":\"1-844-775-4848\",\"CultureName\":\"en-US\",\"RoleName\":null,\"IsLocked\":false},\"ActiveCard\":null,\"Terminal\":{\"Id\":167,\"Code\":\"9798ihk\",\"Description\":\"ALL Countries\"},\"Merchant\":{\"Id\":2,\"Code\":\"testmerchantaccount\",\"Description\":\"TEST MERCHANT ACCOUNT \"},\"RefOrderNumber\":\"012AB\",\"PurchaseMethod\":{\"Id\":3,\"Code\":\"ECommerce\",\"Description\":\"E-Commerce\"},\"Strategy\":{\"Id\":1,\"Code\":\"SecuredPlan\",\"Description\":\"Secured\"},\"DelayResolution\":null,\"ExtendedParams\":{\"AnyParameterKey1\":\"AnyParameterVal1\",\"AnyParameterKey2\":\"AnyParameterVal2\"},\"IsFullCaptured\":false,\"IsChargedBack\":false,\"ArePaymentsOnHold\":false,\"ScpFundingPercent\":0,\"TestMode\":\"None\",\"CreationDateTime\":\"2018-05-30T15:48:05.8486996+00:00\",\"Installments\":null,\"SecureAuthorizations\":null}}"}],"_postman_id":"0b657e82-6451-bce4-f73e-2aaa7c0561d4"},{"name":"3. Create","event":[{"listen":"test","script":{"type":"text/javascript","exec":["var data = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"InstallmentPlanNumber\", data.InstallmentPlan.InstallmentPlanNumber);",""]}}],"id":"337b85e4-7608-fa6c-03ff-d2c872d30f2a","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"RequestHeader\": {\r\n \"SessionId\": \"{{SessionId}}\",\r\n \"ApiKey\": \"{{ApiKey}}\"\r\n },\r\n \"PlanData\": {\r\n \"Amount\": {\"Value\": 55, \"CurrencyCode\":\"USD\"},\r\n \"NumberOfInstallments\": 3,\r\n \"RefOrderNumber\": \"XYZ\",\r\n \"AutoCapture\": true\r\n },\r\n \"BillingAddress\": {\r\n \"AddressLine\": \"260 Madison Avenue.\",\r\n \"AddressLine2\": \"Appartment 1\",\r\n \"City\": \"New York\",\r\n \"State\": \"NY\",\r\n \"Country\": \"USA\",\r\n \"Zip\": \"10016\"\r\n },\r\n \"ConsumerData\": {\r\n \"FullName\": \"John Smith\",\r\n \"Email\": \"JohnS@splitit.com\",\r\n \"PhoneNumber\": \"1-844-775-4848\",\r\n \"CultureName\": \"en-us\"\r\n },\r\n \"CreditCardDetails\": { \r\n \"CardCvv\": \"123\", \r\n \"CardHolderFullName\": \"John Smith\",\r\n \"CardNumber\": \"4111111111111111\", \r\n \"CardExpYear\": \"2019\", \r\n \"CardExpMonth\": \"8\"\r\n } ,\r\n \"PlanApprovalEvidence\": {\r\n \"AreTermsAndConditionsApproved\": \"True\"\r\n }\r\n}"},"url":"{{url}}/api/InstallmentPlan/Create?format=json","description":"

Description:

The create service allows your server\\application complete transaction with Splitit.

Common use case for running create request is for integrations where all interactions with shopper (including taking payment details) are done on merchant\\integrator side. Although the create can be called independently with all required data to start and complete transaction (ex: Order number, Amount) , shopper information (name, email, billing address) and payment details, it is usually called after plan was initiated (see initiate call) and only add the credit card detail and approval evidence required to complete the payment , Please read more about this from our documentation.

The create service validates that all required data exist and valid and call the merchant's gateway to try and authorize the plan. in case of failure while trying to create an order (ex: Missing email, invalid expiration date, card declined by processor), clear error message will be retrieved as part of the response, this error should be displayed to the user that tries to complete the order so he will be able to complete\\fix the required data.

Request parameters :

* For information about request header that need to be sent as part of every transaction, please check request header description in introduction.

Plan Data

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Default	Description
Amount required	Amount		\n The order total amount, includes: \n Value (decimal). Example - 305.50 \n CurrencyCode (string) - should be in a format of ISO 4217 currency. Example - USD \n
PurchaseMethod	String	ECommerce	\n The method the purchase is done, Choose one of the following: \n \n InStore – physical store purchase \n PhoneOrder – phone order \n Ecommerce – purchase on Ecommerce site \n \n
RefOrderNumber	String		\n Reference merchant order number. \n
AutoCapture	Boolean	\n Default* \n	\n Indicates if to capture the first installment automatically when creating the plan or to wait for explicit indication to do the first capture. \n * The default behavior is defined in your merchant account at Splitit. \n
FirstInstallmentAmount	Amount		\n The first installment amount. \n Should be populated only if first installment amount is different from the following installments amounts (ex: includes shipping amount as part of the first installment). \n
FirstChargeDate	Date		\n The first installment date. \n Should be populated only if first installment date is not scheduled to the plan creation date. \n
ExtendedParams	ExtendedParams		\n Any merchant parameter he would like to capture on the plan (ex: secondary order number). those parameters can later be queried. \n Example: \n \"ExtendedParams\": { \"AnyParameterKey1\": \" AnyParameterVal1\", \"AnyParameterKey2\": \" AnyParameterVal2\" } \n

Consumer Data

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Default	Description
FullName required	String		Shopper full name
\n Email \n required \n	String		Shopper email
\n PhoneNumber \n	String		\n Shopper number \n
\n CultureName \n	String	\n en-us \n	\n Shopper culture \n Notice - All Splitit interactions with shopper (payment wizard language, emails, shopper portal) will be affected from this choice. shopper will be able to change this option from shopper portal. \n Please contact Splitit support for complete list of supported cultures \n

Billing Address

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Default	Description
AddressLine required	String		\n Street, Number. (free text) \n
AddressLine2	String		\n Apartment, Suit etc (free text) \n
\n City \n required \n	String		\n City name (free text) \n
\n State \n required \n	String	\n \n	\n Can be one of the following options: \n \n ISO 3166-2 codes of each state (Example: \"NY\") \n English short state name officially used by the ISO 3166 (Example: \"New York\") \n \n
\n Country \n required \n	String		\n Can be one of the following options: \n \n ISO 3166-1 alpha-2 code (Example: \"US\") \n ISO 3166-1 alpha-3 (Example: \"USA\") \n English short country name officially used by the ISO 3166 \n \n
\n Zip \n required \n	String		\n Zip code \n

Credit Card Details

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
\n CardNumber \n required \n	String	\n Valid credit card number \n Example:4111111111111111 \n
\n CardCvv \n required \n	String	\n Valid card security code \n Example:123 \n
\n CardExpYear \n required \n	String	\n Valid card expiration year \n Example:2019 \n
\n CardExpMonth \n required \n	String	\n Valid card expiration month \n Example: 08 or 8 \n
\n CardHolderFullName \n required \n	String	\n Card holder full name \n

Payment Token

Payment token allows running new transactions for credit card that was already used with Splitit. The token represents Credit card details and Consumer data that was previously returned from Splitit server as a response to Create installment plan transaction (see documentation of CardData.Token in entities documentation).

Sending payment token element replace the need to keep and send Credit card details , Consumer data and Billing Address on merchant side for new transactions of the same card .

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
\n Token \n required \n	String	\n Token returned from previous transaction from Splitit server \n Example:56b0096f-59ee-48dc-a7d8-321ad0abf60a \n
\n Type \n required \n	String	\n The token type - \n For Splitit Token send \"SplititStoredCard\" \n

Parameter

Type

Default

Description

Token

required

String

Token returned from previous transaction from Splitit server

Example:56b0096f-59ee-48dc-a7d8-321ad0abf60a

Type

required

String

The token type -

For Splitit Token send \"SplititStoredCard\"

Plan Approval Evidence

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Default	Description
\n AreTermsAndConditionsApproved \n required \n	Boolean	False	\n Splitit requires integrations to display terms and conditions and get shopper approval before first installment is charged. True indication on this field , indicates, shopper has approved the terms and conditions \n

Parameter

Type

Default

Description

AreTermsAndConditionsApproved

required

Boolean

False

Splitit requires integrations to display terms and conditions and get shopper approval before first installment is charged. True indication on this field , indicates, shopper has approved the terms and conditions

Response:

* For important information about checking the response validity in response header, please check response header description in introduction.

* Please notice that only small part of the response is described below, for full API description, please refer to the following documentation

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
ApprovalUrl	String	URL that opens Splitit approval page
PublicToken	String	Token that can be used as a session to additional limited API services (Create\\Approve\\Get) for the specific installment plan
\n InstallmentPlanNumber \n (Part of InstallmentPlan entity) \n	String	Unique installment plan number that identify this transaction.

Parameter

Type

Description

ApprovalUrl

String

URL that opens Splitit approval page

PublicToken

String

Token that can be used as a session to additional limited API services (Create\\Approve\\Get) for the specific installment plan

InstallmentPlanNumber

(Part of InstallmentPlan entity)

String

Unique installment plan number that identify this transaction.

","urlObject":{"path":["api","InstallmentPlan","Create"],"host":["{{url}}"],"query":[{"key":"format","value":"json"}],"variable":[]}},"response":[{"id":"b3c00245-97b3-b4f7-5d2d-abe65d25af16","name":"Example - 2","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","disabled":false}],"body":{"mode":"raw","raw":"{\r\n \"RequestHeader\": {\r\n \"SessionId\": \"{{SessionId}}\",\r\n \"ApiKey\": \"{{ApiKey}}\"\r\n },\r\n \"PlanData\": {\r\n \"Amount\": {\"Value\": 55, \"CurrencyCode\":\"USD\"},\r\n \"NumberOfInstallments\": 3,\r\n \"RefOrderNumber\": \"XYZ\",\r\n \"AutoCapture\": true\r\n },\r\n \"BillingAddress\": {\r\n \"AddressLine\": \"260 Madison Avenue.\",\r\n \"AddressLine2\": \"Appartment 1\",\r\n \"City\": \"New York\",\r\n \"State\": \"NY\",\r\n \"Country\": \"USA\",\r\n \"Zip\": \"10016\"\r\n },\r\n \"ConsumerData\": {\r\n \"FullName\": \"John Smith\",\r\n \"Email\": \"JohnS@splitit.com\",\r\n \"PhoneNumber\": \"1-844-775-4848\",\r\n \"CultureName\": \"en-us\"\r\n },\r\n \"CreditCardDetails\": { \r\n \"CardCvv\": \"123\", \r\n \"CardHolderFullName\": \"John Smith\",\r\n \"CardNumber\": \"4111111111111111\", \r\n \"CardExpYear\": \"2019\", \r\n \"CardExpMonth\": \"8\"\r\n } \r\n}"},"url":{"raw":"{{url}}/api/InstallmentPlan/Create?format=json","host":["{{url}}"],"path":["api","InstallmentPlan","Create"],"query":[{"key":"format","value":"json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Content-Type","name":"Access-Control-Allow-Headers","description":""},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, OPTIONS","name":"Access-Control-Allow-Methods","description":""},{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":""},{"key":"Cache-Control","value":"private","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Length","value":"5899","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Thu, 31 May 2018 13:00:47 GMT","name":"Date","description":""},{"key":"Server","value":"","name":"Server","description":""},{"key":"X-AspNet-Version","value":"","name":"X-AspNet-Version","description":""},{"key":"X-AspNetMvc-Version","value":"X-AspNet-Version:","name":"X-AspNetMvc-Version","description":""},{"key":"X-Powered-By","value":"","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":"3219","body":"{\"ApprovalUrl\":\"https://admin1-dev.splitit.com//en-US/InstallmentPlan/ShowAgreement/?PublicToken=7c8805c1-c67f-430f-b68e-2c2e664b1372\",\"ResponseHeader\":{\"Succeeded\":true,\"Errors\":[]},\"InstallmentPlan\":{\"InstallmentPlanNumber\":\"06725171348452683753\",\"InstallmentPlanStatus\":{\"Id\":1,\"Code\":\"PendingApproval\",\"Description\":\"Pending Approval\"},\"Amount\":{\"Value\":55,\"Currency\":{\"Symbol\":\"US$\",\"Id\":1,\"Code\":\"USD\",\"Description\":\"US Dollar\"}},\"OutstandingAmount\":{\"Value\":55,\"Currency\":{\"Symbol\":\"US$\",\"Id\":1,\"Code\":\"USD\",\"Description\":\"US Dollar\"}},\"NumberOfInstallments\":3,\"NumberOfProcessedInstallments\":0,\"OriginalAmount\":{\"Value\":55,\"Currency\":{\"Symbol\":\"US$\",\"Id\":1,\"Code\":\"USD\",\"Description\":\"US Dollar\"}},\"RefundAmount\":{\"Value\":0,\"Currency\":{\"Symbol\":\"US$\",\"Id\":1,\"Code\":\"USD\",\"Description\":\"US Dollar\"}},\"Consumer\":{\"Id\":\"0\",\"UserName\":\"JohnS\",\"FullName\":\"John Smith\",\"Email\":\"JohnS@splitit.com\",\"PhoneNumber\":\"1-844-775-4848\",\"CultureName\":\"en-US\",\"RoleName\":null,\"IsLocked\":false},\"ActiveCard\":{\"CardId\":null,\"CardNumber\":\"**** **** **** 1111\",\"CardExpMonth\":\"8\",\"CardExpYear\":\"2019\",\"CardBrand\":{\"Id\":2,\"Code\":\"Visa\",\"Description\":\"VISA\"},\"CardType\":{\"Id\":1,\"Code\":\"Credit\",\"Description\":\"CREDIT\"},\"Bin\":\"411111\",\"CardHolderFullName\":\"John Smith\",\"CardCvv\":\"[Filtered]\",\"Address\":{\"AddressLine\":\"260 Madison Avenue.\",\"AddressLine2\":\"Appartment 1\",\"City\":\"New York\",\"Country\":\"US\",\"State\":\"NY\",\"Zip\":\"10016\",\"FullAddressLine\":\"260 Madison Avenue.,Appartment 1,New York,NY,US\"}},\"Terminal\":{\"Id\":10087,\"Code\":\"WebApiTestChargeAfterTerminal\",\"Description\":\"WebApiTestTerminal\"},\"Merchant\":{\"Id\":10024,\"Code\":\"webapitest\",\"Description\":\"WebApiTest\"},\"RefOrderNumber\":\"XYZ\",\"PurchaseMethod\":{\"Id\":3,\"Code\":\"ECommerce\",\"Description\":\"E-Commerce\"},\"Strategy\":{\"Id\":1,\"Code\":\"SecuredPlan\",\"Description\":\"Secured\"},\"DelayResolution\":null,\"ExtendedParams\":{},\"IsFullCaptured\":false,\"IsChargedBack\":false,\"ArePaymentsOnHold\":false,\"ScpFundingPercent\":0,\"TestMode\":\"None\",\"CreationDateTime\":\"2018-05-31T13:00:44.6134432+00:00\",\"Installments\":[{\"InstallmentNumber\":1,\"Amount\":{\"Value\":18.33,\"Currency\":{\"Symbol\":\"US$\",\"Id\":1,\"Code\":\"USD\",\"Description\":\"US Dollar\"}},\"OriginalAmount\":{\"Value\":18.33,\"Currency\":{\"Symbol\":\"US$\",\"Id\":1,\"Code\":\"USD\",\"Description\":\"US Dollar\"}},\"RefundAmount\":{\"Value\":0,\"Currency\":{\"Symbol\":\"US$\",\"Id\":1,\"Code\":\"USD\",\"Description\":\"US Dollar\"}},\"ProcessDateTime\":\"2018-05-31T13:00:45.6429640Z\",\"IsRefund\":false,\"RequiredCredit\":{\"Value\":55.00,\"Currency\":{\"Symbol\":\"US$\",\"Id\":1,\"Code\":\"USD\",\"Description\":\"US Dollar\"}},\"CreatedDateTime\":\"2018-05-31T13:00:45.6429640Z\",\"Status\":{\"Id\":2,\"Code\":\"WaitingForProcessDate\",\"Description\":\"Waiting for process date\"},\"TransactionResults\":[{\"GatewayTransactionId\":\"eef6f9f6-ffac-4941-a1ea-3811a7ac4741\",\"GatewayResultCode\":\"1\",\"GatewayResultMessage\":\"Authorize Succeeded\",\"OperationType\":{\"Id\":1,\"Code\":\"Authorize\",\"Description\":\"Approved\"},\"GatewayResult\":true,\"GatewayTransactionDate\":\"2018-05-31T13:00:46.6880836+00:00\"}],\"CardDetails\":{\"CardId\":null,\"CardNumber\":\"**** **** **** 1111\",\"CardExpMonth\":\"8\",\"CardExpYear\":\"2019\",\"CardBrand\":{\"Id\":2,\"Code\":\"Visa\",\"Description\":\"VISA\"},\"CardType\":{\"Id\":1,\"Code\":\"Credit\",\"Description\":\"CREDIT\"},\"Bin\":\"411111\",\"CardHolderFullName\":\"John Smith\",\"CardCvv\":\"[Filtered]\",\"Address\":{\"AddressLine\":\"260 Madison Avenue.\",\"AddressLine2\":\"Appartment 1\",\"City\":\"New York\",\"Country\":\"US\",\"State\":\"NY\",\"Zip\":\"10016\",\"FullAddressLine\":\"260 Madison Avenue.,Appartment 1,New York,NY,US\"}},\"Result\":true},{\"InstallmentNumber\":2,\"Amount\":{\"Value\":18.33,\"Currency\":{\"Symbol\":\"US$\",\"Id\":1,\"Code\":\"USD\",\"Description\":\"US Dollar\"}},\"OriginalAmount\":{\"Value\":18.33,\"Currency\":{\"Symbol\":\"US$\",\"Id\":1,\"Code\":\"USD\",\"Description\":\"US Dollar\"}},\"RefundAmount\":{\"Value\":0,\"Currency\":{\"Symbol\":\"US$\",\"Id\":1,\"Code\":\"USD\",\"Description\":\"US Dollar\"}},\"ProcessDateTime\":\"2018-06-30T13:00:45.6429640Z\",\"IsRefund\":false,\"RequiredCredit\":{\"Value\":36.67,\"Currency\":{\"Symbol\":\"US$\",\"Id\":1,\"Code\":\"USD\",\"Description\":\"US Dollar\"}},\"CreatedDateTime\":\"2018-05-31T13:00:45.6429640Z\",\"Status\":{\"Id\":2,\"Code\":\"WaitingForProcessDate\",\"Description\":\"Waiting for process date\"},\"TransactionResults\":[],\"CardDetails\":null,\"Result\":null},{\"InstallmentNumber\":3,\"Amount\":{\"Value\":18.34,\"Currency\":{\"Symbol\":\"US$\",\"Id\":1,\"Code\":\"USD\",\"Description\":\"US Dollar\"}},\"OriginalAmount\":{\"Value\":18.34,\"Currency\":{\"Symbol\":\"US$\",\"Id\":1,\"Code\":\"USD\",\"Description\":\"US Dollar\"}},\"RefundAmount\":{\"Value\":0,\"Currency\":{\"Symbol\":\"US$\",\"Id\":1,\"Code\":\"USD\",\"Description\":\"US Dollar\"}},\"ProcessDateTime\":\"2018-07-31T13:00:45.6429640Z\",\"IsRefund\":false,\"RequiredCredit\":{\"Value\":18.34,\"Currency\":{\"Symbol\":\"US$\",\"Id\":1,\"Code\":\"USD\",\"Description\":\"US Dollar\"}},\"CreatedDateTime\":\"2018-05-31T13:00:45.6429640Z\",\"Status\":{\"Id\":2,\"Code\":\"WaitingForProcessDate\",\"Description\":\"Waiting for process date\"},\"TransactionResults\":[],\"CardDetails\":null,\"Result\":null}],\"SecureAuthorizations\":[{\"ProcessingDate\":\"2018-05-31T13:00:46.1889220+00:00\",\"Amount\":{\"Value\":36.67,\"Currency\":{\"Symbol\":\"US$\",\"Id\":1,\"Code\":\"USD\",\"Description\":\"US Dollar\"}},\"TransactionResults\":[{\"GatewayTransactionId\":\"3d21b337-88dd-49c2-8368-3612fa121bd5\",\"GatewayResultCode\":\"1\",\"GatewayResultMessage\":\"Authorize Succeeded\",\"OperationType\":{\"Id\":1,\"Code\":\"Authorize\",\"Description\":\"Approved\"},\"GatewayResult\":true,\"GatewayTransactionDate\":\"2018-05-31T13:00:46.1421256+00:00\"}],\"CardDetails\":{\"CardId\":null,\"CardNumber\":\"**** **** **** 1111\",\"CardExpMonth\":\"8\",\"CardExpYear\":\"2019\",\"CardBrand\":{\"Id\":2,\"Code\":\"Visa\",\"Description\":\"VISA\"},\"CardType\":{\"Id\":1,\"Code\":\"Credit\",\"Description\":\"CREDIT\"},\"Bin\":\"411111\",\"CardHolderFullName\":\"John Smith\",\"CardCvv\":\"[Filtered]\",\"Address\":{\"AddressLine\":\"260 Madison Avenue.\",\"AddressLine2\":\"Appartment 1\",\"City\":\"New York\",\"Country\":\"US\",\"State\":\"NY\",\"Zip\":\"10016\",\"FullAddressLine\":\"260 Madison Avenue.,Appartment 1,New York,NY,US\"}},\"Result\":true}]}}"},{"id":"d0a21abd-7fe7-b47b-90c7-96da6c358050","name":"Example - 1","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","disabled":false}],"body":{"mode":"raw","raw":"{\r\n \"RequestHeader\": {\r\n \"SessionId\": \"{{SessionId}}\",\r\n \"ApiKey\": \"{{ApiKey}}\"\r\n },\r\n \"InstallmentPlanNumber\": \"{{InstallmentPlanNumber}}\",\r\n \"CreditCardDetails\": { \r\n \"CardCvv\": \"123\", \r\n \"CardHolderFullName\": \"John Smith\",\r\n \"CardNumber\": \"4111111111111111\", \r\n \"CardExpYear\": \"2019\", \r\n \"CardExpMonth\": \"8\"\r\n },\r\n \"PlanApprovalEvidence\": {\r\n \"AreTermsAndConditionsApproved\": \"True\"\r\n }\r\n}"},"url":{"raw":"{{url}}/api/InstallmentPlan/Create?format=json","host":["{{url}}"],"path":["api","InstallmentPlan","Create"],"query":[{"key":"format","value":"json"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Content-Type","name":"Access-Control-Allow-Headers","description":""},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, DELETE, OPTIONS","name":"Access-Control-Allow-Methods","description":""},{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":""},{"key":"Cache-Control","value":"private","name":"Cache-Control","description":""},{"key":"Connection","value":"keep-alive","name":"Connection","description":""},{"key":"Content-Length","value":"6115","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Thu, 31 May 2018 12:59:26 GMT","name":"Date","description":""},{"key":"Server","value":"","name":"Server","description":""},{"key":"X-AspNet-Version","value":"","name":"X-AspNet-Version","description":""},{"key":"X-AspNetMvc-Version","value":"X-AspNet-Version:","name":"X-AspNetMvc-Version","description":""},{"key":"X-Powered-By","value":"","name":"X-Powered-By","description":""}],"cookie":[],"responseTime":"4019","body":"{\"ApprovalUrl\":\"\",\"ResponseHeader\":{\"Succeeded\":true,\"Errors\":[]},\"InstallmentPlan\":{\"InstallmentPlanNumber\":\"73274653486133832586\",\"InstallmentPlanStatus\":{\"Id\":3,\"Code\":\"InProgress\",\"Description\":\"In Progress\"},\"Amount\":{\"Value\":52.00,\"Currency\":{\"Symbol\":\"US$\",\"Id\":1,\"Code\":\"USD\",\"Description\":\"US Dollar\"}},\"OutstandingAmount\":{\"Value\":34.67,\"Currency\":{\"Symbol\":\"US$\",\"Id\":1,\"Code\":\"USD\",\"Description\":\"US Dollar\"}},\"NumberOfInstallments\":3,\"NumberOfProcessedInstallments\":1,\"OriginalAmount\":{\"Value\":52.00,\"Currency\":{\"Symbol\":\"US$\",\"Id\":1,\"Code\":\"USD\",\"Description\":\"US Dollar\"}},\"RefundAmount\":{\"Value\":0.00,\"Currency\":{\"Symbol\":\"US$\",\"Id\":1,\"Code\":\"USD\",\"Description\":\"US Dollar\"}},\"Consumer\":{\"Id\":\"0\",\"UserName\":\"JohnS\",\"FullName\":\"John Smith\",\"Email\":\"JohnS@splitit.com\",\"PhoneNumber\":\"1-844-775-4848\",\"CultureName\":\"en-US\",\"RoleName\":null,\"IsLocked\":false},\"ActiveCard\":{\"CardId\":null,\"CardNumber\":\"**** **** **** 1111\",\"CardExpMonth\":\"8\",\"CardExpYear\":\"2019\",\"CardBrand\":{\"Id\":2,\"Code\":\"Visa\",\"Description\":\"VISA\"},\"CardType\":{\"Id\":1,\"Code\":\"Credit\",\"Description\":\"CREDIT\"},\"Bin\":\"411111\",\"CardHolderFullName\":\"John Smith\",\"CardCvv\":\"[Filtered]\",\"Address\":{\"AddressLine\":\"260 Madison Avenue.\",\"AddressLine2\":\"Appartment 1\",\"City\":\"New York\",\"Country\":\"US\",\"State\":\"NY\",\"Zip\":\"10016\",\"FullAddressLine\":\"260 Madison Avenue.,Appartment 1,New York,NY,US\"}},\"Terminal\":{\"Id\":10087,\"Code\":\"WebApiTestChargeAfterTerminal\",\"Description\":\"WebApiTestTerminal\"},\"Merchant\":{\"Id\":10024,\"Code\":\"webapitest\",\"Description\":\"WebApiTest\"},\"RefOrderNumber\":\"012AB\",\"PurchaseMethod\":{\"Id\":3,\"Code\":\"ECommerce\",\"Description\":\"E-Commerce\"},\"Strategy\":{\"Id\":1,\"Code\":\"SecuredPlan\",\"Description\":\"Secured\"},\"DelayResolution\":null,\"ExtendedParams\":{\"AnyParameterKey1\":\"AnyParameterVal1\",\"AnyParameterKey2\":\"AnyParameterVal2\"},\"IsFullCaptured\":false,\"IsChargedBack\":false,\"ArePaymentsOnHold\":false,\"ScpFundingPercent\":0.00,\"TestMode\":\"None\",\"CreationDateTime\":\"2018-05-31T12:59:18.4770000\",\"Installments\":[{\"InstallmentNumber\":1,\"Amount\":{\"Value\":17.33,\"Currency\":{\"Symbol\":\"US$\",\"Id\":1,\"Code\":\"USD\",\"Description\":\"US Dollar\"}},\"OriginalAmount\":{\"Value\":17.33,\"Currency\":{\"Symbol\":\"US$\",\"Id\":1,\"Code\":\"USD\",\"Description\":\"US Dollar\"}},\"RefundAmount\":{\"Value\":0.00,\"Currency\":{\"Symbol\":\"US$\",\"Id\":1,\"Code\":\"USD\",\"Description\":\"US Dollar\"}},\"ProcessDateTime\":\"2018-05-31T12:59:25.5587248Z\",\"IsRefund\":false,\"RequiredCredit\":{\"Value\":52.00,\"Currency\":{\"Symbol\":\"US$\",\"Id\":1,\"Code\":\"USD\",\"Description\":\"US Dollar\"}},\"CreatedDateTime\":\"2018-05-31T12:59:18.5570000\",\"Status\":{\"Id\":3,\"Code\":\"Finished\",\"Description\":\"Finished\"},\"TransactionResults\":[{\"GatewayTransactionId\":\"bdbd6b39-9ecd-4c08-8764-a8247d7290fd\",\"GatewayResultCode\":\"1\",\"GatewayResultMessage\":\"Capture Succeeded\",\"OperationType\":{\"Id\":2,\"Code\":\"Capture\",\"Description\":\"Captured\"},\"GatewayResult\":true,\"GatewayTransactionDate\":\"2018-05-31T12:59:25.5119284+00:00\"},{\"GatewayTransactionId\":\"bdbd6b39-9ecd-4c08-8764-a8247d7290fd\",\"GatewayResultCode\":\"1\",\"GatewayResultMessage\":\"Authorize Succeeded\",\"OperationType\":{\"Id\":1,\"Code\":\"Authorize\",\"Description\":\"Approved\"},\"GatewayResult\":true,\"GatewayTransactionDate\":\"2018-05-31T12:59:24.4356112+00:00\"}],\"CardDetails\":{\"CardId\":null,\"CardNumber\":\"**** **** **** 1111\",\"CardExpMonth\":\"8\",\"CardExpYear\":\"2019\",\"CardBrand\":{\"Id\":2,\"Code\":\"Visa\",\"Description\":\"VISA\"},\"CardType\":{\"Id\":1,\"Code\":\"Credit\",\"Description\":\"CREDIT\"},\"Bin\":\"411111\",\"CardHolderFullName\":\"John Smith\",\"CardCvv\":\"[Filtered]\",\"Address\":{\"AddressLine\":\"260 Madison Avenue.\",\"AddressLine2\":\"Appartment 1\",\"City\":\"New York\",\"Country\":\"US\",\"State\":\"NY\",\"Zip\":\"10016\",\"FullAddressLine\":\"260 Madison Avenue.,Appartment 1,New York,NY,US\"}},\"Result\":true},{\"InstallmentNumber\":2,\"Amount\":{\"Value\":17.33,\"Currency\":{\"Symbol\":\"US$\",\"Id\":1,\"Code\":\"USD\",\"Description\":\"US Dollar\"}},\"OriginalAmount\":{\"Value\":17.33,\"Currency\":{\"Symbol\":\"US$\",\"Id\":1,\"Code\":\"USD\",\"Description\":\"US Dollar\"}},\"RefundAmount\":{\"Value\":0.00,\"Currency\":{\"Symbol\":\"US$\",\"Id\":1,\"Code\":\"USD\",\"Description\":\"US Dollar\"}},\"ProcessDateTime\":\"2018-06-30T12:59:24.9971680Z\",\"IsRefund\":false,\"RequiredCredit\":{\"Value\":34.67,\"Currency\":{\"Symbol\":\"US$\",\"Id\":1,\"Code\":\"USD\",\"Description\":\"US Dollar\"}},\"CreatedDateTime\":\"2018-05-31T12:59:18.5570000\",\"Status\":{\"Id\":2,\"Code\":\"WaitingForProcessDate\",\"Description\":\"Waiting for process date\"},\"TransactionResults\":[],\"CardDetails\":null,\"Result\":null},{\"InstallmentNumber\":3,\"Amount\":{\"Value\":17.34,\"Currency\":{\"Symbol\":\"US$\",\"Id\":1,\"Code\":\"USD\",\"Description\":\"US Dollar\"}},\"OriginalAmount\":{\"Value\":17.34,\"Currency\":{\"Symbol\":\"US$\",\"Id\":1,\"Code\":\"USD\",\"Description\":\"US Dollar\"}},\"RefundAmount\":{\"Value\":0.00,\"Currency\":{\"Symbol\":\"US$\",\"Id\":1,\"Code\":\"USD\",\"Description\":\"US Dollar\"}},\"ProcessDateTime\":\"2018-07-31T12:59:24.9971680Z\",\"IsRefund\":false,\"RequiredCredit\":{\"Value\":17.34,\"Currency\":{\"Symbol\":\"US$\",\"Id\":1,\"Code\":\"USD\",\"Description\":\"US Dollar\"}},\"CreatedDateTime\":\"2018-05-31T12:59:18.5570000\",\"Status\":{\"Id\":2,\"Code\":\"WaitingForProcessDate\",\"Description\":\"Waiting for process date\"},\"TransactionResults\":[],\"CardDetails\":null,\"Result\":null}],\"SecureAuthorizations\":[{\"ProcessingDate\":\"2018-05-31T12:59:23.9364496+00:00\",\"Amount\":{\"Value\":34.67,\"Currency\":{\"Symbol\":\"US$\",\"Id\":1,\"Code\":\"USD\",\"Description\":\"US Dollar\"}},\"TransactionResults\":[{\"GatewayTransactionId\":\"3b86324b-fdc4-495b-8dfe-0a6b4930f099\",\"GatewayResultCode\":\"1\",\"GatewayResultMessage\":\"Authorize Succeeded\",\"OperationType\":{\"Id\":1,\"Code\":\"Authorize\",\"Description\":\"Approved\"},\"GatewayResult\":true,\"GatewayTransactionDate\":\"2018-05-31T12:59:23.8896532+00:00\"}],\"CardDetails\":{\"CardId\":null,\"CardNumber\":\"**** **** **** 1111\",\"CardExpMonth\":\"8\",\"CardExpYear\":\"2019\",\"CardBrand\":{\"Id\":2,\"Code\":\"Visa\",\"Description\":\"VISA\"},\"CardType\":{\"Id\":1,\"Code\":\"Credit\",\"Description\":\"CREDIT\"},\"Bin\":\"411111\",\"CardHolderFullName\":\"John Smith\",\"CardCvv\":\"[Filtered]\",\"Address\":{\"AddressLine\":\"260 Madison Avenue.\",\"AddressLine2\":\"Appartment 1\",\"City\":\"New York\",\"Country\":\"US\",\"State\":\"NY\",\"Zip\":\"10016\",\"FullAddressLine\":\"260 Madison Avenue.,Appartment 1,New York,NY,US\"}},\"Result\":true}]}}"}],"_postman_id":"337b85e4-7608-fa6c-03ff-d2c872d30f2a"},{"name":"4. Approve ","id":"84b35e2c-d227-2dbe-aacf-6d5d07810948","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"RequestHeader\": {\r\n \"SessionId\": \"{{SessionId}}\",\r\n \"ApiKey\": \"{{ApiKey}}\"\r\n},\r\n \"InstallmentPlanNumber\": \"{{InstallmentPlanNumber}}\"\r\n}"},"url":"{{url}}/api/InstallmentPlan/Approve?format=json","description":"

Description:

Important - This Service Need to be used only if Approval Evidence was not transfered as part of Create Service.

This service allows you to indicate that shopper has approved the installment plan terms and conditions. On shopper approval, the first installment will be charged if installment plan is set to be charged automatically on creation.

Please notice that the terms and conditions must be displayed to shopper and shopper must approve it before calling this service.

Request parameters

* For information about request header that need to be sent as part of every transaction, please check request header description in introduction.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Default	Description
InstallmentPlanNumber required	String		The installment plan unique number

Response:

* For information about response header, please check response header description in introduction.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
InstallmentPlan	InstallmentPlan	full installment plan data response, for full information, please refer to the documentation here

","urlObject":{"path":["api","InstallmentPlan","Approve"],"host":["{{url}}"],"query":[{"key":"format","value":"json"}],"variable":[]}},"response":[],"_postman_id":"84b35e2c-d227-2dbe-aacf-6d5d07810948"},{"name":"5. StartInstallments","id":"e31bf3cb-d848-72fa-286a-ef419dc1ecd5","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"RequestHeader\": {\r\n \"SessionId\": \"{{SessionId}}\",\r\n \"ApiKey\": \"{{ApiKey}}\"\r\n},\r\n \"InstallmentPlanNumber\": \"{{InstallmentPlanNumber}}\"\r\n}"},"url":"{{url}}/api/InstallmentPlan/StartInstallments?format=json","description":"

Description:

This service indicate splitit to start running the first charge.

Please notice that this service is mandatory only for installment plans that were set as AutoCapture=false when it was originally created\\initiated.

Request parameters

* For information about request header that need to be sent as part of every transaction, please check request header description in introduction.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Default	Description
InstallmentPlanNumber required	String		The installment plan unique number

Response:

* For information about response header, please check response header description in introduction.

\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
InstallmentPlan	InstallmentPlan	full installment plan detail response, for full information, please refer to the documentation here

","urlObject":{"path":["api","InstallmentPlan","StartInstallments"],"host":["{{url}}"],"query":[{"key":"format","value":"json"}],"variable":[]}},"response":[],"_postman_id":"e31bf3cb-d848-72fa-286a-ef419dc1ecd5"},{"name":"6. UpdatePlan","id":"6628bc5a-6aaf-f403-11a2-3ebc42dd59c9","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"RequestHeader\": {\r\n \"SessionId\": \"{{SessionId}}\",\r\n \"ApiKey\": \"{{ApiKey}}\"\r\n},\r\n \"InstallmentPlanNumber\": \"{{InstallmentPlanNumber}}\",\r\n \"PlanData\": {\r\n \"RefOrderNumber\": \"XYZb\",\r\n \"ExtendedParams\": {\r\n \"AnyParameterKey1\": \" AnyParameterVal1\",\r\n \"AnyParameterKey2\": \" AnyParameterVal2\"\r\n }\r\n }\r\n}"},"url":"{{url}}/api/InstallmentPlan/Update?format=json","description":"

Description:

This service enable update some plan parameters as ref order number and extended parameters

Request parameters

* For information about request header that need to be sent as part of every transaction, please check request header description in introduction.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
InstallmentPlanNumber required	String	The installment plan unique number
PlanData.RefOrderNumber	String	Update installment plan reference order number
PlanData.ExtendedParams	String	Update installment plan dynamic parameters

Response:

* For information about response header, please check response header description in introduction.

\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
InstallmentPlan	InstallmentPlan	full installment plan detailed response, for full information, please refer to the documentation here

","urlObject":{"path":["api","InstallmentPlan","Update"],"host":["{{url}}"],"query":[{"key":"format","value":"json"}],"variable":[]}},"response":[],"_postman_id":"6628bc5a-6aaf-f403-11a2-3ebc42dd59c9"},{"name":"7. Cancel","id":"def2ea92-f09b-2f96-3ce8-258fbca1a2c4","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"RequestHeader\": {\r\n \"SessionId\": \"{{SessionId}}\",\r\n \"ApiKey\": \"{{ApiKey}}\"\r\n},\r\n \"InstallmentPlanNumber\": \"{{InstallmentPlanNumber}}\",\r\n \"RefundUnderCancelation\": \"OnlyIfAFullRefundIsPossible\"\r\n}"},"url":"{{url}}/api/InstallmentPlan/Cancel?format=json","description":"

Description:

This service allows cancelling installment plan with or without refund.

Request parameters

* For information about request header that need to be sent as part of every transaction, please check request header description in introduction.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter

Type

Default

Description

InstallmentPlanNumber
required

String

The installment plan unique number

RefundUnderCancelation

String

NoRefunds

One of the following values:

NoRefunds - will cancel the plan without refunding the shopper

OnlyIfAFullRefundIsPossible - will cancel the plan only if full refund for all past installments was done.

Response:

* For information about response header, please check response header description in introduction.

\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
InstallmentPlan	InstallmentPlan	full installment plan detail response, for full information, please refer to the documentation here

","urlObject":{"path":["api","InstallmentPlan","Cancel"],"host":["{{url}}"],"query":[{"key":"format","value":"json"}],"variable":[]}},"response":[],"_postman_id":"def2ea92-f09b-2f96-3ce8-258fbca1a2c4"},{"name":"8. Refund","id":"a70b03a8-8f65-0737-0991-b61a5be66310","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"RequestHeader\": {\r\n \"SessionId\": \"{{SessionId}}\",\r\n \"ApiKey\": \"{{ApiKey}}\"\r\n},\r\n \"InstallmentPlanNumber\": \"{{InstallmentPlanNumber}}\",\r\n \"Amount\": {\"Value\": \"15\"},\r\n \"RefundStrategy\": \"FutureInstallmentsFirst\"\r\n\r\n}"},"url":"{{url}}/api/InstallmentPlan/Refund?format=json","description":"

Description:

This service allows partial or full refund in few different methods:

FutureInstallmentsFirst (default) - The service will try to reduce the refund amount from the plan's outstanding amount (future installments that were still not charged ) prior to already charged installments. if the refund amount is bigger than the outstanding amount, it will than start to refund already charged installments.
FutureInstallmentsLast = The service will try to refund amount from already charged installments, if the refund amount is bigger than the total charged amount, it will than start to reduce the refund amount from the plan's outstanding amount.
FutureInstallmentsNotAllowed = The service will try to refund amount only from already charged installments.

Request parameters

* For information about request header that need to be sent as part of every transaction, please check request header description in introduction.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter

Type

Default

Description

InstallmentPlanNumber
required

String

The installment plan unique number

Amount

Null

Important: If full amount is requested, this element should not be added

The refund amount, includes:

Value (decimal). Example - 305.50

CurrencyCode (string) - should be in a format of ISO 4217 currency. Example - USD

RefundStrategy

String

NoRefunds

One of the following values :

FutureInstallmentsFirst

FutureInstallmentsLast

FutureInstallmentsNotAllowed

Response:

* For information about response header, please check response header description in introduction.

\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
InstallmentPlan	InstallmentPlan	full installment plan detailed response, for full information, please refer to the documentation here

","urlObject":{"path":["api","InstallmentPlan","Refund"],"host":["{{url}}"],"query":[{"key":"format","value":"json"}],"variable":[]}},"response":[],"_postman_id":"a70b03a8-8f65-0737-0991-b61a5be66310"},{"name":"9. Get","id":"996628ce-8387-7a28-85af-8acd268abd49","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"RequestHeader\": {\r\n \"SessionId\": \"{{SessionId}}\"\r\n},\r\n \"QueryCriteria\": {\r\n \"InstallmentPlanNumber\": \"{{InstallmentPlanNumber}}\"\r\n }\r\n}\r\n"},"url":"{{url}}/api/InstallmentPlan/Get?format=json","description":"

Description:

Get full installment plan data.

Request parameters

* For information about request header that need to be sent as part of every transaction, please check request header description in introduction.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Default	Description
InstallmentPlanNumber required	String		The installment plan unique number

Response:

* For information about response header, please check response header description in introduction.

\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
InstallmentPlan	InstallmentPlan	full installment plan detailed response, for full information, please refer to the documentation here

","urlObject":{"path":["api","InstallmentPlan","Get"],"host":["{{url}}"],"query":[{"key":"format","value":"json"}],"variable":[]}},"response":[],"_postman_id":"996628ce-8387-7a28-85af-8acd268abd49"},{"name":"10. VerifyPayment","id":"0ba6a0d7-f68e-598a-4fa0-2cfc955d1b2c","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"RequestHeader\": {\r\n \"SessionId\": \"{{SessionId}}\"\r\n },\r\n \"InstallmentPlanNumber\": \"{{InstallmentPlanNumber}}\" \r\n}"},"url":"{{url}}/api/InstallmentPlan/Get/VerifyPayment","description":"

Description:

Verifies whether payment is secured for specific installment plan.

Remark: for unsecured plan, payment may be only partially secured (first charge)

Request parameters

* For information about request header that need to be sent as part of every transaction, please check request header description in introduction.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Default	Description
InstallmentPlanNumber required	String		The installment plan unique number

Response:

* For information about response header, please check response header description in introduction.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
IsPaid	Boolean	\n False- Payment not secured \n True- Payment secured \n

Parameter

Type

Description

IsPaid

Boolean

False- Payment not secured

True- Payment secured

","urlObject":{"path":["api","InstallmentPlan","Get","VerifyPayment"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0ba6a0d7-f68e-598a-4fa0-2cfc955d1b2c"}],"event":[{"listen":"prerequest","script":{"id":"f044e974-dee3-4161-aa4b-a5e91dd3326a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"219ca18b-8b52-49ff-b35b-63aa23d39888","type":"text/javascript","exec":[""]}}]}