Skip to main content

Initiate Installment Plan

POST 
https://web-api-v3.sandbox.splitit.com/api/installmentplans/initiate

Initiate establishes an installment plan but doesn't finalize it, and is thus intended for use with Splitit premade checkout solutions such as Payment Forms or Flex Form. Initiate only requires SAQ-A certification. You can call it multiple times for the same installment plan, since 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.

Request​

Responses​

Success

Authorization: http

name: bearerAuthtype: httpin: headerscheme: bearer
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://web-api-v3.sandbox.splitit.com/api/installmentplans/initiate");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <TOKEN>");
var content = new StringContent("{\n  \"AutoCapture\": true,\n  \"Attempt3DSecure\": false,\n  \"PlanData\": {\n    \"TotalAmount\": 50.25,\n    \"Currency\": \"USD\",\n    \"NumberOfInstallments\": 3,\n    \"PurchaseMethod\": \"Ecommerce\",\n    \"RefOrderNumber\": \"MerchantOrder123\",\n    \"TerminalId\": \"b628b9a4-4c21-4691-97c4-c9f8da665a60\",\n    \"FirstInstallmentAmount\": null,\n    \"ExtendedParams\": {\n      \"AnyParameterKey1\": \"AnyParameterVal1\",\n      \"AnyParameterKey2\": \"AnyParameterVal2\"\n    }\n  },\n  \"Shopper\": {\n    \"FullName\": \"John Doe\",\n    \"Email\": \"John.Doe@email.com\",\n    \"PhoneNumber\": \"+1-972-111-1111\",\n    \"Culture\": \"en-US\"\n  },\n  \"BillingAddress\": {\n    \"AddressLine1\": \"street name and number\",\n    \"AddressLine2\": \"\",\n    \"City\": \"NYC\",\n    \"Country\": \"USA\",\n    \"State\": \"NY\",\n    \"Zip\": \"12345\"\n  },\n  \"RedirectUrls\": {\n    \"Succeeded\": \"https://www.success.com\",\n    \"Failed\": \"https://www.fail.com\",\n    \"Cancel\": \"https://www.cancel.com\"\n  }\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
Request Collapse all
Base URL
https://web-api-v3.sandbox.splitit.com/api/installmentplans
Auth
Parameters
— header
— header
Body
{
  "AutoCapture": true,
  "Attempt3DSecure": false,
  "PlanData": {
    "TotalAmount": 50.25,
    "Currency": "USD",
    "NumberOfInstallments": 3,
    "PurchaseMethod": "Ecommerce",
    "RefOrderNumber": "MerchantOrder123",
    "TerminalId": "b628b9a4-4c21-4691-97c4-c9f8da665a60",
    "FirstInstallmentAmount": null,
    "ExtendedParams": {
      "AnyParameterKey1": "AnyParameterVal1",
      "AnyParameterKey2": "AnyParameterVal2"
    }
  },
  "Shopper": {
    "FullName": "John Doe",
    "Email": "John.Doe@email.com",
    "PhoneNumber": "+1-972-111-1111",
    "Culture": "en-US"
  },
  "BillingAddress": {
    "AddressLine1": "street name and number",
    "AddressLine2": "",
    "City": "NYC",
    "Country": "USA",
    "State": "NY",
    "Zip": "12345"
  },
  "RedirectUrls": {
    "Succeeded": "https://www.success.com",
    "Failed": "https://www.fail.com",
    "Cancel": "https://www.cancel.com"
  }
}
ResponseClear

Click the Send API Request button above and see the response here!