Devoluções

curl -X POST https://api.oripaysolutions.com.br/v1/pix/received/{id}/refunds \
  -H "Authorization: Bearer $ORIPAY_API_KEY" \
  -H "Idempotency-Key: refund-pedido-8812-1" \
  -H "Content-Type: application/json" \
  -d '{ "amount": 5000, "external_id": "estorno-8812-1", "reason": "Item fora de estoque" }'

{id} é o id do PIX recebido, não da cobrança.
Parcial é permitido: várias devoluções até somar refundable_amount. Passou: 422 refund_amount_exceeds_received.
O dinheiro volta para a mesma conta que pagou. Não é possível escolher outro destino.
Prazo do PIX: até 90 dias após o recebimento. Depois disso: 422 devolution_window_expired.
Corpo: amount (centavos, obrigatório), external_id (obrigatório, único por conta entre devoluções) e reason (até 140 caracteres, opcional). Devoluções não têm metadata. Outros campos: 400 validation_error.
Passa pelo antifraude como as transferências e exige chave com refunds:write aprovada pela OriPay.

Resposta 202 com status: pending. Eventos: refund.completed ou refund.failed. O data do evento é a devolução: id, external_id, received_id (o PIX original), status, amount, end_to_end_id, failure_reason, created_at e updated_at.

Começando

Fundamentos

Fluxos PIX

Webhooks