Pular para o conteúdo principal
Version: v2

Retornar Transações

Retorna um array contendo objetos de transações, ordenadas a partir da transação realizada mais recentemente. Caso não seja passado nenhum filtro, retona um array de objetos contendo as últimas 10 transações da sua empresa realizadas com a Marlim, sejam elas pagas (paid), revisão manual (review), recusadas (refused), estornadas (refunded), rejeitadas (rejected) ou pedido de devolução (chargeback).

GETv2/transactions

Request Query Params​

AtributoTipoDescrição
transaction_idstringFiltro por uma Transação de ID Específico.
date_createddateTimeFiltro para Data de Criação.
date_updateddateTimeFiltro para Data de Atualização.
statusstringFiltro por Status da Transação: Valores aceitos: paid, review, refused, refunded, rejected e chargeback.
countint32Retorna n objetos de transação. Máximo de 1.000 e default de 10.
Nota

Por enquanto a opção de paginação para esse endpoint está em desenvolvimento, deixando o limite de 1.000 transações por request. Pra trazer um resultado mais granular na sua query busque usar uma combinação de filtros, Exemplo: status com date_created em simultâneo.

Tip

A propriedade date_created e date_updated pode ser usada para filtrar buscas em ranges de data utilizando os seguintes prefixos:

PrefixoSignificado
<menor que
>maior que
<=menor ou igual a
>=maior ou igual a
🕹  Buscando transações em um range de data
Request
curl -X GET -G "https://api.crypto.marlim.co/v2/installments" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d date_created=">=1620086400000" \ 
-d date_created="<=1620172799000"
Atenção

A filtragem por data utiliza unixTimeStamp em milissegundos para representá-la. Para gerar o unixTimeStamp de uma data, é possível utilizar o console do Google Chrome com o seguinte código em Javascript: new Date("2022-01-01T00:00:00.000Z").getTime() que retornará 1640995200000.

Response Object​

Ao buscar transações, é retornado um array de objetos. Caso o filtro utilizado não encontre nenhuma transação, é retornado um array vazio.

PropriedadeTipoDescrição
statusstringRepresenta o estado atual da transação. Valores possíveis: paid, review, refused, refunded, rejected e chargeback.
nsustring Código que identifica a transação na adquirente.
date_createddateTimeData de criação da transação no formato ISODateTime.
date_updateddateTimeData de atualização do status da transação no formato ISODateTime.
net_valueint32Valor em centavos a ser cobrado sem as taxas de adquirência.
authorized_amountint32Valor em centavos autorizado na transação.
paid_amountint32Valor em centavos capturado na transação.
refunded_amountint32Valor em centavos estornado na transação.
installmentsstringNúmero de parcelas em que o cliente pagou.
transaction_idstringNúmero identificador da transação.
card_holder_namestringNome do portador do cartão utilizado no pagamento.
card_brandstringBandeira do cartão utilizado no pagamento. Valores possíveis: visa, mastercard, amex, hipercard e elo.
card_first_digitsstringPrimeiros 6 dígitos do cartão utilizado no pagamento.
card_last_digitsstringÚltimos 4 dígitos do cartão utilizado no pagamento.
acquirer_status_codestringCódigo identificador da resposta do Banco Emissor. Valores possíveis: 0000, 1000, 1011, 1016 e 5000.
acquirer_status_messagestringMensagem referente ao código da resposta do Banco Emissor.

Exemplos​

Request
curl -X GET -G "https://api.crypto.marlim.co/v2/transactions" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
Response200
[
  {
    "status": "paid",
    "nsu": "98765432",
    "date_created": "2024-02-16T19:58:04.454Z",
    "date_updated": "2024-02-16T19:58:04.454Z",
    "net_value": 100000,
    "authorized_amount": 103950,
    "paid_amount": 103950,
    "refunded_amount": 0,
    "installments": "1",
    "transaction_id": "98765432",
    "card_holder_name": "Luke Skywalker",
    "card_brand": "visa",
    "card_first_digits": "555544",
    "card_last_digits": "2222",
    "acquirer_status_code": "0000",
    "acquirer_status_message": "The acquirer captured the amount on the card."
  },
  {
    "status": "review",
    "nsu": "12344321",
    "date_created": "2024-02-16T19:58:04.454Z",
    "date_updated": "2024-02-16T19:58:04.454Z",
    "net_value": 200000,
    "authorized_amount": 211305,
    "paid_amount": 0,
    "refunded_amount": 0,
    "installments": "2",
    "transaction_id": "12344321",
    "card_holder_name": "Leia Skywalker Organa Solo",
    "card_brand": "mastercard",
    "card_first_digits": "444455",
    "card_last_digits": "3333",
    "acquirer_status_code": "0000",
    "acquirer_status_message": "The bank has authorized this amount on the card."
  },
  {
    "status": "refunded",
    "nsu": "55554444",
    "date_created": "2024-02-16T19:58:04.454Z",
    "date_updated": "2024-02-16T19:58:04.454Z",
    "net_value": 300000,
    "authorized_amount": 320341,
    "paid_amount": 0,
    "refunded_amount": 320341,
    "installments": "3",
    "transaction_id": "55554444",
    "card_holder_name": "Lord Darth Vader",
    "card_brand": "amex",
    "card_first_digits": "777788",
    "card_last_digits": "4444",
    "acquirer_status_code": "0000",
    "acquirer_status_message": "The amount has been refunded to the card."
  },
  {
    "status": "refused",
    "nsu": "99988877",
    "date_created": "2024-02-16T19:58:04.454Z",
    "date_updated": "2024-02-16T19:58:04.454Z",
    "net_value": 400000,
    "authorized_amount": 0,
    "paid_amount": 0,
    "refunded_amount": 0,
    "installments": "4",
    "transaction_id": "99988877",
    "card_holder_name": "Jabba the Hutt",
    "card_brand": "elo",
    "card_first_digits": "666999",
    "card_last_digits": "1111",
    "acquirer_status_code": "1011",
    "acquirer_status_message": "Some of the card numbers are incorrect. Check the numbers and try again."
  },
  {
    "+6n": "..."
  }
]