Skip to content

Aprovar Cash Out

Aprova uma transferência PIX previamente criada. Utilizado no fluxo de duas etapas (criar + aprovar), onde a transferência aguarda aprovação explícita antes de ser enviada ao SPI.

Endpoint

POST /api/v2/external/pix/cash-out/approve

Headers

HeaderTipoObrigatórioDescrição
AuthorizationStringSimBearer {access_token}
Content-TypeStringSimapplication/json
hmacStringSimAssinatura HMAC-SHA512 do body (hex)

Request Body

CampoTipoObrigatórioDescrição
transaction_idStringSimID da transação retornado na criação do cash-out

Fluxo de aprovação

Este endpoint deve ser chamado apenas para transações que estejam com status pending_approval. Transações que ja foram aprovadas ou processadas retornam erro.

Exemplo

bash
curl -X POST https://api.owem.com.br/api/v2/external/pix/cash-out/approve \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -H "hmac: $HMAC" \
  -d '{
    "transaction_id": "PIXOUT20260309a1b2c3d4e5f6"
  }'

Resposta de Sucesso — 200

json
{
  "worked": true,
  "transaction_id": "PIXOUT20260309a1b2c3d4e5f6",
  "status": "processing",
  "detail": "Transacao aprovada e enviada para processamento"
}
CampoTipoDescrição
workedBooleantrue indica que a aprovação foi aceita
transaction_idStringIdentificador da transação aprovada
statusStringNovo status: processing
detailStringMensagem descritiva

Resposta de Erro — 404

json
{
  "worked": false,
  "detail": "Transacao nao encontrada"
}

Resposta de Erro — 422

json
{
  "worked": false,
  "detail": "Transacao ja foi processada"
}

Fluxo Criar + Aprovar

1. POST /api/v2/external/pix/cash-out      → status: pending_approval
2. POST /api/v2/external/pix/cash-out/approve → status: processing
3. Webhook ou consulta                       → status: completed / failed

Quando usar o fluxo de aprovação

O fluxo de duas etapas permite validar a transação internamente (por exemplo, com regras de compliance ou limites) antes de autorizar o envio ao SPI. Se a sua operação nao requer aprovacao manual, o cash-out por chave ou EMV ja envia diretamente para processamento.

Owem Pay Instituição de Pagamento — ISPB 37839059