Consulta de transações por cartão

stable pós

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:

ScopeDescrição
card.readConcede acesso para consulta de transações por cartão.

Cabeçalhos (Headers)

NomeDescrição
api-versionObrigatório. Versão da API. Atualmente estamos na versão 1.0.
authorizationObrigatório. Token de autorização do tipo Bearer.

Parâmetros da rota (Path)

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

NomeTipoDescriçãoEspecificação
proxypathObrigatório. Código identificador do cartão.
pagequeryNúmero da página que se quer consultar. Para realizar a consulta da primeira página, não envie esse parâmetro na requisição.
pageSizequeryQuantidade de itens a serem exibidos por página.Valor máximo permitido: 100.
startDatequeryObrigatório. Data inicial da consulta. Utilize esse campo em conjunto com o parâmetro endDate para filtrar eventos por um range de datas.Formato yyyy-mm-dd. Caso necessário, poderá ser feito um filtro incluindo o horário, no formato ISO 8601 - UTC.
endDatequeryObrigatório. Data final da consulta. Utilize esse campo em conjunto com o parâmetro startDate para filtrar eventos por um range de datas.Formato yyyy-mm-dd. Caso necessário, poderá ser feito um filtro incluindo o horário, no formato ISO 8601 - UTC.

🚧

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:

NomeTipoDescrição
nextPagestringIdentificador da próxima página.
hasLastPagestringIndica se existe a próxima página na consulta.
transactions[]array of objectsLista de objetos contendo informações sobre as transações.
transactions[].accountobjectObjeto que contém informações sobre a conta vinculada ao cartão.
transactions[].account.numberstringNúmero da conta na qual o cartão foi transacionado.
transactions[].account.agencystringAgência da conta na qual o cartão foi transacionado.
transactions[].amountobjectObjeto que contém informações sobre o valor da transação.
transactions[].amount.valuenumberValor total da transação.
transactions[].amount.localnumberValor da transação na moeda local.
transactions[].amount.netnumberValor líquido da transação.
transactions[].amount.iofnumberValor do imposto de operações financeira.
transactions[].amount.markupnumberTarifa de conversão de moeda (em caso de compras internacionais).
transactions[].merchantobjectObjeto que contém informações sobre o local em que ocorreu a transação.
transactions[].merchant.idstringIdentificador do comerciante.
transactions[].merchant.namestringNome do comerciante.
transactions[].merchant.mccstringMCC (Merchant Category Code) é um número de quatro dígitos listado na ISO 18245 para serviços financeiros de varejo.
transactions[].merchant.citystringCidade onde ocorreu a transação.
transactions[].authorizationCodestringIdentificador da transação na adquirente.
transactions[].countryCodestringCódigo do país onde ocorreu a transação.
transactions[].currencyCodestringCódigo da moeda, com base na ISO-4217, na qual foi realizada a transação.
transactions[].entryModestringIdentificador da forma pela qual a transação foi realizada ou a forma de pagamento. Confira a lista com os possíveis identificadores.
transactions[].statusstringSituação da transação. Confira a lista com os possíveis status da transação.
transactions[].transactionTimestampstringData em que ocorreu a transação, no formato 'ISO 8601 - UTC'.
transactions[].transactionTypestringIndica a operação da transação, a qual pode ser "Unknown" (Desconhecida), "Purchase" (Compra), "Withdrawal" (Saque), "Refund" (Reembolso) e "Balance" (Saldo).
[
  {
    "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

CódigoDescrição
TransactionHoldWasReprovedA retenção da transação foi reprovada.
TransactionHoldWasApprovedA retenção da transação foi aprovada.
TransactionWasReversedTransação revertida.
TransactionHoldWasExpiredA retenção da transação foi expirada.
TransactionWasConfirmedTransação confirmada.
TransactionWasReversedInSecondInstanceA transação foi revertida em segunda instância.
TransactionVoucherWasCreatedO voucher (crédito) foi lançado na conta do cliente.

Identificadores da forma (entryMode)

CódigoDescrição
UnknownModo de entrada do PAN desconhecido.
ManualEntrada do PAN manual.
MagneticStripeEntrada automática do PAN via leitura da tarja magnética. Para transações Plus, este código também significa que o conteúdo exato da faixa 2 está incluído e a verificação de CVV é possível.
BarCodeReaderEntrada automática via leitor de código de barras.
OCREntrada automática de PAN via leitor óptico de caracteres (OCR).
ChipEntrada automática de PAN via chip.
ContactlessObsoleteContactless obsoleto.
ContactlessMChipEntrada automática de PAN via M/Chip sem contato.
ContactlessMChipObsoleteContactless MChip obsoleto.
EletronicCommerceEntrada de PAN/Token via comércio eletrônico contendo criptograma DSRP em DE 55 (Integrated Circuit Card [ICC] System-Related Data).
CredentialOnFileCredencial em arquivo.
HybridTerminalFailedConnectionUm terminal híbrido com conexão online com o adquirente falhou no envio de uma transação de chip fallback (em que DE 22, subcampo 1 = 80) ao emissor.
ChipCapableTerminalO cartão com chip não foi capaz de processar/leitura da tarja magnética padrão.
EletronicCommerceSecureWithUCAFEntrada de PAN/Token via comércio eletrônico com opcional Identity Check-AAV ou criptograma DSRP em UCAF.
ServerEntrada automática de PAN via servidor (sistema emissor, adquirente ou fornecedor terceirizado).
MagneticStripeFullTrackDataA tarja magnética lê e extrai o conteúdo da Faixa 1 ou Faixa 2 incluída (a verificação CVV é possível).
ContactlessMagneticStripeEntrada automática do número da conta via tarja magnética sem contato.
ContactlessInput---
VisaApenas Visa – Chip com CVV não confiável.

👍

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.