Create an authorization

post

https://api-sandbox.asaas.com/v3/pix/automatic/authorizations

Creates an Automatic Pix authorization linked to a customer and generates the immediate QR Code used for the first payment and for obtaining consent for recurring payments.

The mode defined in paymentCreationMode determines whether the payments for the next cycles are created by your application or automatically by a subscription.

📘
Authorization activation
Creating the authorization does not mean it is already active. The response provides the authorization id and the QR Code for the first payment.
After the first payment is completed and the payer authorizes it, the authorization changes to ACTIVE. Track this change through the Automatic Pix Webhooks.
See the Automatic Pix events.

Related content

Guides

Webhooks

Automatic Pix events

Body Params

frequency

string

enum

required

Frequency of periodic payments

Allowed:

contractId

string

required

length ≤ 35

Number, identifier, or code representing the authorization object

startDate

date

required

Start of authorization validity and payments

finishDate

date

End of authorization validity. Optional if the Automatic Pix is for an indefinite period

value

number

Fixed amount for periodic charges.

description

string

length ≤ 35

Description

customerId

string

required

Unique customer identifier

immediateQrCode

object

required

Immediate charge linked to authorization activation

minLimitValue

number

If the paying user sets a maximum amount for payments under that authorization, it cannot be lower than the minimum amount defined by the receiving user. This field cannot be filled in fixed-amount authorizations, that is, when the value field is already filled

paymentCreationMode

string

enum

Defaults to MANUAL

Mode used to create payments linked to the authorization. Use SUBSCRIPTION to have charges generated automatically through a subscription or MANUAL to create each charge manually. When set to SUBSCRIPTION, the value field must be filled in to configure the subscription

Allowed:

retryPolicy

string

enum

Defaults to NOT_ALLOWED

Retry policy for charges under the authorization. Use ALLOW_THREE_IN_SEVEN_DAYS to allow up to 3 retries within 7 days after the due date or NOT_ALLOWED to disallow retries

Allowed:

Responses

Authorization activation

Related content

Guides

Webhooks

200Ok

400Bad Request

401Unauthorized