Create an installment

Set up a new installment payment plan for a customer. When created, the initial charge depends on the deposit amount and start date: if no deposit and no future start date, the first payment is charged immediately; if a future start date is set with no deposit, only card validation is performed; if a deposit is provided with no future start date, the deposit plus first payment are charged immediately; if a deposit is provided with a future start date, only the deposit is charged immediately.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The subMerchantId associated with the installment.

string
required

The ID of the customer for this installment.

number
required

The total amount to be paid across all installments.

deposit
object

Optional deposit charged at creation time.

payments
object
required

Recurring payment schedule configuration.

paymentToken
object
required

The customer's permanent payment token.

Responses
201

Installment successfully created.

400

Bad Request. Invalid input.

401

Unauthorized.

500

Internal Server Error.

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here!