Consulta de lotes
stable pré
Este endpoint possibilita realizar a consulta de todos os lotes de cartões solicitados por uma determinada company key (chave que identifica o parceiro dentro do Bankly).
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 (Request)
Requisição HTTP
GET https://api-mtls.sandbox.bankly.com.br/cards/batches
--request GET \
--url 'https://api-mtls.sandbox.bankly.com.br/cards/batches' \
--header 'Authorization: Bearer {token}' \
--header 'accept: application/json' \
--header 'api-version: 1'
--data '{
[
{
"lotId": "LT2",
"quantityOrder": 100,
"dateOrder": "2022-04-01T14:46:02.6980536Z",
"programId": 489
},
{
"lotId": "LT4",
"quantityOrder": 100,
"dateOrder": "2022-04-06T16:01:40.4673261Z",
"programId": 489
},
{
"lotId": "LT7",
"quantityOrder": 50,
"dateOrder": "2022-04-14T12:15:47.3895717Z",
"programId": 489
},
{
"lotId": "LT8",
"quantityOrder": 50,
"dateOrder": "2022-04-14T18:12:34.6174675Z",
"programId": 489
},
{
"lotId": "LT10",
"quantityOrder": 50,
"dateOrder": "2022-04-18T13:41:49.1995198Z",
"programId": 489
}
]'
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)
Não é necessário enviar parâmetros no path desta requisição.
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á uma lista com todos os lotes e suas informações.
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. |
[
{
"lotId": "LT2",
"quantityOrder": 100,
"dateOrder": "2022-04-01T14:46:02.6980536Z",
"programId": 489
},
{
"lotId": "LT4",
"quantityOrder": 100,
"dateOrder": "2022-04-06T16:01:40.4673261Z",
"programId": 489
},
{
"lotId": "LT7",
"quantityOrder": 50,
"dateOrder": "2022-04-14T12:15:47.3895717Z",
"programId": 489
},
{
"lotId": "LT8",
"quantityOrder": 50,
"dateOrder": "2022-04-14T18:12:34.6174675Z",
"programId": 489
},
{
"lotId": "LT10",
"quantityOrder": 50,
"dateOrder": "2022-04-18T13:41:49.1995198Z",
"programId": 489
}
]
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 16 days ago