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:
| Scope | Descrição |
|---|---|
card.read | Concede acesso para consulta de transações por cartão. |
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 | Especificação |
|---|---|---|---|
proxy | path | Obrigatório. Código identificador do cartão. | — |
page | query | Nú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. | — |
pageSize | query | Quantidade de itens a serem exibidos por página. | Valor máximo permitido: 100. |
startDate | query | Obrigató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. |
endDate | query | Obrigató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:
| Nome | Tipo | Descrição |
|---|---|---|
nextPage | string | Identificador da próxima página. |
hasLastPage | string | Indica se existe a próxima página na consulta. |
transactions[] | array of objects | Lista de objetos contendo informações sobre as transações. |
transactions[].account | object | Objeto que contém informações sobre a conta vinculada ao cartão. |
transactions[].account.number | string | Número da conta na qual o cartão foi transacionado. |
transactions[].account.agency | string | Agência da conta na qual o cartão foi transacionado. |
transactions[].amount | object | Objeto que contém informações sobre o valor da transação. |
transactions[].amount.value | number | Valor total da transação. |
transactions[].amount.local | number | Valor da transação na moeda local. |
transactions[].amount.net | number | Valor líquido da transação. |
transactions[].amount.iof | number | Valor do imposto de operações financeira. |
transactions[].amount.markup | number | Tarifa de conversão de moeda (em caso de compras internacionais). |
transactions[].merchant | object | Objeto que contém informações sobre o local em que ocorreu a transação. |
transactions[].merchant.id | string | Identificador do comerciante. |
transactions[].merchant.name | string | Nome do comerciante. |
transactions[].merchant.mcc | string | MCC (Merchant Category Code) é um número de quatro dígitos listado na ISO 18245 para serviços financeiros de varejo. |
transactions[].merchant.city | string | Cidade onde ocorreu a transação. |
transactions[].authorizationCode | string | Identificador da transação na adquirente. |
transactions[].countryCode | string | Código do país onde ocorreu a transação. |
transactions[].currencyCode | string | Código da moeda, com base na ISO-4217, na qual foi realizada a transação. |
transactions[].entryMode | string | Identificador da forma pela qual a transação foi realizada ou a forma de pagamento. Confira a lista com os possíveis identificadores. |
transactions[].status | string | Situação da transação. Confira a lista com os possíveis status da transação. |
transactions[].transactionTimestamp | string | Data em que ocorreu a transação, no formato 'ISO 8601 - UTC'. |
transactions[].transactionType | string | Indica 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ódigo | Descrição |
|---|---|
| TransactionHoldWasReproved | A retenção da transação foi reprovada. |
| TransactionHoldWasApproved | A retenção da transação foi aprovada. |
| TransactionWasReversed | Transação revertida. |
| TransactionHoldWasExpired | A retenção da transação foi expirada. |
| TransactionWasConfirmed | Transação confirmada. |
| TransactionWasReversedInSecondInstance | A transação foi revertida em segunda instância. |
| TransactionVoucherWasCreated | O voucher (crédito) foi lançado na conta do cliente. |
Identificadores da forma (entryMode)
entryMode)| Código | Descrição |
|---|---|
| Unknown | Modo de entrada do PAN desconhecido. |
| Manual | Entrada do PAN manual. |
| MagneticStripe | Entrada 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. |
| BarCodeReader | Entrada automática via leitor de código de barras. |
| OCR | Entrada automática de PAN via leitor óptico de caracteres (OCR). |
| Chip | Entrada automática de PAN via chip. |
| ContactlessObsolete | Contactless obsoleto. |
| ContactlessMChip | Entrada automática de PAN via M/Chip sem contato. |
| ContactlessMChipObsolete | Contactless MChip obsoleto. |
| EletronicCommerce | Entrada de PAN/Token via comércio eletrônico contendo criptograma DSRP em DE 55 (Integrated Circuit Card [ICC] System-Related Data). |
| CredentialOnFile | Credencial em arquivo. |
| HybridTerminalFailedConnection | Um 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. |
| ChipCapableTerminal | O cartão com chip não foi capaz de processar/leitura da tarja magnética padrão. |
| EletronicCommerceSecureWithUCAF | Entrada de PAN/Token via comércio eletrônico com opcional Identity Check-AAV ou criptograma DSRP em UCAF. |
| Server | Entrada automática de PAN via servidor (sistema emissor, adquirente ou fornecedor terceirizado). |
| MagneticStripeFullTrackData | A tarja magnética lê e extrai o conteúdo da Faixa 1 ou Faixa 2 incluída (a verificação CVV é possível). |
| ContactlessMagneticStripe | Entrada automática do número da conta via tarja magnética sem contato. |
| ContactlessInput | --- |
| Visa | Apenas 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.
Updated 4 months ago