Skip to content

PIX Cash Out Copia e Cola

Realiza uma transferencia PIX utilizando o codigo EMV (copia e cola) extraido de um QR Code PIX.

Endpoint

POST /api/external/pix/cash-out

Headers

HeaderTipoObrigatorioDescricao
AuthorizationStringSimApiKey {client_id}:{client_secret}
Content-TypeStringSimapplication/json
hmacStringSimAssinatura HMAC-SHA512 do body (hex)
Idempotency-KeyStringNaoChave unica para evitar processamento duplicado (max 256 chars)

Request Body

CampoTipoObrigatorioDescricao
amountIntegerSimValor em centavos. R$ 30,00 = 3000
emv_codeStringSimCodigo EMV copia e cola do QR Code PIX
descriptionStringNaoDescricao da transferencia (max 140 caracteres)
external_idStringNaoIdentificador do seu sistema para rastreamento. Max 128 chars. Apenas a-zA-Z0-9._:-. Retornado em respostas e webhooks.

Codigo Copia e Cola

O campo emv_code aceita o codigo EMV completo copiado de um QR Code PIX. A API extrai automaticamente a chave PIX, os dados do recebedor e o valor original da cobranca a partir do payload EMV.

Valor da transferencia

O campo amount deve ser informado mesmo quando o QR Code ja contem um valor. A API valida que o valor informado seja compativel com o QR Code (estatico ou dinamico).

Valores monetarios

Valores de entrada sao em centavos (R$ 1,00 = 100). Valores de resposta sao em unidades base (R$ 1,00 = 10000). Para converter a resposta para reais, divida por 10.000. Nunca use ponto flutuante.

Exemplo

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,
    "emv_code": "00020126580014br.gov.bcb.pix0136a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d5204000053039865802BR5913NOME RECEBEDOR6008BRASILIA62070503***6304ABCD",
    "description": "Pagamento via QR Code",
    "external_id": "invoice-4521"
  }'

Resposta de Sucesso -- 200

json
{
  "worked": true,
  "transaction_id": "PIXOUT20260309a1b2c3d4e5f6",
  "end_to_end_id": "E37839059202603091530abcdef01",
  "external_id": "invoice-4521",
  "amount": 300000,
  "fee_amount": 350,
  "net_amount": 300350,
  "status": "accepted",
  "detail": "PIX enviado para processamento"
}
CampoTipoDescricao
workedBooleantrue indica que a requisicao foi aceita
transaction_idStringIdentificador unico da transacao
end_to_end_idStringIdentificador End-to-End no SPI/BACEN
external_idStringSeu identificador, retornado tal como enviado. null se nao informado
amountIntegerValor da transferencia em unidades base (÷ 10.000 para reais). 300000 = R$ 30,00
fee_amountIntegerTarifa cobrada em unidades base (÷ 10.000 para reais)
net_amountIntegerValor liquido (amount + fee) em unidades base
statusStringaccepted (aceito para processamento) ou completed (liquidado)
detailStringMensagem descritiva

Resposta de Erro -- 400

json
{
  "worked": false,
  "detail": "Codigo EMV invalido ou nao reconhecido"
}

Resposta de Erro -- 422

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

Proximos Passos

Apos criar a transferencia, acompanhe o status via:

Ou receba a confirmacao automaticamente via Webhook.

Owem Pay Instituição de Pagamento — ISPB 37839059