Enviar pago PIX (Cash-Out)
Envía un pago PIX a una clave PIX.
Requiere un Bearer token en el header Authorization.
| Campo | Tipo | Requerido | Descripción |
|---|
value | number | Sí | Monto de la transacción en BRL (hasta 2 decimales) |
externalId | string | Sí | Identificador externo único de la transacción |
description | string | No | Descripción opcional de la transacción |
details | object | Sí | Información de la clave PIX de destino |
details.key | string | Sí | Clave PIX de destino |
details.keyType | string | Sí | Tipo de clave PIX: EMAIL, PHONE, DOCUMENT, RANDOM |
details.name | string | Sí | Nombre del titular de la clave PIX |
details.document | string | Sí | Documento del titular (CPF o CNPJ, solo números) |
{
"value": 15.50,
"externalId": "external-teste-001",
"description": "Pagamento fornecedor XYZ",
"details": {
"key": "12312312387",
"keyType": "DOCUMENT",
"name": "John Marvin",
"document": "12312312387"
}
}
| Campo | Tipo | Descripción |
|---|
transactionId | string | Identificador interno de la transacción generada |
externalId | string | Identificador externo proporcionado en la solicitud |
status | string | Estado actual de la transacción (PENDING, CONFIRMED, ERROR) |
generateTime | string | Fecha/hora de generación de la transacción (ISO 8601) |
{
"transactionId": "456",
"externalId": "external-teste-001",
"status": "PENDING",
"generateTime": "2024-01-15T10:30:00.000Z"
}
| Estado | Descripción |
|---|
| 400 | Datos inválidos o saldo insuficiente |
| 401 | Token faltante o inválido |
| 500 | Error al procesar el pago PIX |
