Void a credit card payment

To void a Split Payments transaction, the Marketplace must inform, to a partial void, what is the amount to be voided to each transaction participant. To perform a total void, this information is not required, because, in this case, the total amount of each participant will be voided.

Total Void

When performing a total void of a transaction, the total amount of the transaction will be voided and, thereafter, each amount and commission of each participant.

Request

put https://apisandbox.cieloecommerce.cielo.com.br/1/sales/{PaymentId}/void

--header "Authorization: Bearer {access_token}"

Query parameters

Parameter	Description	Size	Type
`PaymentId`	PaymentId returned in the Create a credit card payment response.	36	Text

Response

{
    "Status": 10,
    "ReasonCode": 0,
    "ReasonMessage": "Successful",
    "ProviderReturnCode": "0",
    "ProviderReturnMessage": "Operation Successful",
    "ReturnCode": "0",
    "ReturnMessage": "Operation Successful",
    "VoidSplitPayments": [
        {
            "SubordinateMerchantId": "2b9f5bea-5504-40a0-8ae7-04c154b06b8b",
            "VoidedAmount": 4000,
            "VoidedSplits": [
                {
                    "MerchantId": "2b9f5bea-5504-40a0-8ae7-04c154b06b8b",
                    "VoidedAmount": 3825
                },
                {
                    "MerchantId": "e4db3e1b-985f-4e33-80cf-a19d559f0f60",
                    "VoidedAmount": 175
                }
            ]
        },
        {
            "SubordinateMerchantId": "7c7e5e7b-8a5d-41bf-ad91-b346e077f769",
            "VoidedAmount": 6000,
            "VoidedSplits": [
                {
                    "MerchantId": "7c7e5e7b-8a5d-41bf-ad91-b346e077f769",
                    "VoidedAmount": 5670
                },
                {
                    "MerchantId": "e4db3e1b-985f-4e33-80cf-a19d559f0f60",
                    "VoidedAmount": 330
                }
            ]
        }
    ]
}

Partial Void

In the partial void, the sum of the voided amounts for each subordinate shall be equal to the amount of the partial void.

Request

put https://apisandbox.cieloecommerce.cielo.com.br/1/sales/{PaymentId}/void?amount={amount}

--header "Authorization: Bearer {access_token}"

In the following example the amount to be voided is BRL 25.00 of a transaction with a total amount of BRL 100.00.

put https://apisandbox.cieloecommerce.cielo.com.br/1/sales/{PaymentId}/void?amount=2500

--header "Authorization: Bearer {access_token}"
{
    "VoidSplitPayments":[
        {
            "SubordinateMerchantId": "7c7e5e7b-8a5d-41bf-ad91-b346e077f769",
            "VoidedAmount": 1500
        },
        {
            "SubordinateMerchantId" :"2b9f5bea-5504-40a0-8ae7-04c154b06b8b",
            "VoidedAmount":1000
        }
     ]
}

Property	Description	Type	Size	Required
`VoidSplitPayments.SubordinateMerchantId`	Subordinate MerchantId (Identifier).	Guid	36	Yes
`VoidedAmount.Amount`	Total or part of the Subordinate's amount to be voided, in cents.	Integer	-	Yes

Response

{
    "Status": 2,
    "ReasonCode": 0,
    "ReasonMessage": "Successful",
    "ProviderReturnCode": "0",
    "ProviderReturnMessage": "Operation Successful",
    "ReturnCode": "0",
    "ReturnMessage": "Operation Successful",
    "VoidSplitPayments": [
        {
            "SubordinateMerchantId": "7c7e5e7b-8a5d-41bf-ad91-b346e077f769",
            "VoidedAmount": 1500,
            "VoidedSplits": [
                {
                    "MerchantId": "7c7e5e7b-8a5d-41bf-ad91-b346e077f769",
                    "VoidedAmount": 1417
                },
                {
                    "MerchantId": "e4db3e1b-985f-4e33-80cf-a19d559f0f60",
                    "VoidedAmount": 83
                }
            ]
        },
        {
            "SubordinateMerchantId": "2b9f5bea-5504-40a0-8ae7-04c154b06b8b",
            "VoidedAmount": 1000,
            "VoidedSplits": [
                {
                    "MerchantId": "2b9f5bea-5504-40a0-8ae7-04c154b06b8b",
                    "VoidedAmount": 956
                },
                {
                    "MerchantId": "e4db3e1b-985f-4e33-80cf-a19d559f0f60",
                    "VoidedAmount": 44
                }
            ]
        }
    ]
}

It is not required to inform all Subordinates in the partial void. It is possible to inform only the subordinates that there if the intention to void the total amount ou just a partial amount. In the example before, the second subordinate could be informed, as shown below:

{
    "VoidSplitPayments":[
        {
            "SubordinateMerchantId" :"2b9f5bea-5504-40a0-8ae7-04c154b06b8b",
            "VoidedAmount":1000
        }
     ]
}

By partially voiding the part of a subordinate, the Fixed Fee the Marketplace charges is voided proportionally.