Get Bolepix by ID
Get Bolepix by ID
GET {{Environment_URL}}/vendors/v1/charges/:id
Retrieves a bolepix by its ID
Headers
Name
Value
Authorization
Bearer <token>
Path Params
Name
Type
Description
Value
id
string
Charge Identifier
ch_01jzjm23f39dpm5hf94q2rhjhj
Response
{
"id": "ch_01jzjm23f39dpm5hf94q2rhjhj",
"amount": 10000,
"currency": "USD",
"metadata": null,
"contacts": {
"emails": [
"[email protected]"
],
"phones": [
"+5511982435422"
]
},
"quotation": {
"id": "4168c7727f5bc2c3707bc0bb3a6cd0c16061bb34",
"tax": {
"iof": {
"total": {
"value": 192,
"divisor": 100,
"currency": "BRL",
"precision": 2
},
"percentage": 0.38
}
},
"total": {
"withTax": {
"value": 50846,
"divisor": 100,
"currency": "BRL",
"precision": 2
},
"withoutTax": {
"value": 50653,
"divisor": 100,
"currency": "BRL",
"precision": 2
},
"withFutureTax": {
"value": 50846,
"divisor": 100,
"currency": "BRL",
"precision": 2
},
"withoutSpread": {
"value": 49660,
"divisor": 100,
"currency": "BRL",
"precision": 2
},
"withTaxesAndFees": {
"value": 50846,
"divisor": 100,
"currency": "BRL",
"precision": 2
}
},
"currency": {
"code": "USD",
"fees": [
{
"name": "FEE_FC",
"type": "absolute",
"value": 0,
"netValue": {
"value": 0,
"divisor": 100,
"currency": "BRL",
"precision": 2
},
"receiver": "PLATFORM_FEE"
},
{
"name": "FEE_VENDOR",
"type": "absolute",
"value": 0,
"netValue": {
"value": 0,
"divisor": 100,
"currency": "BRL",
"precision": 2
},
"receiver": "VENDOR_FEE"
}
],
"name": "Dólar Americano",
"offer": {
"value": 10000,
"divisor": 100,
"currency": "USD",
"precision": 2
},
"price": {
"withTax": {
"value": 50846,
"divisor": 10000,
"currency": "BRL",
"precision": 4
},
"withoutTax": {
"value": 50653,
"divisor": 10000,
"currency": "BRL",
"precision": 4
},
"withFutureTax": {
"value": 50846,
"divisor": 10000,
"currency": "BRL",
"precision": 4
},
"withoutSpread": {
"value": 49660,
"divisor": 10000,
"currency": "BRL",
"precision": 4
},
"withTaxesAndFees": {
"value": 50846,
"divisor": 10000,
"currency": "BRL",
"precision": 4
}
},
"spreads": [
{
"name": "SPREAD_FC",
"type": "percentage",
"netValue": {
"value": 497,
"divisor": 100,
"currency": "BRL",
"precision": 2
},
"receiver": "PLATFORM_FEE",
"percentage": 1
},
{
"name": "SPREAD_VENDOR",
"type": "percentage",
"netValue": {
"value": 497,
"divisor": 100,
"currency": "BRL",
"precision": 2
},
"receiver": "VENDOR_FEE",
"percentage": 1
}
],
"offerUSD": {
"value": 10000,
"divisor": 100,
"currency": "USD",
"precision": 2
},
"levelingRate": {
"value": 49660,
"divisor": 10000,
"currency": "BRL",
"precision": 4
},
"countryFlagUrl": "https://s3.amazonaws.com/simple-exchanges-demo/new-flags/united-states.svg",
"commercialExchangeRate": {
"value": 49660,
"divisor": 10000,
"currency": "BRL",
"precision": 4,
"updatedAt": "2023-08-14T20:08:25.000Z"
}
},
"metadata": {
"type": "BOLEPIX",
"externalId": "vnd_01jq4aderxhyhvzgsvfs4sz9y3"
},
"createdAt": "2025-07-07T14:15:19.358Z",
"futureTax": {
"ir": {
"total": {
"value": 0,
"divisor": 100,
"currency": "BRL",
"precision": 2
},
"percentage": 0
}
}
},
"nature": "SERVICES_AND_OTHERS",
"paymentMethod": "BOLEPIX",
"paymentMethodDetails": {
"payer": {
"city": "São Paulo",
"name": "Gerardo Silva",
"state": "SP",
"zipCode": "04571-010"
},
"billingConfig": {
"dueDate": "2025-08-20T03:00:00.000Z",
"fineDate": "2025-08-26T03:00:00.000Z",
"fineValue": 1,
"interestDate": "2025-08-23T03:00:00.000Z",
"expirationDate": "2025-08-30T03:00:00.000Z",
"interestPercent": 0.01667
}
},
"status": "CREATED",
"createdAt": "2025-07-07T14:18:55.322Z",
"updatedAt": "2025-07-07T14:18:55.322Z",
"vendor": {
"id": "vnd_01jq4aderxhyhvzgsvfs4sz9y3",
"businessType": "INDIVIDUAL",
"businessClass": [
"PSP"
],
"name": "KAINAN WAR",
"vendorResponsiblePhone": "+5511966263413",
"commercialPhone": "+5511966263413",
"fullNameResponsible": "Kainan Guerra Silva",
"address": {
"city": "SAO PAULO",
"state": "SP",
"street": "Av Bento Gil de Oliveira 22",
"country": "br",
"latitude": "10283123",
"longitude": "12323091832",
"neighborhood": "ITAIM PAULISTA",
"openingHours": "123"
},
"email": "[email protected]",
"metadata": {
"additionalInformation[0].field": "",
"additionalInformation[0].value": ""
},
"controller": {},
"defaultCurrency": "USD",
"natures": [
"SERVICES_AND_OTHERS"
],
"vendorResponsible": {},
"notificationsEmail": "[email protected]",
"commercialEmail": "[email protected]",
"externalAccounts": [
{
"metadata": {
"": ""
},
"id": "ea_01jsm5hxhp8er2q0x829fayayx",
"accountHolderName": "KAINAN WAR",
"accountHolderType": "POUPANCA",
"bankName": "Bank of America",
"country": "US",
"currency": "USD",
"accountHolderNumber": "738409847",
"status": "NEW",
"bankSwift": "USBKUS44XXX",
"bankAbaFed": null,
"bankChips": null,
"type": [
"CHARGE"
]
}
],
"status": "PENDING",
"payoutsEnabled": true,
"settings": {
"broker": "FRENTE",
"products": [
"PAYMENT_LINK",
"PAY_WITH_PIX",
"BOLEPIX"
],
"withdrawal": {
"balance": false,
"currency": "USD",
"withdraw": false
},
"releaseBatch": "backoffice",
"maxValueSimplePay": 30000
},
"createdAt": "2025-03-24T14:55:24.927Z",
"updatedAt": "2025-07-02T17:52:53.232Z",
"financialData": {
"bankPath": [
{
"bankPath": "MATERA"
}
],
"vendorBankDetails": {},
"metaData": [
{
"field": "",
"value": ""
}
]
},
"agentId": "42",
"logo": "https://simple-pay-vendors-demo.s3.amazonaws.com/logos/kainan_war/1742828121489.png",
"minimumValueForFinanceBatch": 200000
},
"account": {
"metadata": null,
"id": "acc_01jq4adx4ccggkz20kx21mev39",
"chargesEnable": true,
"loginEnable": true,
"provider": null,
"providerId": null,
"accountNumber": null,
"bankNumber": null,
"agencyNumber": null,
"defaultPix": null,
"externalAccounts": [],
"vendor": {
"id": "vnd_01jq4aderxhyhvzgsvfs4sz9y3",
"name": "KAINAN WAR",
"logo": "https://simple-pay-vendors-demo.s3.amazonaws.com/logos/kainan_war/1742828121489.png",
"commercialPhone": "+5511966263413",
"address": {
"city": "SAO PAULO",
"state": "SP",
"street": "Av Bento Gil de Oliveira 22",
"country": "br",
"latitude": "10283123",
"longitude": "12323091832",
"neighborhood": "ITAIM PAULISTA",
"openingHours": "123"
}
},
"externalId": null,
"status": "PENDING",
"name": "General Subvendor",
"logo": null,
"address": null,
"contact": null,
"type": "ADMINISTRATOR"
},
"creditFinancial": null,
"debitFinancial": null,
"fsmEvents": null,
"transaction": {
"id": "tnx_01jzjm23fhhkx5kz3vcnewhmjf",
"amount": 50846,
"currency": "BRL",
"description": null,
"destination": null,
"metadata": null,
"qrCodeUrl": null,
"dynamicPixCode": null,
"createdAt": "2025-07-07T14:18:55.322Z",
"updatedAt": "2025-07-07T14:18:55.322Z",
"bolepixUrl": null,
"barCode": null,
"refund": {},
"paymentDetails": {
"payerName": "Gerardo Silva",
"payerDocument": "417.070.540-88",
"method": "BOLEPIX"
}
},
"paymentLink": null,
"expire": 2711,
"expiredAt": "2025-07-07T16:18:55.324Z"
}