Create new payment

Creates a new payment linked to a customer in the Asaas account.

Use this operation for one-time or installment payments via bank slip (boleto), Pix or credit card. When billingType is UNDEFINED, the payer can choose among the payment methods enabled on the account when accessing the payment page.

For one-time payments, provide value. For installment payments, use installmentCount with only one of installmentValue and totalValue. When using totalValue, Asaas calculates the installment amount and applies any rounding difference to the last installment. In this scenario, the response represents the first payment generated and includes the installment ID.

If the account has global fine and interest settings and they should be kept, do not send interest and fine. Sending these objects with null or empty values may override the configuration for the created payment.

For bank slip (boleto) payments, daysAfterDueDateToRegistrationCancellation defines for how many days after the due date the registration will remain available for payment. The value 0 cancels the registration when the payment changes to OVERDUE; when the field is omitted, the account's default setting applies. This setting cannot be changed after the payment is created.

When creating recurring Automatic Pix payments in MANUAL mode, provide the pixAutomaticAuthorizationId of an ACTIVE authorization. The payment instruction must be created between 2 and 10 business days before the due date. Without this field, the PIX payment is created as a conventional Pix.

📘

Payment tracking

Creating the payment does not represent payment confirmation. Track status changes through the payment Webhooks.

For Pix payments on individual (natural person) accounts, CONFIRMED may be temporary during a precautionary block, for up to 72 hours. After the review, the payment may move to RECEIVED or REFUNDED.

See the Webhook events for payments.

Related content

Guides

Body Params
string
required

Unique customer identifier in Asaas

string
enum
required

Payment billing type

Allowed:
number
required

Payment amount

date
required

Payment due date

string

Payment description (max. 500 characters)

int32

Days after registration cancellation deadline (only for bank slip)

string

Free search field

int32

Number of installments (only in the case of installment payment)

number

Enter the total amount of a charge that will be paid in installments (only in the case of an installment charge). If this field is sent, the installmentValue is not necessary, the calculation per installment will be automatic.

number

Value of each installment (only in the case of installment payment). Send this field if you want to define the value of each installment.

discount
object

Discount information

interest
object

Interest information for payment after due date

fine
object

Fine information for payment after due date

boolean

Define whether the payment will be sent via post

split
array of objects

Split Settings

split
callback
object

Automatic redirection information after the payment of the link payment

string

Unique identifier of the Pix Automatic authorization in Asaas

Responses

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