DesenvolvedoresReferência da APIReembolsos

Reembolsar pagamento

POST
/refunds

Reembolsa um pagamento confirmado: parcial (amount) ou todo o saldo restante (sem amount, descontando reembolsos em andamento). Exige Idempotency-Key. O reembolso total revoga os acessos marcados para revogar em reembolso e dispara order.refunded.

Chave: Só chave secreta (chamada pelo servidor).

Escopo: orders:write.

Idempotência: exige o cabeçalho Idempotency-Key.

Limite: 60 requisições a cada 1 h, além do limite geral de 600 por minuto por chave.

Autorização

chaveSecreta
headerAutorizaçãoBearer <chave de API>

Chave secreta (sk_…). Use só no servidor; requisições de navegador (com Origin) são recusadas.

Cabeçalhos

Idempotency-Key*string

De 1 a 255 caracteres visíveis. Repetir a chamada com a mesma chave devolve a mesma resposta por 24 horas.

Corpo da requisição

application/json
  1. body
paymentId*string
Formatouuid
amount?integer

Valor em centavos para reembolso parcial. Sem amount, reembolsa todo o saldo.

Intervalo0 < value <= 9007199254740991
reason?string
Tamanholength <= 500

Corpo da resposta

Criado.

application/json
  1. response
data*
meta*
curl -X POST 'https://minepag.com.br/api/v1/refunds' \  -H 'Idempotency-Key: string' \  -H 'Content-Type: application/json' \  -d '{  "paymentId": "472e651e-5a1e-424d-8098-23858bf03ad7"}'
{  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "orderId": "b3e1eced-f2bd-4d8c-9765-fbc9d1d222d5",    "paymentId": "472e651e-5a1e-424d-8098-23858bf03ad7",    "amount": -9007199254740991,    "status": "pending",    "reason": "string",    "initiatedBy": "merchant",    "failureReason": "string",    "processedAt": "2019-08-24T14:15:22Z",    "createdAt": "2019-08-24T14:15:22Z"  },  "meta": {    "requestId": "string"  }}