Consulta de lote por id

Este endpoint possibilita realizar a consulta dos dados de um lote específico de cartões pelo seu identificador único (lotId).

Etapas

Endpoint

Para utilizar este endpoint, é obrigatório informar o campo a seguir:

Path

lotId: identificador do lote a ser consultado (retornado no endpoint de Criação de cartões em lote).

curl --location --request GET 
--url 'https://api-mtls.sandbox.bankly.com.br/cards/batches/:{{lotId}}' \  
--header 'api-version: 1' \  
--header 'Authorization: Bearer {{accessToken}}' \  
--header 'Content-Type: application/json' \

Retorno

O status code 200 indicará sucesso na consulta. O retorno trará um objeto com os seguintes campos:

lotId: valor identificador do lote;
quantityOrder: quantidade de cartões solicitados;
dateOrder: data da solicitação de criação do lote;
programId: identificador do programa vinculado ao cartão;
address: objeto contendo campos com os dados do endereço para onde esse lote será enviado (zipCode, address, number, neighborhood, complement, city, state, country);
cards: lista de proxy dos cartões desse lote.

{
   "lotId": "LT30",
   "quantityOrder": 100,
   "dateOrder": "2022-09-08T19:06:37.5780468Z",
   "programId": 489,
   "address": {
      "zipCode": "05402100",
      "address": "Av Rebouças",
      "number": "1368",
      "neighborhood": "Pinheiros",
      "complement": "3o Andar",
      "city": "São Paulo",
      "state": "SP",
      "country": "BR"
   },
   "cards": [
      "3200321000770442126",
      "3200321000962629011",
      "3200321000957150854",
      "3200321000680883174",
      "3200321000231840060",
      "3200321000089627480",
      "3200321000348866540",
      "3200321000158694454",
      "3200321000615875014",
      "3200321000173318972",
      "3200321000942782906",
      "3200321000460594068",
      "3200321000362664762",
      "3200321000099333233",
      "3200321000575255231",
      "3200321000452408498",
      "3200321000711962232",
      "3200321000056752668",
      "3200321000470246461",
      "3200321000238497469",
      "3200321000965009693",
      "3200321000047349104",
      "3200321000864564055",
      "3200321000968008752",
      "3200321000772450614",
      "3200321000380930703",
      "3200321000193062620",
      "3200321000793548389",
      "3200321000845186717",
      "3200321000364037480",
      "3200321000085527715",
      "3200321000343362543",
      "3200321000963979040",
      "3200321000658102424",
      "3200321000244511966",
      "3200321000824491421",
      "3200321000978504965",
      "3200321000932600058",
      "3200321000896846153",
      "3200321000990591627",
      "3200321000328028336",
      "3200321000092116229",
      "3200321000474230055",
      "3200321000597783001",
      "3200321000957433880",
      "3200321000490245614",
      "3200321000084752065",
      "3200321000195168841",
      "3200321000200637808",
      "3200321000665122680",
      "3200321000713751204",
      "3200321000342103633"
   ]
}

Erros

Status code	Código	Descrição
400	INVALID_PARAMETER	Conteúdo da requisição não está de acordo com o esperado. Exemplos: tamanho de campo, tipo ou conteúdo obrigatório.
401	UNAUTHORIZED	Sem autorização para realizar a solicitação.
404	116	Não foram encontrados lotes para essa company key.
500	014	Ocorrência de erro inesperado.