PIX Cash Out por Clave
Realiza una transferencia PIX utilizando la clave PIX del destinatario.
Endpoint
POST /api/v2/external/pix/cash-outEncabezados
| Encabezado | Tipo | Obligatorio | Descripcion |
|---|---|---|---|
| Authorization | String | Si | Bearer {access_token} |
| Content-Type | String | Si | application/json |
| hmac | String | Si | Firma HMAC-SHA512 del body (hex) |
Autenticacion
Obtenga el access_token via Auth Token. La firma HMAC debe generarse segun lo descrito en HMAC-SHA512.
Request Body
| Campo | Tipo | Obligatorio | Descripcion |
|---|---|---|---|
amount | Integer | Si | Valor en centavos. R$ 100,00 = 10000 |
pix_key | String | Si | Clave PIX del destinatario |
pix_key_type | String | Si | Tipo de clave: cpf, cnpj, email, phone, evp |
description | String | No | Descripcion de la transferencia (max. 140 caracteres) |
Valores en centavos
Todos los valores monetarios de la API se representan en centavos (entero). Para enviar R$ 1.500,75 indique 150075.
Ejemplo
bash
curl -X POST https://api.owem.com.br/api/v2/external/pix/cash-out \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-H "hmac: $HMAC" \
-d '{
"amount": 10000,
"pix_key": "12345678901",
"pix_key_type": "cpf",
"description": "Pago a proveedor"
}'Respuesta Exitosa -- 200
json
{
"worked": true,
"transaction_id": "PIXOUT20260309a1b2c3d4e5f6",
"end_to_end_id": "E37839059202603091530abcdef01",
"amount": 10000,
"fee": 0,
"status": "processing",
"detail": "PIX enviado para procesamiento"
}| Campo | Tipo | Descripcion |
|---|---|---|
worked | Boolean | true indica que la solicitud fue aceptada |
transaction_id | String | Identificador unico de la transaccion |
end_to_end_id | String | Identificador End-to-End en el SPI/BACEN (formato E{ISPB}...) |
amount | Integer | Valor de la transferencia en centavos |
fee | Integer | Tarifa cobrada en centavos |
status | String | Estado inicial: processing |
detail | String | Mensaje descriptivo |
Respuesta de Error -- 400
json
{
"worked": false,
"detail": "Clave PIX invalida"
}Respuesta de Error -- 422
json
{
"worked": false,
"detail": "Saldo insuficiente"
}Tipos de Clave PIX
| Tipo | Formato | Ejemplo |
|---|---|---|
cpf | 11 digitos (sin puntuacion) | 12345678901 |
cnpj | 14 digitos (sin puntuacion) | 12345678000199 |
email | Direccion de correo electronico | nombre@empresa.com.br |
phone | +55 + codigo de area + numero | +5511999998888 |
evp | UUID v4 | a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d |
Siguientes Pasos
Despues de crear la transferencia, consulte el estado mediante:
O reciba la confirmacion automaticamente via Webhook.