Charge Example
Charge Events
Event
Description
charge.canceled
Triggered when a charge is canceled.
charge.created
Triggered when a new charge is created.
charge.expired
Triggered when a charge expires before completion.
charge.failed
Triggered when a charge attempt fails.
charge.pending
Triggered when a charge is pending confirmation.
charge.refunded
Triggered when a charge is refunded.
charge.succeeded
Triggered when a charge is succeeded.
Event example
{
"metadata": null,
"id": "evt_01mpxru3t9qyl507hazjqdk8nb",
"type": "charge.pending",
"data": {
"id": "ch_01kbfja7e7xre285ftsxtwy4vs",
"amount": 2000,
"currency": "USD",
"metadata": {
"comments": "Test"
},
"quotation": {
"id": "mt3rq3t8r03636qm6qtmm53076zq368rq880845z",
"metadata": {
"type": "CHARGE",
"externalId": "vnd_01mpxqutn8zrlhje6dqwa417kv"
},
"currency": {
"code": "USD",
"name": "Dólar Americano",
"commercialExchangeRate": {
"value": 53526,
"divisor": 10000,
"currency": "BRL",
"precision": 4,
"updatedAt": "2023-08-14T20:08:25.000Z"
},
"countryFlagUrl": "https://flags/united-states.svg",
"levelingRate": {
"value": 53526,
"divisor": 10000,
"currency": "BRL",
"precision": 4
},
"maxValueSimplePay": {
"value": 20000000,
"divisor": 100,
"currency": "USD",
"precision": 2
},
"minValueSimplePay": {
"value": 100,
"divisor": 100,
"currency": "USD",
"precision": 2
},
"clamp": "NORMAL",
"offer": {
"value": 2000,
"divisor": 100,
"currency": "USD",
"precision": 2
},
"offerUSD": {
"value": 2000,
"divisor": 100,
"currency": "USD",
"precision": 2
},
"price": {
"withoutSpread": {
"value": 53526,
"divisor": 10000,
"currency": "BRL",
"precision": 4
},
"withoutTax": {
"value": 55132,
"divisor": 10000,
"currency": "BRL",
"precision": 4
},
"withTax": {
"value": 57061,
"divisor": 10000,
"currency": "BRL",
"precision": 4
},
"withTaxesAndFees": {
"value": 57061,
"divisor": 10000,
"currency": "BRL",
"precision": 4
},
"withFutureTax": {
"value": 57061,
"divisor": 10000,
"currency": "BRL",
"precision": 4
}
},
"spreads": [
{
"name": "SPREAD_FC",
"type": "percentage",
"percentage": 2,
"receiver": "PLATFORM_FEE",
"netValue": {
"value": 214,
"divisor": 100,
"currency": "BRL",
"precision": 2
}
},
{
"name": "SPREAD_VENDOR",
"type": "percentage",
"percentage": 1,
"receiver": "VENDOR_FEE",
"netValue": {
"value": 107,
"divisor": 100,
"currency": "BRL",
"precision": 2
}
}
],
"fees": []
},
"tax": {
"iof": {
"percentage": 0,
"total": {
"value": 0,
"divisor": 100,
"currency": "BRL",
"precision": 2
}
}
},
"taxesAndCosts": {
"value": 386,
"divisor": 100,
"currency": "BRL",
"precision": 2
},
"futureTax": {
"ir": {
"percentage": 0,
"total": {
"value": 0,
"divisor": 100,
"currency": "BRL",
"precision": 2
}
}
},
"total": {
"withoutSpread": {
"value": 10705,
"divisor": 100,
"currency": "BRL",
"precision": 2
},
"withoutTax": {
"value": 11026,
"divisor": 100,
"currency": "BRL",
"precision": 2
},
"withTax": {
"value": 11412,
"divisor": 100,
"currency": "BRL",
"precision": 2
},
"withTaxesAndFees": {
"value": 11412,
"divisor": 100,
"currency": "BRL",
"precision": 2
},
"withFutureTax": {
"value": 11412,
"divisor": 100,
"currency": "BRL",
"precision": 2
}
},
"createdAt": "2025-12-02T12:58:54.738Z",
"reward": {
"points": 0,
"active": false,
"clamp": "MINIMUM",
"interval": 0,
"min": 0,
"max": 0,
"partner": "N/A"
}
},
"nature": "SERVICES_AND_OTHERS",
"paymentMethod": "PIX",
"billingMethod": "INSTANT_PAYMENT",
"paymentMethodDetails": null,
"status": "PENDING",
"createdAt": "2025-12-02T12:59:00.936Z",
"updatedAt": "2025-12-02T12:59:00.936Z",
"vendor": {
"id": "vnd_01mpxqutn8zrlhje6dqwa417kv",
"name": "Vendor API",
"logo": "{{url}}.png",
"commercialPhone": "+5511999999999",
"address": {
"city": "Roma",
"state": "RM (ROMA)",
"street": "Via Guglielmo Pepe 43",
"country": "it",
"latitude": "41.8900",
"longitude": "12.5200",
"neighborhood": "Prenestino-Labicano",
"openingHours": "24/7"
}
},
"account": {
"metadata": {
"": ""
},
"id": "acc_01k5c00v2gsnjsn3gskzg100kr",
"chargesEnable": true,
"enableSpreadFeeEdit": false,
"loginEnable": true,
"provider": null,
"providerId": null,
"accountNumber": null,
"bankNumber": null,
"agencyNumber": null,
"defaultPix": null,
"externalAccounts": [],
"vendor": {
"id": "vnd_01mpxqutn8zrlhje6dqwa417kv",
"name": "Vendor API",
"logo": "{{url}}.png",
"commercialPhone": "+5511985903147",
"address": {
"city": "Roma",
"state": "RM (ROMA)",
"street": "Via Guglielmo Pepe 43",
"country": "it",
"latitude": "41.8900",
"longitude": "12.5200",
"neighborhood": "Prenestino-Labicano",
"openingHours": "24/7"
}
},
"externalId": null,
"status": "PENDING",
"name": "John Doe",
"logo": null,
"address": null,
"contact": null,
"type": "ADMINISTRATOR"
},
"creditFinancial": null,
"treasury": null,
"debitFinancial": null,
"fsmEvents": {
"status": [
{
"from": "CREATED",
"to": "PENDING",
"transition": "charge",
"timestamp": "2025-12-02T12:59:02.851Z"
}
]
},
"expire": 7198,
"expiredAt": "2025-12-02T14:59:00.937Z",
"contacts": null
},
"createdAt": "2025-12-02T12:59:02.980Z"
}