Skip to content

PIX Cash Out por Clave

Realiza una transferencia PIX utilizando la clave PIX del destinatario.

Endpoint

POST /api/external/pix/cash-out

Headers

HeaderTipoObligatorioDescripcion
AuthorizationStringSiApiKey {client_id}:{client_secret}
Content-TypeStringSiapplication/json
hmacStringSiFirma HMAC-SHA512 del body (hex)
Idempotency-KeyStringNoClave unica para evitar procesamiento duplicado (max 256 chars)

Autenticacion

Vea Autenticacion. La firma HMAC debe generarse conforme lo descrito en HMAC-SHA512.

Request Body

CampoTipoObligatorioDescripcion
amountIntegerSiValor en centavos. R$ 30,00 = 3000
pix_keyStringSiClave PIX del destinatario
pix_key_typeStringNoTipo de clave: cpf, cnpj, email, phone, evp. Si se omite, se detecta automaticamente a partir de la clave.
descriptionStringNoDescripcion de la transferencia (max 140 caracteres)
external_idStringNoIdentificador de su sistema para rastreo. Max 128 chars. Solo a-zA-Z0-9._:-. Retornado en respuestas y webhooks.

Valores monetarios

Los valores de entrada son en centavos (R$ 1,00 = 100). Los valores de respuesta son en unidades base (R$ 1,00 = 10000). Para convertir la respuesta a reales, divida por 10.000. Nunca use punto flotante.

Ejemplo

bash
curl -X POST https://api.owem.com.br/api/external/pix/cash-out \
  -H "Authorization: ApiKey $CLIENT_ID:$CLIENT_SECRET" \
  -H "Content-Type: application/json" \
  -H "hmac: $HMAC" \
  -d '{
    "amount": 3000,
    "pix_key": "12345678901",
    "pix_key_type": "cpf",
    "description": "Pagamento fornecedor",
    "external_id": "order-9876"
  }'

Respuesta de Exito -- 200

json
{
  "worked": true,
  "transaction_id": "PIXOUT20260309a1b2c3d4e5f6",
  "end_to_end_id": "E37839059202603091530abcdef01",
  "external_id": "order-9876",
  "amount": 300000,
  "fee_amount": 350,
  "net_amount": 300350,
  "status": "processing",
  "detail": "PIX enviado para processamento"
}
CampoTipoDescripcion
workedBooleantrue indica que la solicitud fue aceptada
transaction_idStringIdentificador unico de la transaccion
end_to_end_idStringIdentificador End-to-End en el SPI/BACEN (formato E{ISPB}...)
external_idStringSu identificador, retornado tal como fue enviado. null si no fue informado
amountIntegerValor de la transferencia en unidades base (/ 10.000 para reales). 300000 = R$ 30,00
fee_amountIntegerTarifa cobrada en unidades base (/ 10.000 para reales)
net_amountIntegerValor neto (amount + fee) en unidades base
statusStringprocessing (en liquidacion) o completed (liquidado)
detailStringMensaje descriptivo

Respuesta de Error -- 400

json
{
  "worked": false,
  "detail": "Chave PIX invalida"
}

Respuesta de Error -- 422

json
{
  "worked": false,
  "detail": "Saldo insuficiente"
}

Tipos de Clave PIX

TipoFormatoEjemplo
cpf11 digitos (sin puntuacion)12345678901
cnpj14 digitos (sin puntuacion)12345678000199
emailDireccion de e-mailnome@empresa.com.br
phone+55 + DDD + numero+5511999998888
evpUUID v4a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d

Proximos Pasos

Despues de crear la transferencia, acompane el estado via:

O reciba la confirmacion automaticamente via Webhook.

Owem Pay Instituição de Pagamento — ISPB 37839059