Create installments payment

Create a new installments payment.

This endpoint generates the Authorization created event.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
length between 36 and 50

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

integer
required

Unique identifier of an account in the Pismo platform.

float
required

Total amount to be charged.

string
required

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

string

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

boolean

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.

boolean

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.

financed_charge
object

Informative optional object that allows financed charges in the principal_amount to be described and posted only in accounting. All fields within the financed charge object must have the suffix _amount. For example, iof_amount, iva_amount, other_tax_amount. In the name_amount field example, name indicates a dynamic value. To define a new financed charge type field, you must contact a Pismo representative. When the financed_charge object is used, the tax_amout field cannot be used simultaneously, since this object is used only for cases of charges financed in the principal_amount.

metadata
object

Optional valid key-value object to add complementary custom information.

date

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

installments
array of objects
required

Non-empty collection of installments to be used to implement the agreement.

installments*
original_authorization
object

This optional field identifies the original authorization. When this field is provided, all your fields needs be filled.

Headers
string
required
length between 39 and 39

Unique Org ID.

string

Optional account identifier.

string

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

string

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

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json