Create Installment with credit card

post

https://api-sandbox.asaas.com/v3/installments/

Creates a credit card installment, providing the card data or a creditCardToken in the creation request itself.

Use this operation when the installment should be created with the card payment method already provided. The payment can be made with creditCard and creditCardHolderInfo or with a creditCardToken. When the token is provided, the card and cardholder data are not required.

When authorizeOnly is true, the operation only pre-authorizes the installment, without immediately capturing the amount.

📘
Tracking payments
Each payment generated by the installment has its own lifecycle. Use Webhooks to track confirmations, receipts, declines, and other subsequent changes.
See the Webhook events for payments.

Related content

Guides

Body Params

installmentCount

int32

required

Number of installments

customer

string

required

Unique customer identifier in Asaas

value

number

required

Value of each installment

totalValue

number

Total installment amount

billingType

string

enum

required

Payment billing type

Allowed:

dueDate

date

required

Due date of the first installment

description

string

Installment description (max. 500 characters)

postalService

boolean

Define whether the payment will be sent via post

daysAfterDueDateToRegistrationCancellation

int32

Days after registration cancellation deadline (only for bank slip)

paymentExternalReference

string

Free search field

discount

object

Discount information

interest

object

Interest information for payment after due date

fine

object

Fine information for payment after due date

splits

array of objects

Split Settings

splits

creditCard

object

required

Credit card information

creditCardHolderInfo

object

required

Credit card holder information

creditCardToken

string

Credit card token for using the credit card tokenization functionality. If informed, the fields creditCard and creditCardHolderInfo are not mandatory.

authorizeOnly

boolean

Carry out only the Pre-Authorization of the installment

remoteIp

string

required

IP from where the customer is making the purchase. Your server's IP must not be entered.

threeDSecure

object

Data to enable 3D Secure authentication on the payment. When informed, the cardholder may be redirected to authenticate with the card issuer before the payment is confirmed.

deviceInfo

object

Cardholder device information, used in 3D Secure authentication for risk analysis by the card issuer

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json