Cancelar valor parcial

No cancelamento parcial, a soma dos valores cancelados definidos para cada seller deve ser igual ao valor do cancelamento parcial.

Requisição

Ambiente	Método	Endpoint
Sandbox	put	`https://apisandbox.cieloecommerce.cielo.com.br/1/sales/{PaymentId}/void?amount={amount}`
Produção	put	`https://api.cieloecommerce.cielo.com.br/1/sales/{PaymentId}/void?amount={amount}`

--header "Authorization: Bearer {access_token}"

O exemplo abaixo cancela R$25,00 (amount=2500) de uma transação capturada em R$100,00, distribuindo R$15,00 para o primeiro seller e R$10,00 para o segundo. A soma dos VoidedAmount (1500 + 1000) deve sempre ser igual ao amount informado na query.

curl --request PUT \
  --url "https://apisandbox.cieloecommerce.cielo.com.br/1/sales/{PaymentId}/void?amount=2500" \
  --header "Authorization: Bearer {access_token}" \
  --header "Content-Type: application/json" \
  --data '{
    "VoidSplitPayments": [
      {
        "SubordinateMerchantId": "f2d6eb34-2c6b-4948-8fff-51facdd2a28f",
        "VoidedAmount": 1500
      },
      {
        "SubordinateMerchantId": "9140ca78-3955-44a5-bd44-793370afef94",
        "VoidedAmount": 1000
      }
    ]
  }'

Parâmetros no header

Propriedade	Tipo	Tamanho	Obrigatório	Descrição
Authorization Bearer:`access_token`	String	--	Sim	Token de acesso. Informe o `access_token` obtido para a autenticação OAuth2

Parâmetros no path

Propriedade	Tipo	Tamanho	Obrigatório	Descrição
`PaymentId`	String	36	Sim	Número de identificação do pagamento.

Parâmetros no query

Propriedade	Tipo	Tamanho	Obrigatório	Descrição
`Amount`	Integer	--	Sim	Valor a ser cancelado, em centavos.

Parâmetros no body

Propriedade	Descrição	Tipo	Tamanho	Obrigatório
`VoidSplitPayments.SubordinateMerchantId`	MerchantId (identificador) do seller.	Guid	36	Sim
`VoidedAmount.Amount`	Total ou parte do valor destinado ao seller a ser cancelado, em centavos.	Integer	-	Sim

Resposta

{
    "Status": 2,
    "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/c10ee5e5-6179-424c-bbf2-1a2319a8f7c3"
        },
        {
            "Method": "PUT",
            "Rel": "void",
            "Href": "https://apisandbox.cieloecommerce.cielo.com.br/1/sales/c10ee5e5-6179-424c-bbf2-1a2319a8f7c3/void"
        }
    ],
    "VoidSplitPayments": [
        {
            "SubordinateMerchantId": "f2d6eb34-2c6b-4948-8fff-51facdd2a28f",
            "VoidedAmount": 1500,
            "VoidedSplits": [
                {
                    "MerchantId": "f2d6eb34-2c6b-4948-8fff-51facdd2a28f",
                    "VoidedAmount": 1417
                },
                {
                    "MerchantId": "f43fca07-48ec-46b5-8b93-ce79b75a8f63",
                    "VoidedAmount": 83
                }
            ]
        },
        {
            "SubordinateMerchantId": "9140ca78-3955-44a5-bd44-793370afef94",
            "VoidedAmount": 1000,
            "VoidedSplits": [
                {
                    "MerchantId": "9140ca78-3955-44a5-bd44-793370afef94",
                    "VoidedAmount": 956
                },
                {
                    "MerchantId": "f43fca07-48ec-46b5-8b93-ce79b75a8f63",
                    "VoidedAmount": 44
                }
            ]
        }
    ]
}

Não é obrigatório informar todos os sellers no cancelamento parcial. Você pode informar apenas os sellers para os quais deseja cancelar totalmente ou cancelar parte do valor destinado a cada um na transação, conforme exemplo a seguir:

{
    "VoidSplitPayments":[
        {
            "SubordinateMerchantId" :"9140ca78-3955-44a5-bd44-793370afef94",
            "VoidedAmount":1000
        }
     ]
}

Ao cancelar parcialmente parte de um valor destinado a um seller, a Tarifa Fixa que o master tem a receber também é cancelada proporcionalmente.