Skip to main content
POST
/
charge
/
refund
/
{id}
Extornar cobrança
curl --request POST \
  --url https://api.aobapay.com/v1/charge/refund/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 123,
  "comment": "<string>"
}
'
{
  "error": "<unknown>",
  "status": 200,
  "data": {
    "id": "ch_123456",
    "externalID": "pedido-123",
    "amount": 200,
    "comment": "Se arrependeu ;("
  }
}

Authorizations

Authorization
string
header
required

Cabeçalho de autenticação Bearer no formato Bearer <aobapay-api-key> onde <aobapay-api-key> é a sua chave de API.

Path Parameters

id
required

Id da cobrança pode ser o (externalID ou ChargeId)

Example:

"ch_123456"

Body

application/json
amount
number

Valor do extorno em centavos.

comment
string

Comentário sobre o extorno

Maximum string length: 35

Response

Extorno realizado

error
null
status
integer

Código de status HTTP.

Example:

200

data
object

Dados do extorno.