Consulta de transações por cartão

Este endpoint possibilita realizar a consulta das transações realizadas no cartão de acordo com os filtros informados.

Pré-requisito

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

• O cliente do parceiro Bankly possua um cartão emitido.

Requisição

Requisição HTTP

GET https://api-mtls.sandbox.bankly.com.br/cards/proxy/transactions

     --request GET \
     --url 'https://api-mtls.sandbox.bankly.com.br/cards/{proxy}/transactions?page={pageNumber}&pageSize={numberOfItems}&startDate={yyyy-mm-dd}&endDate={yyyy-mm-dd}' \
     --header 'Authorization: {Bearer}' \
     --header 'accept: application/json' \
     --header 'api-version: 1.0'

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:

Cabeçalhos (Headers)

Parâmetros da rota (Path)

No path desta requisição envie os seguintes campos:

🚧

Importante

A diferença entre a data de início e de fim deverá ser de, no máximo, sete dias.

Corpo da requisição (Body)

Não é necessário enviar campos no body desta requisição.

Resposta (Response)

O status code 200 indicará que a solicitação foi aceita e trará uma lista de transações pertencentes ao cartão, além das propriedades referentes à paginação da consulta.

Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

[
  {
    "nextPage": "mkzjfhcnnhat84y583hguim49801",
    "hasLastPage": true,
    "transactions": [
       {
        "account": {
          "number": "000231",
          "agency": "0001"
        },
        "amount": {
          "value": 138.54,
          "local": 138.54,
          "net": 138.54,
          "iof": 0,
          "markup": 0
        },
        "merchant": {
          "id": "207001540000011",
          "name": "EC*MERCADOLIVRE",
          "mcc": "0101",
          "city": "SAO PAULO"
        },
        "authorization code": "823912",
        "countryCode": "BR",
        "currencyCode": "986",
        "entryMode": "Chip",
        "status": "TransactionHoldWasExpired",
        "transactionTimestamp": "2020-09-24T17:21:39.8921566+00:00",
        "transactionType": "Purchase"
      }
    ]
  }
]

📘

Nota

Caso não haja transações para o cartão informado, será retornado o status code 204.

Status da transação

Identificadores da forma (entryMode)

👍

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.