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

Conta criada:

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

Cartão criado

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

Autorização de Transaçã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",
	"merchantName": "UBER SHOPPER STATEMENT",	
  "cardNotPresent": false,
  "type": "COMPRA",
  "status": "APPROVED",
  "internationalAuthorization": false,
  "dateTimeAuthorization": "2024-10-16T15:28:17",
  "binType": "CREDIT",
  "programId": 12,
  "entity": "network-authorization",
  "webhookId": "ab0cae4df54d04b7b8b66ecaa1943477d"
}

Exemplo de autorização de transação negada.

{
      "accountId": 50,
      "cardId": 224,
      "authorizationCode": "ZED001",
      "amount": "0",
      "currencyCode": "986",
      "merchantCity": "SAO PAULO",
      "merchantName": "UBER SHOPPER STATEMENT",
      "cardNotPresent": false,
      "type": "COMPRA",
      "status": "REFUSED",
      "internationalAuthorization": false,
      "dateTimeAuthorization": "2024-10-16T15:28:17",
      "binType": "CREDIT",
      "programId": 12,
      "reason": "INVALID_ACCOUNT",
      "reasonDescription": "Invalid account"
			"webhookId": "ab0cae4df54d04b7b8b66ecaa1943479d"
}

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. Retorna APPROVED ou REFUSED.
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.

Cartão em fluxo de entrega:

Quando o cartão for entregue ao serviço de courier responsável pela entrega, será enviado o webhook de card-in-transit a cada atualização de rastreamento do cartão.

Exemplo de payload do webhook:

{
  "data": {
    "type": "card-in-transit",
    "tenant_name": "ba_cartoes",
    "body": {
      "programId": "55",
      "accountId": "11914",
      "customerId": "11917",
      "cardId": "17151",
      "customerDocument": "36417635090",
      "cardLastDigits": "0699",
      "cardTrackingCode": "BRL00117151FL",
      "occurrenceDate": "2026-01-15 16:30:00",
      "externalEventId": "1100",
      "eventDescription": "Em arquivo-aguardando Postagem",
      "deliveryStatusId": "1",
      "deliveryStatusDescription": "Arquivo Aguardando Postagem",
      "collectionDate": null,
      "postingDate": "2026-01-15 13:30:00",
      "slaDate": null,
      "dischargeDate": null,
      "entity": "card-in-transit"
    }
  },
  "metadata": {
    "timestamp": "2026-01-29T19:53:02+00:00",
    "messageType": "webhook"
  }
}

Objeto	Tipo	Significado do Objeto
programId	int	Programa em que a conta se encontra.
accountId	int	Conta a qual o cartão pertence.
customer_id	int	indica o id cartão que houve a autorização.
cardId	int	Id do cartão.
customerDocument	string	Documento do titular do cartão.
cardLastDigits	string	4 últimos dígitos do cartão.
cardTrackingCode	string	Código de rastreio do cartão.
occurrenceDate	dateTime	Data que o evento aconteceu.
externalEventId	int	Id dos eventos de rastreio.
eventDescription	string	Descrição dos eventos de rastreio com base no id.
deliveryStatusId	int	Id de status de entrega do cartão.
deliveryStatusDescription	string	Descrição do status.
collectionDate	dateTime	Data da coleta do cartão pela entregadora.
slaDate	dateTime	Data prevista de entrega do cartão.
dischargeDate	dateTime	Data efetiva da entrega do cartão. Em caso de atraso na entrega será diferente do slaDate.

Updated 15 days ago