API Reference
  1. Autra Platform API
  2. Banking

Criar devolução Pix (refund / MED)

post
https://api.autra.io/v1/banking/pix/reversals

Cria uma devolução Pix via Autra POST /spi/v1/reversal. Cobre os 4 motivos BACEN:

  • REFUND (MD06): devolução comum a pedido do recebedor. Janela 90 dias.
  • WITHDRAW_ERROR (SL02): erro/divergência em Pix Saque/Troco.
  • MED_OPERATIONAL (BE08): MED por falha operacional do PSP. Janela 80 dias.
  • MED_FRAUD (FR01): MED por suspeita fundada de fraude. Janela 80 dias.

Valor parcial é permitido (amount ≤ valor do Pix original).

Idempotência: forneça idempotencyKey (body ou header Idempotency-Key) — vira o business_key na Autra. Se omitido, a Autra gera UUID v4 e devolve em businessKey no response.

A Autra devolve 202 Accepted; a liquidação BACEN é assíncrona e o status local muda para COMPLETED quando o webhook chegar (ou via consulta GET — polling on-demand).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Body para criar uma devolução Pix (refund ou MED).

Pelo menos uma das duas formas de referenciar o Pix original é obrigatória:

  • originalReceivedId (UUID interno Autra do registro em pix_received) — preferido.
  • originalBusinessKey (UUID Autra cru) — escape hatch quando pix_received ainda não foi populado pelo webhook.

Idempotência: idempotencyKey (body ou header Idempotency-Key) vira o business_key enviado à Autra. Se omitido, a Autra gera um UUID v4 e devolve em businessKey no response.

uuid
required
uuid

ID interno do Pix recebido em pix_received. Opcional se originalBusinessKey for fornecido.

string

business_key Autra do Pix original. Opcional se originalReceivedId for fornecido.

float
required

Valor da devolução (> 0). Permite parcial — não pode exceder o valor original.

string
enum
required
Allowed:
string

Descrição livre da devolução.

string

Chave de idempotência. Vira o business_key na Autra. Se omitida, é gerada e devolvida no response.

Headers
string

Alternativa ao campo idempotencyKey no body. Vira business_key na Autra.

Responses

403

Token inválido.

404

ORIGINAL_NOT_FOUND — Pix original não encontrado em pix_received.

Updated 11 days ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 11 days ago

Did this page help you?