Template de Webhooks
O produto cel_card faz o gerenciamento das seguintes entidades e webhooks:
Entidade | Mensagem |
---|---|
account-created | Cadastro da Conta para emissão de cartões |
card-created | Cartão emitido para uma conta |
network-authorization | Status de uma autorização de transação. |
card-in-transit | Status do rastreio de um cartão físico. |
Templates
Quando as informações de um cliente são inseridas no nosso ambiente no processo de onboarding, realizamos todos os processos internos para a emissão de cartões.
Quando uma conta é criada com sucesso disparamos o seguinte webhook na entidade account-created:
{
"accountId":78,
"baasAccountId":"300001223332",
"programId":16,
"accountType":"PHYSICAL",
"currencyCode":"986",
"accountStatusId":9,
"createdAt":"2024-08-07 00:00:00"
}
Significado dos objetos enviados no webhook
Objeto | Tipo | Significado do Objeto |
---|---|---|
accountId | int | Id único gerado para a conta |
baasAccountId | string | Número da conta no Baas |
programId | int | Id do programa utilizado para criação desta conta |
accountType | string(10) | Tipo da conta: PHYSICAL ou VIRTUAL. Por padrão toda as contas são criadas como PHYSICAL. |
currencyCode | string(3) | Indica qual moeda vai ser utilizada para transações nesta conta |
accountStatusId | int | indica em que status a conta se encontra |
createdAt | datetime | Data e hora da criação da conta |
Quando um cartão é emitido corretamente disparamos o seguinte webhook na entidade card-created:
{
"clientRequestId":20,
"clientDocument":"33999999999",
"cardId":65,
"cardHash":"CdOhJpw0OFWEpgj1+IZ5FkPCAnvKlPu9nIKmuaJ1ug8bkjb1cAD0s9xe7Ib1w/wgB9cE5ygmOzmiFWEgja47lw==",
"operationType":"issue_card"
}
Significado dos objetos enviados no webhook
Objeto | Tipo | Significado do Objeto |
---|---|---|
clientDocument | string | Documento do cliente (CPF ou CNPJ) |
cardId | int | Id gerado automaticamente para identificação do cartão |
cardHash | string (100) | Hash de criptografia do cartão |
operationType | string (20) | issue_card indica emissão do cartão, reissue_card indica que é a remissão do cartão |
Quando uma autorização for solicitada ao cartão, disparamos o seguinte webhook:
Exemplo de autorização de transação aprovada.
{
"accountId": 51,
"cardId": 224,
"authorizationCode": "ZYD001",
"amount": "0",
"currencyCode": "900",
"merchantCity": "SAO PAULO",
"cardNotPresent": false,
"type": "PURCHASE",
"status": "APPROVED",
"internationalAuthorization": false,
"dateTimeAuthorization": "2024-10-16T15:28:17",
"entity": "network-authorization",
"webhookId": "ab0cae4df54d04b7b8b66ecaa1943477d"
}
Exemplo de autorização de transação negada.
{
"accountId": 51,
"cardId": 224,
"authorizationCode": "ZYD001",
"amount": "0",
"currencyCode": "900",
"merchantCity": "SAO PAULO",
"cardNotPresent": false,
"type": "CANCELLATION",
"status": "APPROVED",
"internationalAuthorization": false,
"dateTimeAuthorization": "2024-10-16T15:28:17",
"entity": "network-authorization",
"webhookId": "7a0fb46754a348548a614a41fe6889a8"
}
Significado dos objetos enviados no webhook
Objeto | Tipo | Significado do Objeto |
---|---|---|
account_id | int | Indica o id da conta que houve a autorização. |
card_id | int | indica o id cartão que houve a autorização. |
authorizationCode | string | Código identificador da autorização. |
amount | int | Valor total da autorização. |
currencyCode | string(3) | Moeda na qual a autorização foi realizada. |
merchantCity | string | Cidade em que a autorização foi realizada. - Informação controlada pela bandeira, não sendo obrigatório o envio na autorização. |
cardNotPresent | boolean | Indica que se a transação foi realizada através do preenchimento dos dados do cartão. |
type | string | Tipo da transação (exemplo: PURCHASE, CANCELLATION, INSTALLMENT WITHOUT INTEREST) |
status | string | Indica se a autorização foi aprovada ou negada. |
internationalAuthorization | boolean | Indica se é autorização de transação internacional. |
dateTimeAuthorization | datetime | Data e hora da solicitação da autorização. |
entity | string | Entidade do webhook. |
webhookId | string | Código identificador do webhook enviado. |
Updated 16 days ago