Create PIX Checkout

post

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

Creates a new PIX checkout containing multiple PIX payments for processing.

Body Params

checkoutId

string

required

length ≤ 50

Unique identifier for the checkout provided by the client

debitAccount

object

required

Account information for checkout debit

payments

array of objects

required

length between 1 and 1000

List of PIX payments to be included in the checkout

payments*

paymentId

string

required

length ≤ 50

Unique identifier for the payment within the checkout

pixKey

object

required

PIX key information for payment

amount

number

required

0.01 to 999999.99

Payment amount in Brazilian Real (BRL)

beneficiaryName

string

required

length ≤ 100

Name of the payment beneficiary

description

string

length ≤ 200

Payment description or purpose

paymentDate

date

Scheduled payment date (YYYY-MM-DD format)

userReference

string

length ≤ 100

Optional client reference for the payment

userReference

string

length ≤ 100

Optional client reference for the checkout

Headers

x-transaction-id

uuid

required

Unique transaction identifier for request tracking

Responses

Language

Credentials

OAuth2

URL

Response

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

application/json

200SUCCESS. The batch was created successfully.

400INVALID REQUEST. The server could not process the request due to malformed syntax, invalid request structure, or invalid values.

401UNAUTHORIZED. The request requires user authentication.

403FORBIDDEN. The request was valid but the server is refusing the action. The user may not have the necessary permissions for a resource.

500INTERNAL SERVER ERROR. The server encountered an unexpected condition that prevented it from fulfilling the request.