Send PIX payment (Cash-Out)
Sends a PIX payment to a PIX key.
Requires a Bearer token in the Authorization header.
| Field | Type | Required | Description |
|---|
value | number | Yes | Transaction amount in BRL (up to 2 decimal places) |
externalId | string | Yes | Unique external identifier for the transaction |
description | string | No | Optional transaction description |
details | object | Yes | Destination PIX key information |
details.key | string | Yes | Destination PIX key |
details.keyType | string | Yes | PIX key type: EMAIL, PHONE, DOCUMENT, RANDOM |
details.name | string | Yes | PIX key holder name |
details.document | string | Yes | Holder's document (CPF or CNPJ, numbers only) |
{
"value": 15.50,
"externalId": "external-teste-001",
"description": "Pagamento fornecedor XYZ",
"details": {
"key": "12312312387",
"keyType": "DOCUMENT",
"name": "John Marvin",
"document": "12312312387"
}
}
| Field | Type | Description |
|---|
transactionId | string | Internal identifier of the generated transaction |
externalId | string | External identifier provided in the request |
status | string | Current transaction status (PENDING, CONFIRMED, ERROR) |
generateTime | string | Transaction generation date/time (ISO 8601) |
{
"transactionId": "456",
"externalId": "external-teste-001",
"status": "PENDING",
"generateTime": "2024-01-15T10:30:00.000Z"
}
| Status | Description |
|---|
| 400 | Invalid data or insufficient balance |
| 401 | Missing or invalid token |
| 500 | Error processing PIX payment |
