Reverte um pagamento previamente autorizado ou capturado com base nos dados fornecidos na requisição.
PUT /v2/payment/reverse · versão da spec v2 · coleção Postman e spec
Parâmetros
| Nome | Onde | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
Idempotency-Key | header | string | sim | Chave de idempotência da operação (ADR 0013, seção 4.2, item 1). A mesma chave com o mesmo corpo devolve o resultado original (cabeçalho Idempotent-Replayed: true); com corpo diferente, 422. |
Corpo da requisição
application/json
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
sellerId | string (uuid) | não | |
buyerId | string (uuid) | não | |
transactionId | string (uuid) | não | |
externalReference | string | não | |
amount | integer (int32) | não |
Respostas
| Status | Descrição | Formato |
|---|---|---|
| 200 | OK | application/json, text/json, text/plain |
| 202 | Accepted | application/json, text/json, text/plain |
| 400 | Bad Request | application/problem+json |
| 401 | Unauthorized | application/problem+json |
| 403 | Forbidden | application/problem+json |
| 404 | Not Found | application/problem+json |
| 409 | A requisição original com esta Idempotency-Key ainda está em andamento. | application/problem+json |
| 422 | Esta Idempotency-Key já foi usada com um corpo de requisição diferente. | application/problem+json |
| 500 | Internal Server Error | application/problem+json |
Respostas de erro seguem o Problem Details (RFC 9457): trate pelo campo code e consulte o catálogo de erros.
Exemplo
curl -X PUT "https://api-payments.sand-fintech.com/v2/payment/reverse" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d @corpo.json