Create banking payout
POST /order/v1/banking/order-payouts
Create a PIX payout using accountId as payer and different initiation types (MANUAL/KEY/STATIC_QRCODE/DYNAMIC_QRCODE).
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Header Parameters
Section titled “Header Parameters ”Unique key for idempotent requests
Request Body required
Section titled “Request Body required ”object
External identifier of the payout
Payer account identifier
Payment method
Initiation type
Receiver information
object
Receiver full name
Receiver document
object
Document type
Document number
Payment data
object
Pix key for KEY initiation
QR Code data for STATIC/DYNAMIC initiation
Bank account data (required for MANUAL initiation)
object
ISPB code
Account type (e.g., CHECKING_ACCOUNT)
Branch number
Account number
Payout amount
object
Currency code
Amount value as numeric string
Description of the payout
Responses
Section titled “ Responses ”object
Payout identifier
External identifier
Status of the payout
Amount value as string
Currency
Payout description
EndToEnd identifier (PIX)
Batch information when this payout was split into a batch
object
Id of the batch
Total number of child transactions in the batch
Number of child transactions already paid
Number of child transactions that failed
Number of child transactions still pending
Amount already paid across all child transactions
Amount still pending across all child transactions
Child transactions the batch was split into
object
Id of this child transaction
Idempotency key of this child transaction - the first child reuses the batch idempotencyKey verbatim, later ones suffix it
Ordering position of this child transaction within the batch
Amount of this child transaction
Status of this child transaction
End-to-end id of this child transaction
Date this child transaction was paid
Error message when this child transaction failed
Bad request
Forbidden
Internal error