Request
| Environment | Method | Endpoint |
|---|---|---|
| Sandbox | put | https://apisandbox.braspag.com.br/v2/sales/{PaymentId}/void |
| Production | put | https://api.braspag.com.br/v2/sales/{PaymentId}/void |
{
"VoidSplitPayments":[
{
"SubordinateMerchantId":"94e5ea52-79b0-7dba-1867-be7b081edd97",
"VoidedAmount":500
}
]
} Path parameters
| Property | Type | Size | Required | Description |
|---|---|---|---|---|
PaymentId | String | 36 | Yes | Payment identification number. |
Body parameters
| Property | Type | Size | Required | Description |
|---|---|---|---|---|
VoidSplitPayments.SubordinateMerchantId | String | 36 | Yes | Payment identification number. |
VoidSplitPayments.VoidedAmount | String | -- | Yes | Full or partial amount allocated to the seller to be refunded, in cents. |
Response
{
"Status": 11,
"ReasonCode": 0,
"ReasonMessage": "Successful",
"ProviderReturnCode": "0",
"ProviderReturnMessage": "Operation Successful",
"ReturnCode": "0",
"ReturnMessage": "Operation Successful",
"Links": [
{
"Method": "GET",
"Rel": "self",
"Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/sales/019efd18-c69a-4107-b5d7-e86564460cc4"
}
],
"VoidSplitPayments": [
{
"SubordinateMerchantId": "9140ca78-3955-44a5-bd44-793370afef94",
"VoidedAmount": 4000,
"VoidedSplits": [
{
"MerchantId": "9140ca78-3955-44a5-bd44-793370afef94",
"VoidedAmount": 3825
},
{
"MerchantId": "f43fca07-48ec-46b5-8b93-ce79b75a8f63",
"VoidedAmount": 175
}
]
},
{
"SubordinateMerchantId": "f2d6eb34-2c6b-4948-8fff-51facdd2a28f",
"VoidedAmount": 6000,
"VoidedSplits": [
{
"MerchantId": "f2d6eb34-2c6b-4948-8fff-51facdd2a28f",
"VoidedAmount": 5670
},
{
"MerchantId": "f43fca07-48ec-46b5-8b93-ce79b75a8f63",
"VoidedAmount": 330
}
]
}
]
}