Cartão (Card)

Os eventos referentes a cartão disparam mensagens ao destinatário quando:

Um cartão é emitido;
O status de um cartão é alterado;
Um cartão físico começa a ser confeccionado;
O status de rastreio de um cartão físico é alterado;
O cartão é adicionado ou removido de uma carteira digital;
A possibilidade de tokenização de um cartão é bloqueada por um determinado período.

Para mais informações sobre quando essas mensagens são disparadas e sobre o seu conteúdo, consulte as páginas:

Pré-requisitos

Para receber esses eventos, o parceiro deverá:

Configurar previamente o recebedor de eventos do webhook.
Conhecer a estrutura básica dos eventos que acompanha o objeto data.

Informações sobre os eventos

Contexto e nome do evento

Os campos context e name poderão variar de acordo com a tabela a seguir:

`context`	`name`	Descrição
`Card`	`CARD_WAS_ISSUED`	O cartão foi emitido.
`Card`	`CARD_WAS_EMBOSSED`	O cartão físico está sendo confeccionado.
`Card`	`TRACKING_STATUS_CHANGED`	Houve uma atualização no status de rastreio.
`Card`	`CARD_STATUS_WAS_MODIFIED`	O status do cartão foi alterado.
`Card`	`CARD_WAS_ADDED_TO_WALLET`	O cartão foi adicionado na carteira digital.
`Card`	`CARD_WAS_REMOVED_FROM_WALLET`	O cartão foi removido da carteira digital.
`Card`	`CARD_WALLET_TOKENIZATION_WAS_BLOCKED`	O cartão foi bloqueado temporariamente para inclusão em carteiras digitais.

Fluxo dos eventos

Os fluxogramas a seguir descrevem a sequência em que os eventos ocorrem com base no contexto em que eles estão inseridos. Clique nas imagens para ampliá-las:

Emissão de cartão físico

📘
Nota
O processo de emissão de cartão virtual gera apenas o evento CARD_WAS_ISSUED, pois, além de não precisar ser transportado após sua emissão, o cartão já fica ativado assim que é criado (status "Active").

Adição de cartão (físico ou virtual) à carteira digital

