Consulta de lote por id
stable pré
Este endpoint possibilita realizar a consulta dos dados de um lote específico de cartões pelo seu identificador único (lotId).
Pré-requisito
Para que seja possível utilizar este endpoint, é necessário que:
- O parceiro tenha emitido pelo menos um lote de cartões.
Requisição
Requisição HTTP
GET https://api-mtls.sandbox.bankly.com.br/cards/batches/{lotId}
--request GET \
--url 'https://api-mtls.sandbox.bankly.com.br/cards/batches/:lotId' \
--header 'Authorization: Bearer {token}' \
--header 'accept: application/json' \
--header 'api-version: 1'
--data '{
"lotId": "LT01",
"quantityOrder": 1000,
"companyKey": "Acesso",
"dateOrder": "2021-06-07T08:30:40",
"programId": 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"
},
"cards": [
"2500011000021160417",
"2500011000068618940"
]
}'
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:
| Scope | Descrição |
|---|---|
card.read | Concede acesso para consultar um lote, ou lotes, de cartões. |
Cabeçalhos (Headers)
| Nome | Descrição |
|---|---|
api-version | Obrigatório. Versão da API. Atualmente estamos na versão 1.0. |
Authorization | Obrigatório. Token de autorização do tipo Bearer. |
Parâmetros da rota (Path)
No path desta requisição envie os seguintes campos:
| Nome | Tipo | Descrição |
|---|---|---|
lotId | path | Obrigatório. Identificador do lote a ser consultado (retornado no endpoint de Criação de cartões em lote). |
Corpo da requisição (Body)
Não é necessário enviar campos no body desta requisição.
Resposta (Response)
O status code 200 indicará sucesso na consulta e trará um objeto com o as informações do lote.
Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:
| Nome | Tipo | Descrição |
|---|---|---|
lotId | string | Valor identificador do lote. |
quantityOrder | integer | Quantidade de cartões solicitados. |
dateOrder | string | Data da solicitação de criação do lote, no formato ISO 8601 - UTC. |
programId | integer | Identificador do programa vinculado ao cartão. |
address | object | Objeto que deverá conter informações sobre o endereço do titular do cartão ao qual deve ser realizado a entrega. |
address.zipCode | string | Código postal do endereço. |
address.address | string | Logradouro (nome da rua, avenida etc.). |
address.number | string | Número do prédio ou da casa. |
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. |
cards | arrays of strings | Lista de proxy dos cartões desse lote. |
{
"lotId": "LT01",
"quantityOrder": 1000,
"dateOrder": "2021-06-07T08:30:40",
"programId": 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"
},
"cards": [
"2500011000021160417",
"2500011000068618940"
]
}
Dica
Para simular uma requisição nesse endpoint, acesse o API Reference.
Erros
Este endpoint não retorna erros específicos. Porém, ele poderá retornar alguns erros comuns entre todos os endpoints.
Eventos
Este endpoint não possui eventos relacionados a ele.
Updated 2 months ago