Cancelamento

Rota de Cancelamento

Endpoint

POST http://localhost:8000/api/Cancel/

Corpo da requisição

Campo	Tipo	Obrigatório	Descrição
acquirerTransactionKey	string	sim	É o código de autorização gerado pela Stone, tanto para transações aprovadas, como para transações negadas. Este é o valor que será referência para identificar uma transação na Stone. Também é conhecido como ATK, StoneID ou NSU Host
amount	number	sim	Valor da transação que será cancelada.
transactionType	string	não	é o tipo de transação que foi utilizado para realizar a compra.
panMask	string	não	Nesse campo serve para ser informado o valor do Pan Mascarado do cartão do cliente, que foi utilizado na transação. Esse valor é importante para o AutoTEF validar se a transação que está sendo cancelada, está sendo feita com mesmo cartão que foi utilizado na origem da transação.
splits	array de object	não
splits.amount	integer	sim	Valor destinado ao recebedor. (não utilize casas decimais, multiplique por 100 para obter valores inteiros)
splits.splitType	string	sim	Tipo de divisão. Os valores possíveis são flat ou percentage.
splits.recipientIdentification	string	sim	Código do recebedor. Formato: rp_XXXXXXXXXXXXXXXX.
splits.changeProcessingFee	boolean	sim	Indica se o recebedor vinculado à regra será cobrado pelas taxas da transação
splits.chargeRemainderFee	boolean	sim	Indica se o recebedor vinculado à regra irá receber o restante dos recebíveis após uma divisão.
splits.liable	boolean	sim	Indica se o recebedor é responsável pela transação em caso de chargeback.

Os campos transactionType e panMask é obrigatório somente para cancelamentos em PDVs

Splits

O campo splits deve ser implementado apenas após a realização de todos os acordos e configurações necessários com seu BizDev (Account Manager). Vale ressaltar que cancelamentos totais não requerem essa configuração.

Armazenando dados da transação (Somente PDVs)

É fundamental que os dados da transação (acquirerTransactionKey, amount, transactionType, panMask e splits ) sejam armazenados em um banco de dados, garantindo sua disponibilidade para uso posterior nessa rota.

O retorno dessa rota para implementação que NÂO são PDVs será apenas um Status Code 200!

Para autosserviços e similares, essa rota deve ser utilizada como uma forma de estorno em situações de falha mecânica ou qualquer outro motivo que impeça o cliente de receber o produto da automação.

Jornada: Cobrar com cartão e Pix
Etapa 4 de 10

Etapa anteriorAutorização: Split Próxima etapaCancelamento: Definição dos campos