Create Pix Out Transaction
POST
{{baseUrl}}/api/v1/transactions/pix-out
Idempotency-Key header (UUID format) is required to prevent duplicate transfers. If a request with the same key is sent again, the API returns the original response without processing a new transfer.postbackUrl is provided, webhook notifications will be sent to this URL. If webhookSecret is also provided, webhooks will include an HMAC-SHA256 signature in the X-Webhook-Signature header.Request Headers
| Header | Required | Description |
|---|---|---|
| Idempotency-Key | Yes | Unique UUID to prevent duplicate transfers |
| Content-Type | Yes | application/json |
| Authorization | Yes | Basic Auth (inherited from collection) |
Request Body Fields
| Field | Type | Required | Description |
|---|---|---|---|
| amount | integer | Yes | Amount in cents (min: 100) |
| pixKey | string | Yes | Destination Pix key |
| pixKeyType | string | Yes | CPF, CNPJ, EMAIL, PHONE, or RANDOM |
| destinationName | string | Yes | Recipient name |
| destinationDocument | string | Yes | Recipient CPF/CNPJ (digits only) |
| externalRef | string | No | Client reference/external ID |
| postbackUrl | string | No | URL for webhook notifications |
| webhookSecret | string | No | Secret key for HMAC signature |
| metadata | object | No | Custom metadata for tracking |
Requisição
Parâmetros Header
Parâmetros Bodyapplication/json
Respostas
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request POST '{{baseUrl}}/api/v1/transactions/pix-out' \
--header 'Idempotency-Key: {{$guid}}' \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data-raw '{
"amount": 10000,
"pixKey": "user@example.com",
"pixKeyType": "EMAIL",
"destinationName": "Maria Santos",
"destinationDocument": "98765432100",
"externalRef": "withdraw_123",
"postbackUrl": "https://webhook.example.com/postback",
"webhookSecret": "your-secret-key-for-hmac",
"metadata": {
"channel": "api"
}
}'Response Response Example
201 - 201 - Pix Out Created
{
"success": true,
"data": {
"id": "dd5c6b14-8fb2-4eaf-b092-7e65a6f3182b",
"secureId": "e9fa7447-40b9-46e6-b4e5-29bce3043edc",
"status": "PROCESSING",
"amount": 10000,
"fee": 60,
"netAmount": 10000,
"pixKey": "maria.santos@example.com",
"pixKeyType": "EMAIL",
"destinationName": "Maria Santos",
"destinationDocument": "98765432100",
"requiresManualApproval": false,
"acquirerTxId": null,
"createdAt": "2025-12-12T02:11:40.090Z"
}
}Modificado em 2025-12-29 21:29:45