Emissão de cartão

O evento de emissão de cartão dispara uma mensagem que comunica ao destinatário quando o cartão é emitido.

Como esses eventos chegam ao recebedor via webhook, é preciso realizar previamente a sua configuração.

Contexto e nome do evento

No evento de emissão de cartão, o campo context sempre informará “Card”, e o campo name será descrito conforme a tabela a seguir:

EntityId

O campo entityId é o identificador da entidade emissora do evento e seu valor depende do contexto de sua emissão.

No contexto de cartão, o entityId é o proxy do cartão.

Exemplo de evento

{
  "idempotencyKey": "0c908f19-6a3e-4a0b-90aa-606d9a659dfb",
  "context": "Card",
  "name": "CARD_WAS_ISSUED",
  "timestamp": "2022-04-25T12:27:24.1773777Z",
  "entityId": "2500441005128861608",
  "companyKey": "COMPANY_KEY",
  "correlationId": "496b8b38-c956-415a-8668-c21cd146285b",
  "metadata": {
    "created": "2022-04-25T12:27:04.294+00:00"
  },
  "data": {
    "proxy": "0000000000000000000",
    "activateCode": "A49000000095",
    "alias": "0422",
    "name": "Tony Stark",
    "program": {
      "id": "53",
      "name": "COMPANY_KEY - Virtual",
      "type": "VirtualPre"
    },
    "lastFourDigits": "0000",
    "cardType": "Virtual",
    "status": "Active",
    "function": "Pre",
    "allowContactless": true,
    "address": {
      "zipCode": "05037001",
      "addressLine": "Rua Teste",
      "number": "123",
      "neighborhood": "Sé",
      "complement": "Apartamento",
      "city": "São Paulo",
      "state": "SP",
      "country": "BR"
    },
    "holder": {
      "document": {
        "value": "12345678901",
        "type": "CPF"
      },
      "name": "Tony Stark",
      "account": {
        "branch": "0001",
        "number": "123456"
      }
    }
  }
}

🚧

Importante

Para conhecer a estrutura básica dos eventos com os campos que chegarão à sua API, consulte nossa documentação específica de Eventos.

Objeto data no evento de emissão de cartão

O objeto data traz detalhes específicos do contexto em que o evento ocorre. No caso do evento de emissão de cartão, esse objeto trará os seguintes campos:

• proxy: código identificador do cartão;
• activateCode: código atrelado ao cartão no momento de sua emissão;
• alias: apelido definido pelo proprietário do cartão;
• name: nome gravado no cartão, também conhecido como nome de embossing;
• program: informações sobre o programa escolhido pelo parceiro;
  • id: identificador do programa, o qual é passado no momento da emissão do cartão;
  • name: nome do programa, o qual segue o padrão “COMPANYKEY_PRODUTO_FISICO/VIRTUAL”;
  • type: tipo de programa. Os mais comuns são: “PhysicalPre” e “VirtualPre”, que dizem respeito ao pré-pago físico e virtual, respectivamente.
• lastFourDigits: últimos 4 dígitos do cartão;
• cardType: tipo do cartão, o qual pode ser: “Physical” ou “Virtual”;
• status: status do cartão. Exemplos: “Active”, “Building”, “Sleeping”, “Inactive” etc.;
  A lista completa de status pode ser encontrada no API Reference.
• function: função do cartão, a qual pode ser: “Pre”, “Pos” ou “Debit”;
• allowContactless: informa se é permitido pagamento por aproximação;
• address: objeto contendo os dados do endereço comercial ou residencial;
• holder:
  • document: objeto contendo o número e o tipo do documento (CPF ou CNPJ) do titular do cartão;
  • name: nome cadastrado;
  • account: os dados da conta do titular do cartão;
    • branch: número da agência;
    • number: número da conta;