Gates2b

Reembolsar invoice

Devolve ao pagador o valor total ou parcial de uma invoice paga do recurso legado /invoices.

POST
/refunds/invoice/{invoiceId}

Authorization

apiKey
headerAuthorizationBearer <token>

Chave de API gerada no painel: Authorization: Bearer <chave>.

Path Parameters

invoiceId*integer

Id numérico da invoice.

Request Body

application/json
  1. body
value?number

Valor a reembolsar em reais, como número (50.00). Omitido, reembolsa o valor total da invoice.

Intervalo0 < value
reason?string

Motivo, para o seu controle.

Response Body

Reembolso processado.

application/json
  1. response
id?string

Id do reembolso.

Formatouuid
status?string

PROCESSED quando o reembolso foi feito.

Valores aceitos"PENDING""REQUESTED""REFUND_IN_PROGRESS""PROCESSED""FAILED"
amount?number

Valor reembolsado em reais.

reason?|

O motivo enviado.

transaction_id?string

Identificador da transação da invoice.

external_refund_id?|

Comprovante do reembolso no processador, quando informado.

gateway?|

Identificador interno de quem processou. Não use em regra de negócio.

invoice?

A invoice reembolsada, já com o status Reembolso solicitado.

user?

Conta dona da invoice.

createdAt?string

Criação.

Formatodate-time
updatedAt?string

Última alteração.

Formatodate-time
Example Request
curl -X POST 'https://api.gates2b.com/refunds/invoice/0' \  -H 'Content-Type: application/json' \  -d '{  "value": 50,  "reason": "Produto com defeito"}'
Example Response
{  "id": "7d3f1e2a-9b8c-4d6e-a5f4-3c2b1a0e9d8c",  "gateway": null,  "transaction_id": "70e451d6aa994cfb96229e5b74933540",  "amount": 50,  "description": null,  "status": "PROCESSED",  "external_refund_id": "",  "reason": "Produto com defeito",  "invoice": {    "id": 72276,    "amount": 120,    "amount_final": 115.2,    "status": "Reembolso solicitado",    "transaction_pix_id": "70e451d6aa994cfb96229e5b74933540",    "external_reference": "pedido-0099",    "user": {      "id": 456    }  },  "user": {    "id": 456,    "username": "Loja Exemplo",    "email": "financeiro@example.com"  },  "createdAt": "2026-10-22T14:30:15.123Z",  "updatedAt": "2026-10-22T14:30:15.456Z"}

Este endpoint vale só para invoices, criadas pelo recurso legado. Para cobranças de /charge, use Reembolsar cobrança.

Regras

  • value é número em reais (50.00), diferente do reembolso de cobrança, que usa string.
  • A invoice precisa estar paga e ter sido criada há no máximo 7 dias. Fora disso, a resposta é 400.
  • Sem value, o reembolso é do valor total da invoice. Um value maior que o da invoice responde 400.
  • O valor sai do seu saldo. Se o saldo não cobrir, a resposta é 400.
  • Um segundo pedido para a mesma invoice em menos de 60 segundos é recusado com 400. Espere a resposta do primeiro antes de repetir.
  • status: "PROCESSED" na resposta significa reembolso feito; a invoice passa a Reembolso solicitado.

Nesta página