Criação de cartões em lote

stable

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é-requisito

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

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

Requisição

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 prédio ou da casa.
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ódigoDescrição
406013O cartão físico necessita de um endereço para entrega.
406101O programa está temporariamente desabilitado.
406102Nenhum programa definido para a operação.
406115O programa não pertence a esse lote.
409030A quantidade máxima de cartões por lote foi atingida.
409031A quantidade máxima de cartões por lote diária foi atingida.
409110O programa não informa o dia do pagamento.

Além disso, este endpoint também poderá retornar erros comuns entre todos os endpoints.

Eventos

Este endpoint não possui eventos relacionados a ele.