Create an authorization

Body Params
string
enum
required

Frequency of periodic payments

Allowed:
string
required
length ≤ 35

Number, identifier, or code representing the authorization object

date
required

Start of authorization validity and payments

date

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

number

Fixed amount for periodic charges.

string
length ≤ 35

Description

string
required

Unique customer identifier

immediateQrCode
object
required

Immediate charge linked to authorization activation

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

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:
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

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