Identificador (`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 código identificador do cartão (proxy).

📘
Nota
No caso do evento TRACKING_STATUS_CHANGED, o entityId é o código de rastreio gerado pelo Bankly para ser utilizado pelo operador logístico. O seu valor não é retornado no objeto data do payload, somente no campo entityId presente no cabeçalho do evento.

Dados dos eventos

CARD_WAS_ISSUED

Este evento sinaliza que o cartão foi emitido.

Descrição do objeto `data` do evento

O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:

Nome	Tipo	Descrição
`proxy`	`string`	Código identificador do cartão.
`proxyAuthorizer`	`string`	Código que reúne proxy, agência e conta, utilizado internamente pelo autorizador.
`activateCode`	`string`	Código atrelado ao cartão no momento de sua emissão.
`trackingCode`	`string`	Código de rastreio do cartão. Campo retornado apenas para cartões físicos.
`alias`	`string`	Apelido definido pelo proprietário para o cartão.
`name`	`string`	Nome gravado no cartão, também conhecido como nome de embossing.
`program`	`object`	Objeto que contém informações sobre o programa escolhido pelo parceiro.
`program.id`	`string`	Identificador do programa, o qual é passado no momento da emissão do cartão.
`program.type`	`string`	Tipo de programa. Para emissão de cartão avulso, os mais comuns são: “PhysicalPre”, “VirtualPre” e "Pos", que dizem respeito ao pré-pago físico/virtual e pós-pago físico, respectivamente. Se a emissão for feita em lote, há mais duas opções disponíveis: "LotPre" e "LotPos".
`program.bin`	`string`	O BIN, ou Bank Identification Number , são os seis ou oito primeiros dígitos do cartão, utilizados para identificar a instituição bancária que o emitiu.
`program.brand`	`string`	Bandeira do cartão.
`program.name`	`string`	Nome cadastral do programa definido no Bankly, o qual segue o padrão o qual segue o padrão “COMPANYKEY_PRODUTO_FISICO/VIRTUAL”.
`lastFourDigits`	`string`	Quatro últimos dígitos do cartão.
`cardType`	`string`	Tipo do cartão, que pode ser “Physical” ou “Virtual”.
`status`	`string`	Status do cartão. Exemplos: “Active”, “Building”, “Sleeping”, “Inactive”, dentre outros. Confira a tabela com os possíveis status reversíveis e irreversíveis na página Possíveis status do cartão.
`function`	`string`	Função do cartão, que pode ser “Pre”, “Pos” ou “Debit”.
`allowContactless`	`boolean`	Indica se é permitido pagamento por aproximação.
`functionalities[]`	`array of objects`	Lista de objetos contendo informações sobre as funcionalidades do cartão.
`functionalities[].type`	`string`	Tipo de funcionalidade associada ao cartão, que pode ser “Debit", "Pos" ou "Pre".
`functionalities[].program`	`object`	Objeto que contém informações sobre o programa ao qual a funcionalidade está vinculada.
`functionalities[].program.id`	`number`	Identificador único do programa.
`functionalities[].program.bin`	`string`	O BIN, ou Bank Identification Number, são os seis ou oito primeiros dígitos do cartão, utilizados para identificar a instituição bancária que o emitiu.
`functionalities[].program.type`	`string`	Tipo do programa que define a modalidade do cartão.
`functionalities[].program.brand`	`string`	Bandeira do cartão.
`functionalities[].program.name`	`string`	Nome cadastral do programa definido no Bankly, o qual segue o padrão o qual segue o padrão “COMPANYKEY_PRODUTO_FISICO/VIRTUAL”.
`functionalities[].status`	`string`	Status da modalidade, que pode ser “Enabled" (ativado), "Disabled" (desativado), "Blocked" (bloqueado) e “BlockedByContract" (bloqueado por contrato).
`address`	`object`	Objeto que contém informações sobre o endereço comercial ou residencial do titular do cartão.
`address.ziCode`	`string`	Código postal do endereço.
`address.addressLine`	`string`	Logradouro (nome da rua, avenida etc.).
`address.number`	`string`	Número do imóvel.
`address.neighborhood`	`string`	Nome do bairro.
`address.complement`	`string`	Complemento do endereço.
`address.city`	`string`	Nome da cidade.
`address.state`	`string`	Nome do estado.
`address.country`	`string`	Nome do país.
`holder`	`object`	Objeto que contém informações sobre o titular do cartão.
`holder.document`	`object`	Objeto que contém informações sobre o documento do titular do cartão.
`holder.document.value`	`string`	Número do documento.
`holder.document.type`	`string`	Tipo do documento, que pode ser “CPF” ou “CNPJ”.
`holder.name`	`string`	Nome cadastrado.
`holder.account`	`object`	Objeto que contém informações sobre a conta do titular do cartão. Ele somente será retornado em caso de emissão de cartão avulso, sendo ele 1ª ou 2ª via.
`holder.account.branch`	`string`	Número da agência.
`holder.account.number`	`string`	Número da conta.
`holder.account.isExternalBankingCode`	`boolean`	Indicador de utilização de core bancário externo.
`holder.account.bank`	`object`	Objeto que contém informações sobre o banco ao qual a conta do titular do cartão pertence.
`holder.account.bank.ispb`	`string`	ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
`holder.account.bank.code`	`string`	Código do banco.
`holder.account.bank.name`	`string`	Nome do banco.
`holder.phone`	`object`	Objeto que contém informações sobre o telefone do titular do cartão.
`holder.phone.countryCode`	`string`	Código DDI do país.
`holder.phone.number`	`string`	Número de telefone incluindo DDD.
`credit`	`object`	Objeto que contém informações sobre sobre o contrato de crédito. Campo retornado apenas para cartões do tipo pós, quando já há um contrato.
`credit.contractNumber`	`string`	Número do contrato de crédito.
`credit.limitTotal`	`object`	Objeto que contém informações sobre o limite total disponibilizado no contrato.
`credit.limitTotal.value`	`number`	Valor do total disponibilizado no contrato.
`credit.limitTotal.currency`	`string`	Código da moeda com base na ISO 4217. Exemplo: “BRL”.
`batch`	`object`	Objeto que contém informação sobre o lote que originou o cartão. Esse objeto somente será retornado caso o cartão tenha sido emitido dentro de um lote.
`batch.id`	`string`	Identificador único do lote.
`previousCard`	`object`	Objeto que contém informação sobre a via anterior deste cartão. Esse objeto somente será retornado em caso de segunda via (cartão físico).
`previousCard.proxy`	`string`	Código identificador do cartão da via anterior.
`previousCard.purpose`	`string`	Razão da nova emissão (”Duplicate”).

Payload do evento

Os payloads abaixo exemplificam a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-los:

Exemplo de payloads

{ 
        "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": "2500441005128861608",
            "proxyAuthorizer": "0000000000000000000_0000_000000000", 
            "activateCode": "A49000000095", 
            "trackingCode": "JRDRVSQ00000",
            "alias": "0422", 
            "name": "Nísia Floresta", 
            "program": { 
                "id": "53", 
                "type": "Pre",
                "bin": "123456",
                "brand": "Mastercard",
              	"name": "COMPANY_KEY - Physical"
            }, 
            "lastFourDigits": "0000", 
            "cardType": "Physical", 
            "status": "Active", 
            "function": "Pre", 
            "allowContactless": true,
            "functionalities": [
                {
                    "type": "Pre",
                    "program": {
                        "id": 53,
                        "bin": "234028",
                        "type": "PhysicalPre",
                        "brand": "Mastercard",
                      	"name": "COMPANY_KEY - Physical"
                    },
                    "status": "ENABLED"
                }
            ],
            "address": { 
                "zipCode": "68060100", 
                "addressLine": "Rua 6 de Março", 
                "number": "2500", 
                "neighborhood": "Alter do Chão", 
                "complement": "Apartamento", 
                "city": "Santarém", 
                "state": "PA", 
                "country": "BR" 
            }, 
            "holder": { 
                "document": { 
                    "value": "47742663023", 
                    "type": "CPF" 
                }, 
                "name": "Nísia Floresta", 
                "account": { 
                    "branch": "0001", 
                    "number": "15164",
                    "isExternalBankingCore": false,
                    "bank": {
                        "ispb": "13140088",
                        "code": "332",
                        "name": "ACESSO SOLUÇÕES DE PAGAMENTO S.A. - INSTITUIÇÃO DE PAGAMENTO"
                    }
                },
                "phone": {
                    "countryCode": "55",
                    "number": "23415162342"
                }
            }
        }
    }

 { 
        "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": "2500441005128861608",
            "proxyAuthorizer": "0000000000000000000_0000_000000000", 
            "activateCode": "A49000000095", 
            "trackingCode": "JRDRVSQ00000",
            "alias": "0422", 
            "name": "Nísia Floresta", 
            "program": { 
                "id": "53",
                "type": "Pos",
                "bin": "123456",
                "brand": "Mastercard",
              	"name": "COMPANY_KEY - Physical"
            }, 
            "lastFourDigits": "0000", 
            "cardType": "Physical", 
            "status": "Active", 
            "function": "Pos", 
            "allowContactless": true,
            "functionalities": [
                {
                    "type": "Pos",
                    "program": {
                        "id": 53,
                        "bin": "234028",
                        "type": "Pos",
                        "brand": "Mastercard",
                      	"name": "COMPANY_KEY - Physical"
                    },
                    "status": "ENABLED"
                }
            ],
            "address": { 
                "zipCode": "68060100", 
                "addressLine": "Rua 6 de Março", 
                "number": "2500", 
                "neighborhood": "Alter do Chão", 
                "complement": "Apartamento", 
                "city": "Santarém", 
                "state": "PA", 
                "country": "BR" 
            }, 
            "holder": { 
                "document": { 
                    "value": "47742663023", 
                    "type": "CPF" 
                }, 
                "name": "Nísia Floresta", 
                "account": { 
                    "branch": "0001", 
                    "number": "15164",
                    "isExternalBankingCore": false,
                    "bank": {
                        "ispb": "13140088",
                        "code": "332",
                        "name": "ACESSO SOLUÇÕES DE PAGAMENTO S.A. - INSTITUIÇÃO DE PAGAMENTO"
                    }
                },
                "phone": {
                    "countryCode": "55",
                    "number": "23415162342"
                }
            },
            "credit": {
                "contractNumber": "123458696-",
                "limitTotal": {
                    "value": 123,
                    "currency": "BRL"
                }
            }
        }
    }

{ 
        "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": "2500441005128861608",
            "proxyAuthorizer": "0000000000000000000_0000_000000000", 
            "activateCode": "A49000000095", 
            "trackingCode": "JRDRVSQ00000",
            "alias": "0422", 
            "name": "Nísia Floresta", 
            "program": { 
                "id": "53",
                "type": "LotPre",
                "bin": "123456",
                "brand": "Mastercard",
              	"name": "COMPANY_KEY - Physical"
            }, 
            "lastFourDigits": "0000", 
            "cardType": "Physical", 
            "status": "Active", 
            "function": "Pre", 
            "allowContactless": true,
            "functionalities": [
                {
                    "type": "Pre",
                    "program": {
                        "id": 53,
                        "bin": "234028",
                        "type": "Pre",
                        "brand": "Mastercard",
                      	"name": "COMPANY_KEY - Physical"
                    },
                    "status": "ENABLED"
                }
            ],
            "address": { 
                "zipCode": "68060100", 
                "addressLine": "Rua 6 de Março", 
                "number": "2500", 
                "neighborhood": "Alter do Chão", 
                "complement": "Apartamento", 
                "city": "Santarém", 
                "state": "PA", 
                "country": "BR" 
            }, 
            "holder": { 
                "document": { 
                    "value": "47742663023", 
                    "type": "CPF" 
                }, 
                "name": "Nísia Floresta", 
                "account": { 
                    "branch": "0001", 
                    "number": "15164",
                    "isExternalBankingCore": false,
                    "bank": {
                        "ispb": "13140088",
                        "code": "332",
                        "name": "ACESSO SOLUÇÕES DE PAGAMENTO S.A. - INSTITUIÇÃO DE PAGAMENTO"
                    }
                },
                "phone": {
                    "countryCode": "55",
                    "number": "23415162342"
                }
            },
            "batch": {
                "id": "LT023432982"
            }
        }
    }

{ 
        "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": "2500441005128861608",
            "proxyAuthorizer": "0000000000000000000_0000_000000000", 
            "activateCode": "A49000000095", 
            "trackingCode": "JRDRVSQ00000",
            "alias": "0422", 
            "name": "Nísia Floresta", 
            "program": { 
                "id": "53",
                "type": "Pre",
                "bin": "123456",
                "brand": "Mastercard",
              	"name": "COMPANY_KEY - Physical"
            }, 
            "lastFourDigits": "0000", 
            "cardType": "Physical", 
            "status": "Active", 
            "function": "Pre", 
            "allowContactless": true,
            "functionalities": [
                {
                    "type": "Pre",
                    "program": {
                        "id": 53,
                        "bin": "234028",
                        "type": "Pre",
                        "brand": "Mastercard",
                      	"name": "COMPANY_KEY - Physical"
                    },
                    "status": "ENABLED"
                }
            ],
            "address": { 
                "zipCode": "68060100", 
                "addressLine": "Rua 6 de Março", 
                "number": "2500", 
                "neighborhood": "Alter do Chão", 
                "complement": "Apartamento", 
                "city": "Santarém", 
                "state": "PA", 
                "country": "BR" 
            }, 
            "holder": { 
                "document": { 
                    "value": "47742663023", 
                    "type": "CPF" 
                }, 
                "name": "Nísia Floresta", 
                "account": { 
                    "branch": "0001", 
                    "number": "15164",
                    "isExternalBankingCore": false,
                    "bank": {
                        "ispb": "13140088",
                        "code": "332",
                        "name": "ACESSO SOLUÇÕES DE PAGAMENTO S.A. - INSTITUIÇÃO DE PAGAMENTO"
                    }
                },
                "phone": {
                    "countryCode": "55",
                    "number": "23415162342"
                }
            },
            "previousCard": {
                "proxy": "1111111111111111111",
                "purpose": "Duplicate"
            }
        }
    }

{ 
        "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": "2500441005128861608",
            "proxyAuthorizer": "0000000000000000000_0000_000000000", 
            "activateCode": "A49000000095", 
            "trackingCode": "JRDRVSQ00000",
            "alias": "0422", 
            "name": "Nísia Floresta", 
            "program": { 
                "id": "53",
                "type": "Pos",
                "bin": "123456",
                "brand": "Mastercard",
              	"name": "COMPANY_KEY - Physical"
            }, 
            "lastFourDigits": "0000", 
            "cardType": "Physical", 
            "status": "Active", 
            "function": "Pos", 
            "allowContactless": true,
            "functionalities": [
                {
                    "type": "Pos",
                    "program": {
                        "id": 53,
                        "bin": "234028",
                        "type": "Pos",
                        "brand": "Mastercard",
                      	"name": "COMPANY_KEY - Physical"
                    },
                    "status": "ENABLED"
                }
            ],
            "address": { 
                "zipCode": "68060100", 
                "addressLine": "Rua 6 de Março", 
                "number": "2500", 
                "neighborhood": "Alter do Chão", 
                "complement": "Apartamento", 
                "city": "Santarém", 
                "state": "PA", 
                "country": "BR" 
            }, 
            "holder": { 
                "document": { 
                    "value": "47742663023", 
                    "type": "CPF" 
                }, 
                "name": "Nísia Floresta", 
                "account": { 
                    "branch": "0001", 
                    "number": "15164",
                    "isExternalBankingCore": false,
                    "bank": {
                        "ispb": "13140088",
                        "code": "332",
                        "name": "ACESSO SOLUÇÕES DE PAGAMENTO S.A. - INSTITUIÇÃO DE PAGAMENTO"
                    }
                },
                "phone": {
                    "countryCode": "55",
                    "number": "23415162342"
                }
            },
            "credit": {
                "contractNumber": "123458696-",
                "limitTotal": {
                    "value": 123,
                    "currency": "BRL"
                }
            },
            "previousCard": {
                "proxy": "1111111111111111111",
                "purpose": "Duplicate"
            }
        }
    }

CARD_WAS_EMBOSSED

Este evento indica que o cartão físico está sendo confeccionado.

Descrição do objeto `data` do evento

O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:

Nome	Tipo	Descrição
`proxy`	`string`	Código identificador do cartão.
`proxyAuthorizer`	`string`	Código que reúne proxy, agência e conta, utilizado internamente pelo autorizador.
`activateCode`	`string`	Código atrelado ao cartão no momento de sua emissão.
`trackingCode`	`string`	Código de rastreio do cartão. Campo retornado apenas para cartões físicos.
`alias`	`string`	Apelido definido pelo proprietário para o cartão.
`name`	`string`	Nome gravado no cartão, também conhecido como nome de embossing.
`program`	`object`	Objeto que contém informações sobre o programa escolhido pelo parceiro.
`program.id`	`number`	Identificador do programa, o qual é passado no momento da emissão do cartão.
`program.type`	`string`	Tipo de programa. Para emissão de cartão avulso, os mais comuns são: “PhysicalPre”, “VirtualPre” e "Pos", que dizem respeito ao pré-pago físico/virtual e pós-pago físico, respectivamente. Se a emissão for feita em lote, há mais duas opções disponíveis: "LotPre" e "LotPos".
`program.bin`	`string`	O BIN, ou Bank Indetification Number, são os seis ou oito primeiros dígitos do cartão, utilizados para identificar a instituição bancária que o emitiu.
`program.brand`	`string`	Bandeira do cartão.
`program.name`	`string`	Nome cadastral do programa definido no Bankly, o qual segue o padrão “COMPANYKEY_PRODUTO_FISICO/VIRTUAL”.
`lastFourDigits`	`string`	Quatro últimos dígitos do cartão.
`cardType`	`string`	Tipo do cartão, que pode ser “Physical” ou “Virtual”.
`status`	`string`	Status do cartão. Exemplos: “Active”, “Building”, “Sleeping”, “Inactive”, dentre outros. Confira a tabela com os possíveis status reversíveis e irreversíveis na página Possíveis status do cartão.
`function`	`string`	Função do cartão, que pode ser “Pre”, “Pos” ou “Debit”.
`allowContactless`	`boolean`	Indica se é permitido pagamento por aproximação.
`functionalities[]`	`array of objects`	Lista de objetos contendo informações sobre as modalidades do cartão.
`functionalities[].type`	`number`	Tipo de modalidade associada ao cartão, que pode ser “Debit", "Pos" ou "Pre".
`functionalities[].program`	`object`	Objeto que contém informações sobre o programa ao qual a modalidade está vinculada.
`functionalities[].program.id`	`number`	Identificador único do programa.
`functionalities[].program.bin`	`string`	O BIN, ou Bank Indetification Number, são os seis ou oito primeiros dígitos do cartão, utilizados para identificar a instituição bancária que o emitiu.
`functionalities[].program.type`	`string`	Tipo do programa que define a modalidade do cartão.
`functionalities[].program.brand`	`string`	Bandeira do cartão.
`functionalities[].program.name`	`string`	Nome cadastral do programa definido no Bankly, o qual segue o padrão o qual segue o padrão “COMPANYKEY_PRODUTO_FISICO/VIRTUAL”.
`functionalities[].status`	`string`	Status da modalidade, que pode ser “Enabled" (ativado), "Disabled" (desativado), "Blocked" (bloqueado) e “BlockedByContract" (bloqueado por contrato).
`address`	`object`	Objeto que contém informações sobre o endereço comercial ou residencial do titular do cartão.
`address.zipCode`	`string`	Código postal do endereço.
`address.addressLine`	`string`	Logradouro (nome da rua, avenida etc.).
`address.number`	`string`	Número do imóvel.
`address.neighborhood`	`string`	Nome do bairro.
`address.complement`	`string`	Complemento do endereço.
`address.city`	`string`	Nome da cidade.
`address.state`	`string`	Nome do estado.
`address.country`	`string`	Nome do país.
`holder`	`object`	Objeto que contém informações sobre o titular do cartão.
`holder.document`	`object`	Objeto que contém informações sobre o documento do titular do cartão.
`holder.document.value`	`string`	Número do documento.
`holder.document.type`	`string`	Tipo do documento, que pode ser “CPF” ou “CNPJ”.
`holder.name`	`string`	Nome cadastrado.
`holder.account`	`object`	Objeto que contém informações sobre a conta do titular do cartão. Ele somente será retornado em caso de emissão de cartão avulso, sendo ele 1ª ou 2ª via.
`holder.account.branch`	`string`	Número da agência.
`holder.account.number`	`string`	Número da conta.
`holder.account.isExternalBankingCode`	`boolean`	Indicador de utilização de core bancário externo.
`holder.account.bank`	`object`	Objeto que contém informações sobre o banco ao qual a conta do titular do cartão pertence.
`holder.account.bank.ispb`	`string`	ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
`holder.account.bank.code`	`string`	Código do banco.
`holder.account.bank.name`	`string`	Nome do banco.
`holder.phone`	`object`	Objeto que contém informações sobre o telefone do titular do cartão.
`holder.phone.countryCode`	`string`	Código DDI do país.
`holder.phone.number`	`string`	Número de telefone incluindo DDD.
`credit`	`object`	Objeto que contém informações sobre sobre o contrato de crédito. Campo retornado apenas para cartões do tipo pós, quando já há um contrato.
`credit.contractNumber`	`string`	Número do contrato de crédito.
`credit.limitTotal`	`object`	Objeto que contém informações sobre o limite total disponibilizado no contrato.
`credit.limitTotal.value`	`number`	Valor do total disponibilizado no contrato.
`credit.limitTotal.currency`	`string`	Código da moeda com base na ISO 4217. Exemplo: “BRL”.
`embosser`	`object`	Objeto que contém informações sobre os dados de envio para confecção.
`embosser.factory`	`string`	Fábrica de confecção do cartão.
`embosser.fileName`	`string`	Nome do arquivo em que o cartão foi enviado para confecção.
`embosser.embossedAt`	`string`	Data e hora do envio, no formato ISO 8601 - UTC.
`embosser.customFields`	`object`	Objeto que contém informações sobre os campos customizados enviados à fábrica.
`embosser.customFields.PlasticCode`	`string`	Código do plástico do cartão.
`batch`	`object`	Objeto que contém informação sobre o lote que originou o cartão. Esse objeto somente será retornado caso o cartão tenha sido emitido dentro de um lote.
`batch.id`	`string`	Identificador único do lote.
`previousCard`	`object`	Objeto que contém informação sobre a via anterior deste cartão. Esse objeto somente será retornado em caso de segunda via (cartão físico).
`previousCard.proxy`	`string`	Código identificador do cartão da via anterior.
`previousCard.purpose`	`string`	Razão da nova emissão (”Duplicate”).

📘
Nota
O objeto metadata deste evento retornará as informações enviadas pelo parceiro no objeto metadata dos endpoints de emissão de cartão.

Payload do evento

Os payloads abaixo exemplificam a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-los:

Exemplo de payload

{
       "name":"CARD_WAS_EMBOSSED",
       "idempotencyKey":"914e0649-034f-4fb2-b20a-d87422c863cd",
       "context":"Card",
       "timestamp":"2022-12-30T01:11:07.4151363Z",
       "entityId":"2500441000000000001",
       "companyKey":"COMPANY_KEY",
       "correlationId":"5ba3cd76-53bf-4cc4-8ba2-eea0fb1b1071",
       "version": "1",
       "metadata":{
            "capturedAt":"2022-12-30T01:11:07.4019873Z"
       },
       "data":{
            "proxy":"2500441000000000001",
            "proxyAuthorizer": "0000000000000000000_0000_000000000",
            "activateCode":"A395FFES110C",
            "trackingCode": "JRDRVSQ00000",
            "alias":"1222",
            "name":"Nísia Floresta",
            "program":{
                "id":"1000",
                "name": "COMPANY_KEY - Physical",
                "type":"PhysicalPos",
                "bin": "234028",
                "brand": "Mastercard"
            },
            "lastFourDigits":"8944",
            "cardType":"Physical",
            "status":"InTransitLocked",
            "function":"Pos",
            "allowContactless":true,
            "functionalities": [
                {   
                "type": "Pos",
                "program": {
                    "id": 53,
										"bin": "234028",
										"type": "PhysicalPos",
										"brand": "Mastercard",
                  	"name": "COMPANY_KEY - Physical"
                },
                "status": "ENABLED"
                }
            ],    
            "address":{
                "zipCode":"68060100",
                "addressLine":"Rua 6 de Março",
                "number":"2500",
                "neighborhood":"Alter do Chão",
                "complement":"Apartamento",
                "city":"Santarém",
                "state":"PA",
                "country":"BR"
            },
            "holder":{
                "document":{
                    "value":"47742663023",
                    "type":"CPF"
                },
                "name":"Nísia Floresta",
                "account":{
                    "branch":"0001",
                    "number":"15164",
                    "isExternalBankingCore": false,
                    "bank": {
                        "ispb": "13140088",
                        "code": "332",
                        "name": "ACESSO SOLUÇÕES DE PAGAMENTO S.A. - INSTITUIÇÃO DE PAGAMENTO"
                    }      
                },
                "phone": {
                    "countryCode": "55",
                    "number": "23415162342"
                }
            },
            "credit": {
                "contractNumber": "123458696-",
                "limitTotal": {
                    "value": 123,
                    "currency": "BRL"
                }
            },        
            "embosser":{
                "factory":"TestCard",
                "fileName":"ACESSO20221230_275.txt",
                "embossedAt":"2022-12-30T01:10:41Z",
                "customFields": {
                    "plasticCode": "0000"
                }        
           }       
       }
    }

{
       "name":"CARD_WAS_EMBOSSED",
       "idempotencyKey":"914e0649-034f-4fb2-b20a-d87422c863cd",
       "context":"Card",
       "timestamp":"2022-12-30T01:11:07.4151363Z",
       "entityId":"2500441000000000001",
       "companyKey":"COMPANY_KEY",
       "correlationId":"5ba3cd76-53bf-4cc4-8ba2-eea0fb1b1071",
       "version": "1",
       "metadata":{
            "capturedAt":"2022-12-30T01:11:07.4019873Z"
       },
       "data":{
            "proxy":"2500441000000000001",
            "proxyAuthorizer": "0000000000000000000_0000_000000000",
            "activateCode":"A395FFES110C",
            "trackingCode": "JRDRVSQ00000",
            "alias":"1222",
            "name":"Nísia Floresta",
            "program":{
                "id":"1000",
                "name": "COMPANY_KEY - Physical",
                "type":"PhysicalPos",
                "bin": "234028",
                "brand": "Mastercard"
            },
            "lastFourDigits":"8944",
            "cardType":"Physical",
            "status":"InTransitLocked",
            "function":"Pos",
            "allowContactless":true,
            "functionalities": [
                {   
                "type": "Pos",
                "program": {
                    "id": 53,
										"bin": "234028",
										"type": "PhysicalPos",
										"brand": "Mastercard",
                  	"name": "COMPANY_KEY - Physical"
                },
                "status": "ENABLED"
                }
            ],    
            "address":{
                "zipCode":"68060100",
                "addressLine":"Rua 6 de Março",
                "number":"2500",
                "neighborhood":"Alter do Chão",
                "complement":"Apartamento",
                "city":"Santarém",
                "state":"PA",
                "country":"BR"
            },
            "holder":{
                "document":{
                    "value":"47742663023",
                    "type":"CPF"
                },
                "name":"Nísia Floresta",
                "account":{
                    "branch":"0001",
                    "number":"15164",
                    "isExternalBankingCore": false,
                    "bank": {
                        "ispb": "13140088",
                        "code": "332",
                        "name": "ACESSO SOLUÇÕES DE PAGAMENTO S.A. - INSTITUIÇÃO DE PAGAMENTO"
                    }      
                },
                "phone": {
                    "countryCode": "55",
                    "number": "23415162342"
                }
            },
            "credit": {
                "contractNumber": "123458696-",
                "limitTotal": {
                    "value": 123,
                    "currency": "BRL"
                }
            },        
            "embosser":{
                "factory":"TestCard",
                "fileName":"ACESSO20221230_275.txt",
                "embossedAt":"2022-12-30T01:10:41Z",
                "customFields": {
                    "plasticCode": "0000"
                }        
            },
            "previousCard": {
                "proxy": "1111111111111111111",
                "purpose": "Duplicate"
            }         
       }
    }

{
       "name":"CARD_WAS_EMBOSSED",
       "idempotencyKey":"914e0649-034f-4fb2-b20a-d87422c863cd",
       "context":"Card",
       "timestamp":"2022-12-30T01:11:07.4151363Z",
       "entityId":"2500441000000000001",
       "companyKey":"COMPANY_KEY",
       "correlationId":"5ba3cd76-53bf-4cc4-8ba2-eea0fb1b1071",
       "version": "1",
       "metadata":{
            "capturedAt":"2022-12-30T01:11:07.4019873Z"
       },
       "data":{
            "proxy":"2500441000000000001",
            "proxyAuthorizer": "0000000000000000000_0000_000000000",
            "activateCode":"A395FFES110C",
            "trackingCode": "JRDRVSQ00000",
            "alias":"1222",
            "name":"Nísia Floresta",
            "program":{
                "id":"1000",
                "name": "COMPANY_KEY - Physical",
                "type":"LotPos",
                "bin": "234028",
                "brand": "Mastercard"
            },
            "lastFourDigits":"8944",
            "cardType":"Physical",
            "status":"InTransitLocked",
            "function":"Pos",
            "allowContactless":true,
            "functionalities": [
                {   
                "type": "Pos",
                "program": {
                    "id": 53,
										"bin": "234028",
										"type": "PhysicalPos",
										"brand": "Mastercard",
                  	"name": "COMPANY_KEY - Physical"
                },
                "status": "ENABLED"
                }
            ],    
            "address":{
                "zipCode":"68060100",
                "addressLine":"Rua 6 de Março",
                "number":"2500",
                "neighborhood":"Alter do Chão",
                "complement":"Apartamento",
                "city":"Santarém",
                "state":"PA",
                "country":"BR"
            },
            "holder":{
                "document":{
                    "value":"47742663023",
                    "type":"CPF"
                },
                "name":"Nísia Floresta",
                "phone": {
                    "countryCode": "55",
                    "number": "23415162342"
                }
            },
            "credit": {
                "contractNumber": "123458696-",
                "limitTotal": {
                    "value": 123,
                    "currency": "BRL"
                }
            },        
            "embosser":{
                "factory":"TestCard",
                "fileName":"ACESSO20221230_275.txt",
                "embossedAt":"2022-12-30T01:10:41Z",
                "customFields": {
                    "plasticCode": "0000"
                }        
            },
            "batch": {
                "id": "LT023432982"
            }        
       }
    }

{
       "name":"CARD_WAS_EMBOSSED",
       "idempotencyKey":"914e0649-034f-4fb2-b20a-d87422c863cd",
       "context":"Card",
       "timestamp":"2022-12-30T01:11:07.4151363Z",
       "entityId":"2500441000000000001",
       "companyKey":"COMPANY_KEY",
       "correlationId":"5ba3cd76-53bf-4cc4-8ba2-eea0fb1b1071",
       "version": "1",
       "metadata":{
            "capturedAt":"2022-12-30T01:11:07.4019873Z"
       },
       "data":{
            "proxy":"2500441000000000001",
            "proxyAuthorizer": "0000000000000000000_0000_000000000",
            "activateCode":"A395FFES110C",
            "alias":"1222",
            "name":"Nísia Floresta",
            "program":{
                "id":"1000",
                "name": "COMPANY_KEY - Physical",
                "type":"VirtualPre",
                "bin": "234028",
                "brand": "Mastercard"
            },
            "lastFourDigits":"8944",
            "cardType":"Virtual",
            "status":"InTransitLocked",
            "function":"Pre",
            "allowContactless":true,
            "functionalities": [
                {   
                "type": "Pre",
                "program": {
                    "id": 53,
										"bin": "234028",
										"type": "VirtualPre",
										"brand": "Mastercard",
                  	"name": "COMPANY_KEY - Physical"
                },
                "status": "ENABLED"
                }
            ],    
            "address":{
                "zipCode":"68060100",
                "addressLine":"Rua 6 de Março",
                "number":"2500",
                "neighborhood":"Alter do Chão",
                "complement":"Apartamento",
                "city":"Santarém",
                "state":"PA",
                "country":"BR"
            },
            "holder":{
                "document":{
                    "value":"47742663023",
                    "type":"CPF"
                },
                "name":"Nísia Floresta",
                "account":{
                    "branch":"0001",
                    "number":"15164",
                    "isExternalBankingCore": false,
                    "bank": {
                        "ispb": "13140088",
                        "code": "332",
                        "name": "ACESSO SOLUÇÕES DE PAGAMENTO S.A. - INSTITUIÇÃO DE PAGAMENTO"
                    }      
                },
                "phone": {
                    "countryCode": "55",
                    "number": "23415162342"
                }
            },       
            "embosser":{
                "factory":"TestCard",
                "fileName":"ACESSO20221230_275.txt",
                "embossedAt":"2022-12-30T01:10:41Z",
                "customFields": {
                    "plasticCode": "0000"
                }        
           }       
       }
    }

{
       "name":"CARD_WAS_EMBOSSED",
       "idempotencyKey":"914e0649-034f-4fb2-b20a-d87422c863cd",
       "context":"Card",
       "timestamp":"2022-12-30T01:11:07.4151363Z",
       "entityId":"2500441000000000001",
       "companyKey":"COMPANY_KEY",
       "correlationId":"5ba3cd76-53bf-4cc4-8ba2-eea0fb1b1071",
       "version": "1",
       "metadata":{
            "capturedAt":"2022-12-30T01:11:07.4019873Z"
       },
       "data":{
            "proxy":"2500441000000000001",
            "proxyAuthorizer": "0000000000000000000_0000_000000000",
            "activateCode":"A395FFES110C",
            "trackingCode": "JRDRVSQ00000",
            "alias":"1222",
            "name":"Nísia Floresta",
            "program":{
                "id":"1000",
                "name": "COMPANY_KEY - Physical",
                "type":"PhysicalPre",
                "bin": "234028",
                "brand": "Mastercard"
            },
            "lastFourDigits":"8944",
            "cardType":"Physical",
            "status":"InTransitLocked",
            "function":"Pre",
            "allowContactless":true,
            "functionalities": [
                {   
                "type": "Pre",
                "program": {
                    "id": 53,
										"bin": "234028",
										"type": "PhysicalPre",
										"brand": "Mastercard",
                  	"name": "COMPANY_KEY - Physical"
                },
                "status": "ENABLED"
                }
            ],    
            "address":{
                "zipCode":"68060100",
                "addressLine":"Rua 6 de Março",
                "number":"2500",
                "neighborhood":"Alter do Chão",
                "complement":"Apartamento",
                "city":"Santarém",
                "state":"PA",
                "country":"BR"
            },
            "holder":{
                "document":{
                    "value":"47742663023",
                    "type":"CPF"
                },
                "name":"Nísia Floresta",
                "account":{
                    "branch":"0001",
                    "number":"15164",
                    "isExternalBankingCore": false,
                    "bank": {
                        "ispb": "13140088",
                        "code": "332",
                        "name": "ACESSO SOLUÇÕES DE PAGAMENTO S.A. - INSTITUIÇÃO DE PAGAMENTO"
                    }      
                },
                "phone": {
                    "countryCode": "55",
                    "number": "23415162342"
                }
            },       
            "embosser":{
                "factory":"TestCard",
                "fileName":"ACESSO20221230_275.txt",
                "embossedAt":"2022-12-30T01:10:41Z",
                "customFields": {
                    "plasticCode": "0000"
                }        
           }       
       }
    }

TRACKING_STATUS_CHANGED

Este evento sinaliza que houve uma atualização no status de rastreio.

Descrição do objeto `data` do evento

O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:

Nome	Tipo	Descrição
`card`	`object`	Objeto que contém informações sobre o cartão.
`card.proxy`	`string`	Código identificador do cartão.
`card.alias`	`string`	Apelido definido pelo proprietário do cartão.
`externalTracking`	`object`	Objeto que contém informações sobre a transportadora responsável pela entrega do cartão. Este objeto somente será enviado caso o operador logístico terceirize a entrega do cartão.
`externalTracking.code`	`string`	Código de rastreio proveniente da transportadora.
`externalTracking.partner`	`string`	Nome da transportadora.
`estimatedDeliveryDate`	`string`	Data de entrega estimada, no formato ISO 8601 - UTC.
`status`	`object`	Objeto que contém informações sobre o histórico dos status desde a criação do cartão até a entrega ao destinatário.
`status.type`	`string`	Status de rastreio do cartão .
`status.reason`	`string`	Descrição do status de rastreio.
`finalized`	`object`	Objeto que contém informações sobre quem recebeu o cartão e o número de tentativas de entrega. Objeto retornado apenas após a entrega do cartão (status "Delivered").
`finalized.recipient`	`object`	Objeto que contém informações sobre quem recebeu o cartão.
`finalized.recipient.name`	`string`	Nome do recebedor do cartão.
`finalized.recipient.kinship`	`string`	Relacionamento do titular do cartão com a pessoa que o recebeu.
`finalized.recipient.document`	`object`	Objeto que contém informações sobre o documento do recebedor do cartão.
`finalized.recipient.document.type`	`string`	Tipo do documento, que pode ser “CPF” ou “CNPJ”.
`finalized.recipient.document.number`	`string`	Número do documento.
`finalized.recipient.attempts`	`int`	Número de tentativas de entrega realizadas.

📘
Nota
No caso do evento TRACKING_STATUS_CHANGED, o entityId é o código de rastreio gerado pelo Bankly para ser utilizado pelo operador logístico. O seu valor não é retornado no objeto data do payload, somente no campo entityId presente no cabeçalho do evento.

Payload do evento

Os payloads abaixo exemplificam a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-los:

Exemplo de payloads

{
      "entityId": "24906A3D54FC",
      "idempotencyKey": "86447d19-687f-4fa8-80cf-a5aa406457b9",
      "companyKey": "companyKey",
      "version": "1",
      "context": "Card",
      "name": "TRACKING_STATUS_CHANGED",
      "timestamp": "2021-10-06T13:07:25.3853601Z",
      "correlationId": "7a1bfc3f-50e6-458c-aa9b-d42a22ddb84d",
      "metadata": {
         "created": "2021-11-10T20:40:24.282+00:00",
         "modified": "2021-11-18T20:40:24.282+00:00"
      },
      "data": {
         "card": {
            "proxy": "2229141009436273825",
            "alias": "Nísia Floresta"
         },
         "estimatedDeliveryDate": "2021-11-25T23:59:59.282+00:00",
         "status": {
            "type": "InProgress",
            "reason": "Object on the way"
         }
      }
   }

{
      "entityId": "24906A3D54FC",
      "idempotencyKey": "86447d19-687f-4fa8-80cf-a5aa406457b9",
      "companyKey": "companyKey",
      "version": "1",
      "context": "Card",
      "name": "TRACKING_STATUS_CHANGED",
      "timestamp": "2021-10-06T13:07:25.3853601Z",
      "correlationId": "7a1bfc3f-50e6-458c-aa9b-d42a22ddb84d",
      "metadata": {
         "created": "2021-11-10T20:40:24.282+00:00",
         "modified": "2021-11-18T20:40:24.282+00:00"
      },
      "data": {
         "card": {
            "proxy": "2229141009436273825",
            "alias": "Nísia Floresta"
         },
         "estimatedDeliveryDate": "2021-11-25T23:59:59.282+00:00",
         "status": {
            "type": "Delivered",
            "reason": "Object delivered"
         },
         "finalized": {
            "recipient": {
               "name": "Maria Quitéria de Jesus",
               "kinship": "Mãe",
               "document": {
                  "type": "CPF",
                  "number": "09992220074"
               }
            },
            "attempts": 1
         }
      }
   }

{
      "entityId": "24906A3D54FC",
      "idempotencyKey": "86447d19-687f-4fa8-80cf-a5aa406457b9",
      "companyKey": "companyKey",
      "version": "1",
      "context": "Card",
      "name": "TRACKING_STATUS_CHANGED",
      "timestamp": "2021-10-06T13:07:25.3853601Z",
      "correlationId": "7a1bfc3f-50e6-458c-aa9b-d42a22ddb84d",
      "metadata": {
         "created": "2021-11-10T20:40:24.282+00:00",
         "modified": "2021-11-18T20:40:24.282+00:00"
      },
      "data": {
         "card": {
            "proxy": "2229141009436273825",
            "alias": "Nísia Floresta"
         },
         "externalTracking": {
            "code": "111",
            "partner": "CORREIOS"
         },
         "estimatedDeliveryDate": "2021-11-25T23:59:59.282+00:00",
         "status": {
            "type": "InProgress",
            "reason": "Object on the way"
         }
      }
   }

{
      "entityId": "24906A3D54FC",
      "idempotencyKey": "86447d19-687f-4fa8-80cf-a5aa406457b9",
      "companyKey": "companyKey",
      "version": "1",
      "context": "Card",
      "name": "TRACKING_STATUS_CHANGED",
      "timestamp": "2021-10-06T13:07:25.3853601Z",
      "correlationId": "7a1bfc3f-50e6-458c-aa9b-d42a22ddb84d",
      "metadata": {
         "created": "2021-11-10T20:40:24.282+00:00",
         "modified": "2021-11-18T20:40:24.282+00:00"
      },
      "data": {
         "card": {
            "proxy": "2229141009436273825",
            "alias": "Nísia Floresta"
         },
         "externalTracking": {
            "code": "111",
            "partner": "CORREIOS"
         },
         "estimatedDeliveryDate": "2021-11-25T23:59:59.282+00:00",
         "status": {
            "type": "Delivered",
            "reason": "Object delivered"
         },
         "finalized": {
            "recipient": {
               "name": "Maria Quitéria de Jesus",
               "kinship": "Mãe",
               "document": {
                  "type": "CPF",
                  "number": "09992220074"
               }
            },
            "attempts": 1
         }
      }
   }

CARD_STATUS_WAS_MODIFIED

Este evento sinaliza que o status do cartão foi alterado.

Descrição do objeto `data` do evento

O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:

Nome	Tipo	Descrição
`proxy`	`string`	Código identificador do cartão.
`status`	`string`	Status atual do cartão. Confira a tabela com os possíveis status reversíveis e irreversíveis na página Possíveis status do cartão.
`statusPrevious`	`string`	Status anterior do cartão. Confira a tabela com os possíveis status reversíveis e irreversíveis na página Possíveis status do cartão.

Payload do evento

O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:

Exemplo de payload

{
      "idempotencyKey": "423f240d-539e-4f4c-9f1b-05cb4d7a819a",
      "context": "Card",
      "name": "CARD_STATUS_WAS_MODIFIED",
      "timestamp": "2022-07-11T17:31:21.9632827Z",
      "entityId": "234026100039584752",
      "companyKey": "companyKey",
      "correlationId": "10d5aad9-4de4-4f96-903e-6816d30e043a",
      "version": "1",
      "metadata": {
         "updatedAt": "2022-07-11T17:31:21.5238611Z"
      },
      "data": {
         "proxy": "234026100039584752",
         "status": "CanceledByCustomer",
         "statusPrevious": "Active"
      }
   }

⚠️
Importante
Este evento não é disparado quando o status do cartão se altera de Building para Active ou de Building para InTransitLocked, pois esses cenários já são contemplados pelo evento de emissão de cartão.

CARD_WAS_ADDED_TO_WALLET

Este evento sinaliza que o cartão foi adicionado na carteira digital.

Descrição do objeto `data` do evento

O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:

Nome	Tipo	Descrição
`proxy`	`string`	Código identificador do cartão.
`program`	`object`	Objeto que contém informações sobre o programa escolhido pelo parceiro.
`program.id`	`string`	Identificador do programa, o qual é passado no momento da emissão do cartão.
`program.type`	`string`	Tipo de programa. Os mais comuns são: “PhysicalPre” e “VirtualPre”, que dizem respeito ao pré-pago físico e virtual, respectivamente.
`program.bin`	`string`	BIN, ou Bank Identification Number , são os seis ou oito primeiros dígitos do cartão, utilizados para identificar a instituição bancária que o emitiu. Observação: cartões antigos podem não ter essa informação armazenada em seus dados.
`program.brand`	`string`	Bandeira do cartão. Observação: cartões antigos podem não ter essa informação armazenada em seus dados.
`program.name`	`string`	Nome cadastral do programa definido no Bankly, o qual segue o padrão o qual segue o padrão “COMPANYKEY_PRODUTO_FISICO/VIRTUAL”. Observação: cartões antigos podem não ter essa informação armazenada em seus dados.
`lastFourDigits`	`string`	Quatro últimos dígitos do cartão.
`cardType`	`string`	Tipo do cartão, que pode ser “Physical” ou “Virtual”.
`function`	`string`	Função do cartão, que pode ser “Pre”, “Pos” ou “Debit”.
`allowContactless`	`boolean`	Indica se é permitido pagamento por aproximação.
`holder`	`object`	Objeto que contém informações sobre o titular do cartão.
`holder.document`	`object`	Objeto que contém informações sobre o documento do titular do cartão.
`holder.document.value`	`string`	Número do documento.
`holder.document.type`	`string`	Tipo de documento, que pode ser “CPF ou “CNPJ”.
`holder.name`	`string`	Nome cadastrado.
`holder.account`	`object`	Objeto que contém informações sobre a conta bancária do titular do cartão.
`holder.account.branch`	`string`	Número da agência.
`holder.account.number`	`string`	Número da conta.
`holder.account.bank`	`object`	Objeto que contém informações sobre o banco ao qual a conta pertence.
`holder.account.bank.ispb`	`string`	ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.
`holder.account.bank.code`	`string`	Código do banco.
`holder.account.bank.name`	`string`	Nome do banco.
`wallet`	`object`	Objeto que contém informações sobre a carteira na qual o cartão foi adicionado.
`wallet.walletType`	`string`	Tipo de carteira.
`wallet.walletFlow`	`string`	Classificação do fluxo utilizado para adicionar o cartão na wallet. Os fluxos são: YellowPatch (o cliente adiciona o cartão pela própria carteira da Google, Apple, Samsung etc.) e GreenPatch (o cliente usa o aplicativo do parceiro para iniciar a tokenização do cartão na carteira).

👍
Dica
Para mais informações sobre o fluxo de adição de cartão à wallet, consulte a documentação Carteiras digitais.

Payload do evento

O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:

Exemplo de payload

{
      "name": "CARD_WAS_ADDED_TO_WALLET",
      "idempotencyKey": "6706ad77-1993-4d2a-8ccf-b270aa650131",
      "context": "Card",
      "timestamp": "2022-11-30T19:42:26.0102699Z",
      "entityId": "2500011000044122120",
      "companyKey": "companyKey",
      "correlationId": "e08de8bf-b2c8-4616-9255-63e5bf84dff3",
      "version": "1",
      "metadata": {
         "created": "2022-11-30T19:42:21.394653+00:00"
      },
      "data": {
         "proxy": "2500011000044122120",
         "program": {
            "id": "92",
            "type": "LotPre",
           	"bin": "234028",
           	"brand": "Mastercard",
            "name": "COMPANY_KEY - Physical"
           	
         },
         "lastFourDigits": "7288",
         "cardType": "Physical",
         "function": "Pre",
         "allowContactless": true,
         "holder": {
            "document": {
               "value": "47742663023",
               "type": "CPF"
            },
            "name": "Nísia Floresta",
            "account": {
               "branch": "0001",
               "number": "15164",
               "bank": {
                    "ispb": "13140088",
                    "code": "332",
                    "name": "ACESSO SOLUÇÕES DE PAGAMENTO S.A. - INSTITUIÇÃO DE PAGAMENTO"
                }
            }
         },
         "wallet": {
            "walletType": "GooglePay",
            "walletFlow": "GreenPatch"
         }
      }
   }

CARD_WAS_REMOVED_FROM_WALLET

Este evento sinaliza que o cartão foi removido da carteira digital.

Descrição do objeto `data` do evento

O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:

Nome	Tipo	Descrição
`proxy`	`string`	Código identificador do cartão.
`program`	`object`	Objeto que contém informações sobre o programa escolhido pelo parceiro.
`program.id`	`string`	Identificador do programa, o qual é passado no momento da emissão do cartão.
`program.type`	`string`	Tipo de programa. Os mais comuns são: “PhysicalPre” e “VirtualPre”, que dizem respeito ao pré-pago físico e virtual, respectivamente.
`program.bin`	`string`	BIN, ou Bank Identification Number, são os seis ou oito primeiros dígitos do cartão, utilizados para identificar a instituição bancária que o emitiu. Observação: cartões antigos podem não ter essa informação armazenada em seus dados.
`program.brand`	`string`	Bandeira do cartão. Observação: cartões antigos podem não ter essa informação armazenada em seus dados.
`program.name`	`string`	Nome cadastral do programa definido no Bankly, o qual segue o padrão o qual segue o padrão “COMPANYKEY_PRODUTO_FISICO/VIRTUAL”. Observação: cartões antigos podem não ter essa informação armazenada em seus dados.
`lastFourDigits`	`string`	Quatro últimos dígitos do cartão.
`cardType`	`string`	Tipo do cartão, que pode ser “Physical” ou “Virtual”.
`function`	`string`	Função do cartão, que pode ser “Pre”, “Pos” ou “Debit”.
`allowContactless`	`boolean`	Informa se é permitido pagamento por aproximação.
`holder`	`object`	Objeto que contém informações do titular da fatura.
`holder.document`	`object`	Objeto que contém informações sobre o documento do titular do cartão.
`holder.document.value`	`string`	Número do documento.
`holder.document.type`	`string`	Tipo de documento, que pode ser “CPF ou “CNPJ”.
`holder.name`	`string`	Nome cadastrado.
`holder.account`	`object`	Objeto que contém informações sobre a conta bancária do titular.
`holder.account.branch`	`string`	Número da agência.
`holder.account.number`	`string`	Número da conta.
`wallet`	`object`	Objeto que contém informações sobre a carteira na qual o cartão foi adicionado.
`wallet.walletType`	`string`	Tipo de carteira.
`wallet.walletFlow`	`string`	Classificação do fluxo utilizado para colocar o cartão na wallet. Os fluxos são: YellowPatch (o cliente adiciona o cartão pela própria carteira da Google, Apple, Samsung etc.) e GreenPatch (o cliente usa o aplicativo do parceiro para iniciar a tokenização do cartão na carteira).

Payload do evento

O payload abaixo exemplifica a estrutura do evento que deverá ser recebido pelo parceiro. Clique na seta para expandi-lo:

Exemplo de payload

{
      "name": "CARD_WAS_REMOVED_FROM_WALLET",
      "idempotencyKey": "be214c89-354e-424b-8c27-fb482a969105",
      "context": "Card",
      "timestamp": "2022-11-30T19:41:23.3574876Z",
      "entityId": "2500011000044122120",
      "companyKey": "companyKey",
      "correlationId": "e08de8bf-b2c8-4616-9255-63e5bf84dff3",
      "version": "1",
      "metadata": {
         "created": "2022-11-30T19:41:10.1212513+00:00"
      },
      "data": {
         "proxy": "2500011000044122120",
         "program": {
            "id": "92",
            "type": "LotPre",
           	"bin": "234028",
           	"brand": "Mastercard",
            "name": "COMPANY_KEY - Physical"
         },
         "lastFourDigits": "7288",
         "cardType": "Physical",
         "function": "Pre",
         "allowContactless": true,
         "holder": {
            "document": {
               "value": "47742663023",
               "type": "CPF"
            },
            "name": "Nísia Floresta",
            "account": {
               "branch": "0001",
               "number": "15164"
            }
         },
         "wallet": {
            "walletType": "GooglePay",
            "walletFlow": "GreenPatch"
         }
      }
   }

CARD_WALLET_TOKENIZATION_WAS_BLOCKED

Esse evento sinaliza que o cartão foi bloqueado temporariamente para inclusão em carteiras digitais.

Descrição do objeto `data` do evento

O objeto data traz detalhes específicos do contexto em que o evento ocorre. Neste caso, o objeto trará os campos de acordo com a tabela:

Nome	Tipo	Descrição	Número máximo de caracteres
`proxy`	`string`	Identificador do cartão.	31
`reason`	`string`	Motivo relacionado ao tipo de bloqueio realizado.	—
`startedAt`	`string`	Data e a hora de início do bloqueio, no formato ISO 8601 - UTC.	—
`endsAt`	`string`	Se o motivo do bloqueio for “InvalidCVVLimitExceeded”, esse campo retornará a data e a hora de término do bloqueio, no formato ISO 8601 - UTC. Caso contrário, esse campo virá como `null` ou não será retornado.	—

Exemplo de payload

{
   "name": "CARD_WALLET_TOKENIZATION_WAS_BLOCKED",
   "idempotencyKey": "914e0649-034f-4fb2-b20a-d87422c863cd",
   "context": "Card",
   "timestamp": "2022-12-30T01:11:07.4151363Z",
   "entityId": "2500441000000000001",
   "companyKey": "TESTE",
   "correlationId": "5ba3cd76-53bf-4cc4-8ba2-eea0fb1b1071",
   "version": "1",
   "metadata": {
      "capturedAt": "2022-12-30T01:11:07.4019873Z"
   },
   "data": {
      "proxy": "2500441000000000001",
      "reason": "InvalidCVVLimitExceeded",
      "startedAt": "2022-12-30T01:11:07.4019873Z",
      "endsAt": "2022-12-30T01:11:07.4019873Z"
   }
}

Tabelas para consulta

Status de rastreio de cartão

Status	Descrição
Created	Primeiro registro do cartão.
Building	O cartão está sendo confeccionado.
InProgress	O cartão está sendo transferido de local.
Delivered	O cartão foi entregue. Este é um status final, portanto, não são necessárias novas consultas.
Cancelled	Dentre outros motivos, este status é exibido quando o cartão foi extraviado ou quando entrou em processo de custódia, porém, o prazo para tomar uma ação a respeito expirou.
NotDelivered	Status relacionado a cartão não entregue, seja por endereço incorreto, seja por ter sido recusado, ou então porque o número máximo de tentativas de entregas foi excedido.
Custody	Situação em que o cartão retornou ao Bankly e será necessário atualizar o endereço de entrega.

Tipos de carteiras

Código	Descrição
101	MasterpassByMastercard
103	ApplePay
216	GooglePay
217	SamsungPay
327	MerchantTokenizationProgram
0	Unknown
00	Unknown

Tipos de bloqueio para inclusão em carteiras digitais

`reason`	Descrição
InvalidCVVLimitExceeded	O valor do CVV foi informado pelo cliente incorretamente por cinco vezes consecutivas.

Cartão (Card)

Pré-requisitos

Informações sobre os eventos

Contexto e nome do evento

Fluxo dos eventos

📘
Nota

Identificador (`entityId`)

📘
Nota

Dados dos eventos

CARD_WAS_ISSUED

Descrição do objeto `data` do evento

Payload do evento

CARD_WAS_EMBOSSED

Descrição do objeto `data` do evento

📘
Nota

Payload do evento

TRACKING_STATUS_CHANGED

Descrição do objeto `data` do evento

📘
Nota

Payload do evento

CARD_STATUS_WAS_MODIFIED

Descrição do objeto `data` do evento

Payload do evento

⚠️
Importante

CARD_WAS_ADDED_TO_WALLET

Descrição do objeto `data` do evento

👍
Dica

Payload do evento

CARD_WAS_REMOVED_FROM_WALLET

Descrição do objeto `data` do evento

Payload do evento

CARD_WALLET_TOKENIZATION_WAS_BLOCKED

Descrição do objeto `data` do evento

Tabelas para consulta

Status de rastreio de cartão

Tipos de carteiras

Tipos de bloqueio para inclusão em carteiras digitais

Pré-requisitos

Informações sobre os eventos

Contexto e nome do evento

Fluxo dos eventos

📘Nota

Identificador (entityId)

📘Nota

Dados dos eventos

CARD_WAS_ISSUED

Descrição do objeto data do evento

Payload do evento

CARD_WAS_EMBOSSED

Descrição do objeto data do evento

📘Nota

Payload do evento

TRACKING_STATUS_CHANGED

Descrição do objeto data do evento

📘Nota

Payload do evento

CARD_STATUS_WAS_MODIFIED

Descrição do objeto data do evento

Payload do evento

⚠️Importante

CARD_WAS_ADDED_TO_WALLET

Descrição do objeto data do evento

👍Dica

Payload do evento

CARD_WAS_REMOVED_FROM_WALLET

Descrição do objeto data do evento

Payload do evento

CARD_WALLET_TOKENIZATION_WAS_BLOCKED

Descrição do objeto data do evento

Tabelas para consulta

Status de rastreio de cartão

Tipos de carteiras

Tipos de bloqueio para inclusão em carteiras digitais

📘
Nota

Identificador (`entityId`)

📘
Nota

Descrição do objeto `data` do evento

Descrição do objeto `data` do evento

📘
Nota

Descrição do objeto `data` do evento

📘
Nota

Descrição do objeto `data` do evento

⚠️
Importante

Descrição do objeto `data` do evento

👍
Dica

Descrição do objeto `data` do evento

Descrição do objeto `data` do evento