Emissão de cartões em lote

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://sandbox.hiperbanco.com.br/Backoffice/no-name-cards/issue-batch

--request POST 'https://sandbox.hiperbanco.com.br/Backoffice/no-name-cards/issue-batch' \
--header 'version: cutting-edge' \
--header 'User-Agent: Apidog/1.0.0 (https://apidog.com)' \
--header 'Authorization: Bearer 
--data-raw '{
  "cardQuantity": 0,
  "paymentDay": 0,
  "address": {
    "zipCode": "string",
    "address": "string",
    "number": "string",
    "neighborhood": "string",
    "complement": "Apt. 202.",
    "city": "string",
    "state": "string",
    "country": "string"
  }
}'

Cabeçalhos (Headers)

Nome	Propriedade	Descrição
`version`	`cutting-edge`	Obrigatório. Essa propriedade garante que o response da API seja retornado no formato JSON
`Authorization`	`Bearer token`	Obrigató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:

Campo	Tipo	Descrição
`cardQuantity`	`number`	Quantidade de cartões vinculados.
`paymentDay`	`number`	Dia de vencimento do pagamento.
`address`	`object`	Objeto com informações de endereço.
`address.zipCode`	`string`	Código postal (CEP).
`address.address`	`string`	Logradouro.
`address.number`	`string`	Número do endereço.
`address.neighborhood`	`string`	Bairro.
`address.complement`	`string`	Complemento do endereço (ex: apartamento).
`address.city`	`string`	Cidade.
`address.state`	`string`	Estado.
`address.country`	`string`	País.

{
  "cardQuantity": 0,
  "paymentDay": 0,
  "address": {
    "zipCode": "string",
    "address": "string",
    "number": "string",
    "neighborhood": "string",
    "complement": "Apt. 202.",
    "city": "string",
    "state": "string",
    "country": "string"
  }
}

Resposta (Response)

O status code 201 indicará sucesso na requisição.

Sendo bem-sucedido, o retorno irá trazer o seguinte campo em formato JSON:

Nome	Tipo	Descrição	Número máximo de caracteres
lotId	string	Identificador do lote criado.	30

{
  "lotId": "string"
}

Erros

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

Status Code	Código	Mensagem	Descrição
406	DELIVERY_ADDRESS_REQUIRED_FOR_PHYSICAL_CARD	Delivery address must be informed when requesting the physical card	O cartão físico necessita de um endereço para entrega.
406	PROGRAM_DISABLED	Program disable!	O programa está temporariamente desabilitado.
406	PROGRAM_UNDEFINED	Program undefined!	Nenhum programa definido para a operação.
406	PROGRAM_NOT_IN_LOT	Program does not belong to lot	O programa não pertence a esse lote.
409	LOT_MAX_QUANTITY_REACHED	Maximum quantity per lot reached	A quantidade máxima de cartões por lote foi atingida.
409	LOT_DAILY_LIMIT_REACHED	Maximum quantity lot per day reached	A quantidade máxima de cartões por lote diária foi atingida.
409	INVALID_PAYMENT_DAY_FOR_PROGRAM	Program does not have the informed payment day	O programa não informa o dia do pagamento.

Recordamos que esta API também poderá retornar erros comuns entre todos os endpoints que acompanham os erros 400 (se houver).

Eventos

Este endpoint não possui eventos relacionados a ele.