Refund Transaction
Refund Transaction
POST {{envoriment_url}}/vendors/v1/charges/:id/refund
To issue a refund for a specific transaction, the requester must have the Administrator role.
Refunds are only allowed for transactions with status SUCCEEDED, and no more than 120 days may have passed since the date the charge reached this status.
Notes:
1 - The commission generated from this transaction will not be reimbursed.
2 - When refund is requested, the transaction status will be updated to IN_REFUND, when refund is processed, the charge status will be updated to REFUNDED.
Headers
Name
Value
Authorization
Bearer <token>
Path Params
Name
Type
Description
Value
id
string
Charge ID to be refunded
ch_01k7sqga21hj65v1rt7tczjj86
Response
{
"id": "ch_01k7sqga21hj65v1rt7tczjj86",
"amount": 100,
"currency": "USD",
"metadata": null,
"quotation": {
"id": "4e3847ddf74313eeaa368a43faa27bab0067de77",
"metadata": {
"type": "CHARGE",
"externalId": "vnd_01hxy5ycwtgm28cwe460vv801v"
},
"currency": {
"code": "USD",
"fees": [
{
"name": "FEE_FC",
"type": "absolute",
"value": 20,
"netValue": {
"value": 122,
"divisor": 100,
"currency": "BRL",
"precision": 2
},
"receiver": "PLATFORM_FEE"
},
{
"name": "FEE_VENDOR",
"type": "absolute",
"value": 10,
"netValue": {
"value": 61,
"divisor": 100,
"currency": "BRL",
"precision": 2
},
"receiver": "VENDOR_FEE"
},
{
"name": "FEE_VENDOR",
"type": "absolute",
"value": 0,
"netValue": {
"value": 0,
"divisor": 100,
"currency": "BRL",
"precision": 2
},
"receiver": "VENDOR_FEE"
}
],
"name": "Dólar Americano",
"clamp": "MINIMUM",
"offer": {
"value": 100,
"divisor": 100,
"currency": "USD",
"precision": 2
},
"price": {
"withTax": {
"value": 63902,
"divisor": 10000,
"currency": "BRL",
"precision": 4
},
"withoutTax": {
"value": 63902,
"divisor": 10000,
"currency": "BRL",
"precision": 4
},
"withFutureTax": {
"value": 82151,
"divisor": 10000,
"currency": "BRL",
"precision": 4
},
"withoutSpread": {
"value": 60830,
"divisor": 10000,
"currency": "BRL",
"precision": 4
},
"withTaxesAndFees": {
"value": 82151,
"divisor": 10000,
"currency": "BRL",
"precision": 4
}
},
"spreads": [
{
"name": "SPREAD_FC",
"type": "percentage",
"netValue": {
"value": 30,
"divisor": 100,
"currency": "BRL",
"precision": 2
},
"receiver": "PLATFORM_FEE",
"percentage": 5
},
{
"name": "SPREAD_VENDOR",
"type": "percentage",
"netValue": {
"value": 0,
"divisor": 100,
"currency": "BRL",
"precision": 2
},
"receiver": "VENDOR_FEE",
"percentage": 0.05
},
{
"name": "SPREAD_VENDOR",
"type": "percentage",
"netValue": {
"value": 0,
"divisor": 100,
"currency": "BRL",
"precision": 2
},
"receiver": "VENDOR_FEE",
"percentage": 0
}
],
"offerUSD": {
"value": 100,
"divisor": 100,
"currency": "USD",
"precision": 2
},
"levelingRate": {
"value": 60830,
"divisor": 10000,
"currency": "BRL",
"precision": 4
},
"countryFlagUrl": "https://s3.amazonaws.com/simple-exchanges-demo/new-flags/united-states.svg",
"maxValueSimplePay": {
"value": 20000000,
"divisor": 100,
"currency": "USD",
"precision": 2
},
"minValueSimplePay": {
"value": 1,
"divisor": 100,
"currency": "USD",
"precision": 2
},
"commercialExchangeRate": {
"value": 60830,
"divisor": 10000,
"currency": "BRL",
"precision": 4,
"updatedAt": "2023-08-14T20:08:25.000Z"
}
},
"tax": {
"iof": {
"total": {
"value": 0,
"divisor": 100,
"currency": "BRL",
"precision": 2
},
"percentage": 0
}
},
"taxesAndCosts": {
"value": 0,
"divisor": 100,
"currency": "BRL",
"precision": 2
},
"futureTax": {
"ir": {
"total": {
"value": 0,
"divisor": 100,
"currency": "BRL",
"precision": 2
},
"percentage": 0
}
},
"total": {
"withTax": {
"value": 639,
"divisor": 100,
"currency": "BRL",
"precision": 2
},
"withoutTax": {
"value": 639,
"divisor": 100,
"currency": "BRL",
"precision": 2
},
"withFutureTax": {
"value": 822,
"divisor": 100,
"currency": "BRL",
"precision": 2
},
"withoutSpread": {
"value": 608,
"divisor": 100,
"currency": "BRL",
"precision": 2
},
"withTaxesAndFees": {
"value": 822,
"divisor": 100,
"currency": "BRL",
"precision": 2
}
},
"createdAt": "2025-10-17T18:39:18.512Z",
"reward": {
"max": 100,
"min": 1,
"clamp": "NORMAL",
"active": true,
"points": 1,
"partner": "LIVELO",
"interval": 30
}
},
"nature": "SERVICES_AND_OTHERS",
"paymentMethod": "PIX",
"paymentMethodDetails": null,
"status": "IN_REFUND",
"createdAt": "2025-10-17T18:39:22.163Z",
"updatedAt": "2025-10-17T20:50:07.632Z",
"vendor": {
"id": "vnd_01hxy5ycwtgm28cwe460vv801v",
"name": "DUNDER MIFFLIN NY",
"logo": "https://simple-pay-vendors-demo.s3.amazonaws.com/logos/dunder_mifflin_ny/1726752703837.jpeg",
"commercialPhone": "+5544444444444",
"address": {
"city": "NY",
"state": "NY",
"street": "BROOKLYN 1983",
"country": "us",
"latitude": "123",
"longitude": "123",
"neighborhood": "BROOKLYN",
"openingHours": "123"
}
},
"account": {
"metadata": {
"": ""
},
"id": "acc_01k6gqr43v4drpgy8fgbv69y0k",
"chargesEnable": true,
"loginEnable": true,
"provider": null,
"providerId": null,
"accountNumber": null,
"bankNumber": null,
"agencyNumber": null,
"defaultPix": null,
"externalAccounts": [],
"vendor": {
"id": "vnd_01hxy5ycwtgm28cwe460vv801v",
"name": "DUNDER MIFFLIN NY",
"logo": "https://simple-pay-vendors-demo.s3.amazonaws.com/logos/dunder_mifflin_ny/1726752703837.jpeg",
"commercialPhone": "+5544444444444",
"address": {
"city": "NY",
"state": "NY",
"street": "BROOKLYN 1983",
"country": "us",
"latitude": "123",
"longitude": "123",
"neighborhood": "BROOKLYN",
"openingHours": "123"
}
},
"externalId": null,
"status": "PENDING",
"name": "Vicoly Operator",
"logo": null,
"address": null,
"contact": null,
"type": "OPERATOR"
},
"creditFinancial": null,
"treasury": null,
"debitFinancial": null,
"fsmEvents": {
"status": [
{
"to": "PENDING",
"from": "CREATED",
"timestamp": "2025-10-17T18:39:23.179Z",
"transition": "charge"
},
{
"to": "SUCCEEDED",
"from": "PENDING",
"timestamp": "2025-10-17T20:39:23.865Z",
"transition": "success"
},
{
"from": "SUCCEEDED",
"to": "IN_REFUND",
"transition": "initiateRefund",
"timestamp": "2025-10-17T20:50:07.313Z",
"user": "[email protected]"
}
]
},
"expire": 0,
"expiredAt": "2025-10-17T20:39:22.163Z",
"contacts": null
}