A entidade Cancellation representa as informações pertinentes ao cancelamento de uma ordem, seja ela de Pix ou de Boleto. Informações sobre o status atual do cancelamento, assim como o timestamp da ocorrência de cada evento responsável pela atualização do status. O motivo da recusa está associado ao fluxo de cancelamento negado, onde temos a requisição de cancelamento de uma ordem, negada pelo provider: StoneOpenBanking.
Objeto
{
"id": "jpxyxa42fvfg416vgzvraydn3",
"orderId": "jqgxmdguyrch5p9bc29q2qvq4",
"status": "Requested",
"requestedAt": "2022-02-25T10:57:03Z",
"acceptedAt": "2022-02-25T11:57:03Z",
"deniedAt": "2022-02-25T11:57:03Z",
"DenyReason": "Deny reason!"
}
Campos
| Campo | Descrição | Tipo de Dado |
|---|---|---|
id | Identificador do cancelamento | string |
orderId | Identificador da Ordem | string |
status | Status do cancelamento | string |
requestedAt | Data e hora da requisição do cancelamento | dateTime ("yyyy-MM-ddTHH:mm:ss") |
acceptedAt | Data e hora do aceite do cancelamento | dateTime ("yyyy-MM-ddTHH:mm:ss") |
deniedAt | Data e hora da negação do cancelamento | dateTime ("yyyy-MM-ddTHH:mm:ss") |
DenyReason | Motivos que levaram a negação do cancelamento | string |
Estados
| Nome | Descrição |
|---|---|
Requested | Uma solicitação de cancelamento |
Accepted | A solicitação de cancelamento foi processada positivamente |
Denied | A solicitação de cancelamento foi processada e rejeitada |
Stream de Dados
Contrato de Streaming dos Dados
Veja Streaming de dados
{
"Stream": {
"Content": [
{
"Data": [
{
"Id": "jqh1a5f3x65dbzs61j4gqf1ra",
"OrderId": "jqh1a4xhd79sfm5ympsckpe7v",
"Status": "Accepted",
"GeneratedAt": "2022-03-07T14:45:23.1889492Z",
"GeneratedBy": "stone-openbank",
"RequestedAt": "2022-03-07T14:45:23.174524Z",
"AcceptedAt": "2022-03-07T14:45:23.174524Z",
"DeniedAt": null,
"DenyReason": null,
"LastUpdatedAt": "2022-03-07T14:45:23.1889492Z",
"Version": 0,
"StreamDate": "2022-03-07T14:45:23.8327613Z"
}
],
"SchemaName": "order-cancellation",
"SchemaVersion": 1
}
]
},
"Timestamp": "2022-03-07T14:45:23.8327748Z",
"CommandKey": "jqh1a5fa66esd8thb7qt6pugy",
"SessionKey": "jqh1a4xhd79sfm5ympsckpe7v",
"ChannelKey": "DefaultNotificationsChannel",
"IdempotencyKey": "jqh1a5dvcst13zxayxf18r2mh",
"SagaProcessKey": "jqh1a5ck6awkgj4skc8cg1ss6",
"BatchProcessKey": null,
"Result": {},
"Id": "jqh1a4xhd79sfm5ympsckpe7v",
"ApplicationKey": "stone-openbank",
"UserEmail": null,
"ValidationResult": null
}
Tipos de Eventos e Ações
| Tipo de evento | Ação |
|---|---|
Order | CancellationRequested |
Order | CancellationAccepted |
Order | CancellationDenied |