CreateInstallmentPlanRequest

authorization objectrequired

acceptedbooleanrequired

Merchant attestation of the customer's explicit authorization of these exact finite terms, not merely consent to save a card.

authorizedAtstringrequired

Possible values: <= 64 characters

customerActorstringrequired

Possible values: <= 255 characters

policyVersionstringrequired

Possible values: <= 64 characters

proofReferencestringrequired

Possible values: <= 128 characters

currencystringrequired

Explicit ISO 4217 currency shared by all stages; never inferred from a future location default.

Possible values: Value must match regular expression ^[A-Z]{3}$

customerIdstringrequired

Possible values: <= 64 characters, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$

installmentCountinteger<int32>required

Possible values: >= 2 and <= 999

locationIdstringrequired

Possible values: <= 64 characters, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$

organizationIdstringrequired

Possible values: <= 64 characters, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$

originalTotalMinorinteger<int64>required

Possible values: >= 1 and <= 99999999

planIdstringrequired

Possible values: <= 64 characters, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$

savedPaymentMethodIdstringrequired

Possible values: <= 64 characters, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$

stages object[]required

Possible values: >= 2, <= 999

Array [

amountMinorinteger<int64>required

Possible values: >= 1 and <= 99999999

dueAtstringrequired

Agreed UTC due instant in ISO 8601 format; no charge is admitted before it.

Possible values: <= 64 characters

installmentIdstringrequired

Possible values: <= 64 characters, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$

sequenceinteger<int32>required

One-based immutable sequence within the authorized finite plan.

Possible values: >= 1

]

CreateInstallmentPlanRequest
{
  "authorization": {
    "accepted": true,
    "authorizedAt": "string",
    "customerActor": "string",
    "policyVersion": "string",
    "proofReference": "string"
  },
  "currency": "string",
  "customerId": "string",
  "installmentCount": 0,
  "locationId": "string",
  "organizationId": "string",
  "originalTotalMinor": 0,
  "planId": "string",
  "savedPaymentMethodId": "string",
  "stages": [
    {
      "amountMinor": 0,
      "dueAt": "string",
      "installmentId": "string",
      "sequence": 0
    }
  ]
}