Create authorization

post

https://api-sandbox.astrapay.com.br/v1/pix/automatic/authorizations

Create a new automatic PIX authorization that allows the Astrapay to debit the user's account for recurring or variable payments.

Body Params

Authorization creation request with user details, creditors, and payment parameters

user

object

User (debtor) information

participantId

string

ID of the participating financial institution

creditors

array of objects

List of creditors authorized to receive payments

creditors

description

string

Human-readable description of the authorization purpose

maximumVariableAmount

int32

Maximum amount in cents for variable payments

minimumVariableAmount

int32

Minimum amount in cents for variable payments

isRetryAccepted

boolean

Whether payment retries are accepted after failures

interval

string

Payment recurrence interval in ISO 8601 duration format (e.g., P1M for monthly)

referenceStartDate

date

Reference start date for recurring payments

contractId

string

External contract or agreement identifier

contractDebtor

object

User (debtor) information

firstPayment

object

Details of the first payment in a recurring authorization

clientMetadata

object

Metadata about the client device/platform initiating the request

Headers

x-transaction-id

uuid

required

Transaction UUID for tracing and idempotency

Response

200Authorization created successfully