Criação de cartões em lote

stable pré

A criação de cartões em lote permite solicitar uma quantidade elevada de cartões físicos No Name (100, 500, 1 mil etc.) em uma única requisição.

Isso possibilita ao parceiro estocar os cartões emitidos e, posteriormente, enviá-los a seus clientes para ativação.

Para realizar a emissão em lote, os cartões não precisam estar relacionados a nenhuma conta, somente ao endereço de entrega.

🚧

Importante

Embora o cartão No Name não requeira os dados do cliente no momento de sua criação, ele precisará ser vinculado a um documento e a uma conta para ser ativado.

Pré-requisitos

Para que seja possível utilizar este endpoint, é necessário que:

  • O parceiro defina um programa para seus cartões;

Requisição (Request)

Requisição HTTP

POST https://api-mtls.sandbox.bankly.com.br/cards/batches/
--request POST 
--url 'https://api-mtls.sandbox.bankly.com.br/cards/batches/' \  
--header 'api-version: 1' \  
--header 'Authorization: Bearer {{accessToken}}' \  
--header 'Content-Type: application/json' \  
--data '  
    {
        "programId": 111,
        "quantityCards": 100,
        "paymentDay": 1,
        "address": {
            "zipCode": "68060100",
            "address": "Rua 6 de Março",
            "number": "2500",
            "neighborhood": "Alter do Chão",
            "complement": "",
            "city": "Santarém",
            "state": "PA",
            "country": "BR"
        }
    }'

Autorização

Para garantir a segurança nas requisições, todos os endpoints do Bankly utilizam scopes como parte do seu fluxo de autorização.
Esta requisição requer o scope descrito a seguir:

ScopeDescrição
card.createConcede acesso para a criação de um cartão.

Cabeçalhos (Headers)

NomeDescrição
api-versionObrigatório. Versão da API. Atualmente estamos na versão 1.0.
AuthorizationObrigatório. Token de autorização do tipo Bearer.

Parâmetros da rota (Path)

Não é necessário enviar parâmetros no path desta requisição.

Corpo da requisição (Body)

No body, envie os seguintes campos em formato JSON:

NomeTipoDescrição
address.addressstringObrigatório. Logradouro (nome da rua, avenida etc.).
address.numberstringObrigatório. Número do imóvel.
address.neighborhoodstringObrigatório. Nome do bairro.
address.complementstringComplemento do endereço.
address.citystringObrigatório. Nome da cidade.
address.statestringObrigatório. Nome do estado.
address.countrystringObrigatório. Nome do país.
{ 
  "programId": 111, 
  "quantityCards": 100, 
  "paymentDay": 1, 
  "address": { 
    "zipCode": "68060100",
    "address": "Rua 6 de Março",
    "number": "2500",
    "neighborhood": "Alter do Chão",
    "complement": "",
    "city": "Santarém",
    "state": "PA",
    "country": "BR"
  } 
}

Resposta (Response)

O status code 202 indicará sucesso na requisição. O retorno trará o lotId (identificador do lote criado).

Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

{
  "lotId": "string"
}

👍

Dica

Para simular uma requisição nesse endpoint, acesse o API Reference.

Erros

Este endpoint pode retornar erros específicos, conforme a tabela a seguir:

Status CodeCódigoMensagemDescrição
406013Delivery address must be informed when requesting the physical cardO cartão físico necessita de um endereço para entrega.
406101Program disable!O programa está temporariamente desabilitado.
406102Program undefined!Nenhum programa definido para a operação.
406115Program does not belong to lotO programa não pertence a esse lote.
409030Maximum quantity per lot reachedA quantidade máxima de cartões por lote foi atingida.
409031Maximum quantity lot per day reachedA quantidade máxima de cartões por lote diária foi atingida.
409110Program does not have the informed payment dayO programa não informa o dia do pagamento.

Recordamos que esta API também poderá retornar erros comuns entre todos os endpoints. Portanto, recomendamos a consulta da documentação de erros, onde é possível encontrar as mensagens comuns em inglês que acompanham os erros 400 (se houver).

Eventos

Este endpoint não possui eventos relacionados a ele.


Copyright © 2021 Acesso Soluções de Pagamento S.A - Todos os direitos reservados