Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Installments payments

Create installments payment

Create a new installments payment.

This endpoint generates the Authorization created event.

post/payments/v1/payments/installments

Headers

x-tenantstring required
Example:TN-c0e4c660-9059-404c-ab22-761aa431766c

Unique Org ID.

x-account-idstring

Optional account identifier.

x-skip-timelinestring
Example:true

If set to true, this will prevent the generation of timeline events in the customer timeline.

x-cidstring
Example:c737895c-8159-4c0c-a92a-a4f8600bff37

Related correlation identifier. If none is provided, a random one is generated.

Request body

tracking_idstring

Unique tracking ID of the installments operation. If you don't provide one, the Pismo platform generates it randomly.

account_idinteger required

Unique identifier of an account in the Pismo platform.

charging_amountnumber float required

Total amount to be charged.

processing_codestring required

Unique 6-character processing code that identifies the debit operation.

descriptorstring

Optional text that describes the created operation. The platform supports only letters and numbers in this field and removes any special characters or emojis.

skip_balance_validationboolean

When set to true, the platform skips account balance validation and forces the operation. By default, the value is false and the platform performs account balance validation.

skip_account_status_validationboolean

When set to true, the platform skips account status validation and forces the operation. By default, the value is false and the platform performs account status validation.

metadatastring

Any data object with key/value pairs. No limit on length.

Note: This field must not be used to send Personally Identifiable Information (PII), Payment Card Industry (PCI) data, or any sensitive/regulated information. Metadata fields are intended for operational, non-sensitive data only. For sensitive data, use the specific parameters designed for that purpose. For more information, refer to Get started with Pismo APIs.

first_installment_datestring date

Date that the first installment should be posted on the invoice. Format = YYYY-MM-DD.

Example request

{
  "tracking_id": "be68db6e-8da0-4761-8632-6a51857bd123",
  "account_id": 101,
  "charging_amount": 12.13,
  "processing_code": "004000",
  "descriptor": "Installments payment",
  "skip_balance_validation": true,
  "skip_account_status_validation": true,
  "financed_charge": {
    "name_amount": 12.13
  },
  "metadata": "{ \"key\": \"value\"}",
  "first_installment_date": "2023-12-31",
  "installments": [
    {
      "installment_number": 1,
      "total_amount": 1.15,
      "principal_amount": 10,
      "interest_amount": 1,
      "interest_rate": 0.1,
      "tax_amount": 0.05
    }
  ],
  "original_authorization": {
    "id": 101,
    "type": "NETWORK"
  }
}

Response

Created

authorization_idinteger

Generated authorization ID.

event_datestring date-time

Date and time of the authorization, in UTC-0 (RFC3339) format.

tracking_idstring

Unique 36-character identifier for the installments payment. If you didn't provide an identifier, then the Pismo platform automatically generates and includes one in the response.

Example response

{
  "authorization_id": 15301234,
  "event_date": "2020-01-02T15:14:00.218Z",
  "tracking_id": "82766158-514c-42f0-87e2-1bb3250c6dee"
}