Emissão de cartão físico
stablescopes: card.create
Este endpoint permite que o parceiro Bankly ofereça a seus clientes a possibilidade de adquirir um cartão físico.
Etapas
Pré-requisito
Para que seja possível emitir um cartão físico, é necessário que:
- O parceiro defina um programa para seus cartões;
- O cliente do parceiro possua uma conta ativa.
Endpoint
Para o uso deste endpoint, preencha obrigatoriamente os seguintes campos:
Body
documentNumber
: número de documento de CPF ou CNPJ. Informe somente os números;cardName
: nome que será impresso no cartão. Não é permitido o uso de números e caracteres especiais e o tamanho máximo é de 19 caracteres.alias
: apelido do cartão. Não é permitido o uso de caracteres especiais e o tamanho máximo é de 16 caracteres;bankAgency
: número da agência;bankAccount
: número da conta ao qual o cartão será vinculado;programId
: identificador do programa previamente definido;password
: senha do cartão. Preencha com apenas 4 dígitos, como por exemplo: “4853”;
Caso o cliente não tenha informado o endereço de entrega no momento do cadastro, preencha obrigatoriamente:
address
: objeto que contém informações sobre o endereço do titular do cartão ao qual deve ser realizado a entrega:zipCode
: código postal do endereço;address
: nome da rua;number
: número do prédio ou da casa;neighborhood
: nome do bairro;complement
: complemento do endereço;city
: nome da cidade;state
: nome do estado;country
: nome do país;
Entretanto, caso o cliente já possua um endereço cadastrado, o preenchimento do campo address
é opcional.
Atenção
Para evitar problemas na entrega devido à desatualização do endereço cadastrado, recomendamos que o campo
address
seja preenchido mesmo que o cliente já tenha informado um endereço previamente.
curl --request --location POST 'https://api-mtls.sandbox.bankly.com.br/cards/physical'\
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
--data-raw {
"documentNumber": "00000000000000",
"cardName": "Peter Parker",
"alias": "Cartão principal",
"bankAgency": "0001",
"bankAccount": "12345",
"programId": "1234",
"password": "1234",
"address": {
"zipCode": "04205000",
"address": "Rua Cipriano Barata",
"number": "790",
"neighborhood": "Ipiranga",
"complement": "Casa 2",
"city": "São Paulo",
"state": "SP",
"country": "BR"
}
Retorno
Os status 202 indica que a solicitação foi aceita e o cartão está sendo criado.
{
"proxy": "2370021007715002820",
"activateCode": "A0DDDC0951D1"
}
Erros
Status code | Código | Descrição |
---|---|---|
400 | INVALID_PARAMETER | O conteúdo da requisição não está de acordo com o esperado. Exemplos: tamanho de campo, tipo ou conteúdo obrigatório. |
400 | 110 | O dia de pagamento não foi informado no programa. |
401 | --- | Sem autorização para realizar a solicitação. |
401 | 115 | O programa não pertence ao lote. |
404 | 100 | Programa não encontrado. |
406 | 013 | O cartão físico necessita de um endereço para entrega. |
406 | 101 | Requisição válida, porém, não foi aceita devido a alguma regra de negócio contratada. |
406 | 102 | Nenhum programa definido para a operação. |
406 | 202 | A conta não pertence ao cliente. |
406 | 203 | Conta inativa. |
409 | 012 | A requisição com os dados enviados já foi realizada e está em processamento. |
409 | ANALYSIS_CREDIT_NOTFOUND | Análise de crédito não encontrada para o documento e o programa informado. |
406 | DUPLICATE_CARD_NAME | Nome já cadastrado para o CPF informado. Não é possível ter dois cartões ativos com o mesmo nome para o mesmo CPF. |
500 | --- | Ocorrência de erro inesperado. |
Updated 12 months ago