Retornar Transações

Esta rota será usada para buscar transações, este endpoint retorna um array contendo objetos de transação, classificados a partir da transação realizada mais recentemente.

Se nenhum filtro for passado, será retorando um array de objetos contendo suas últimas 10 operações realizadas com o Marlim.

GETv1/transactions

Request Query Params

Atributo	Tipo	Descrição
transaction_id	string	Filtrar por um ID de uma transação específica da Marlim.
status	string	Filtrar por status. Valores aceitos: `paid`, `authorized`, `review`, `rejected`, `refused`, `canceled`, `refunded` e `chargeback`
date_created	dateTime	Filtrar por data de criação.
date_updated	dateTime	Filtrar por data de atualização.
item_id	string	Filtrar por um ID específico de cobrança/pedido.
count	int32	Retorna `n` objetos de transações. Máximo de 1.000 e padrão de 10.
page	int32	Útil para implementar uma paginação de resultados.

tip

As propriedades date_created e date_updated podem ser usadas para filtrar pesquisas de intervalo de datas usando os seguintes atributos:

Atributo	Descrição
<	menor que
>	maior que
<=	menor ou igual a
>=	maior ou igual a

Request

curl -X GET -G "https://api.taya.marlim.co/v1/transactions" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d date_created=">=1620086400000" \ 
-d date_created="<=1620172799000"

caution

A filtragem de data usa unixTimeStamp em milissegundos para representá-la. Para gerar o unixTimeStamp de uma data, você pode usar o console do Google Chrome com o seguinte código em Javascript: new Date("2023-01-01T00:00:00.000Z").getTime() que retornará 1672531200000.

Response Object

Ao buscar operações de cash-in, retorna um objeto com 4 propriedades: total, page, offset e operations.

Atributo	Tipo	Descrição
total	int32	Total de transações que atendem ao filtro passado na consulta.
page	int32	Página atual referente ao `offset` de páginas.
offset	int32	Total de páginas para `count` dividido por `total` de transações retornadas na consulta.
transactions	array	Array de objetos contendo as transações.

Array Transactions

Se a resposta da consulta for maior ou igual a 1, dentro da propriedade transactions, este é o array de objetos que sua aplicação recebe como resposta. Se o filtro utilizado não encontrar nenhuma transação, um array vazio será retornado.

Propriedade	Tipo	Descrição
status	string	Representa o estado atual da transação. Valores possíveis: `paid`, `authorized`, `review`, `rejected`, `refused`, `canceled`, `refunded` e `chargeback`.
nsu	string	Código que identifica a transação na Adquirente.
date_created	dateTime	Data de criação da transação no formato ISODateTime.
date_updated	dateTime	Data de atualização do status da transação no formato ISODateTime.
authorized_amount	int32	Valor em centavos autorizado na transação.
paid_amount	int32	Valor em centavos capturado na transação.
refunded_amount	int32	Valor em centavos estornado na transação.
installments	string	Número de parcelas em que o cliente pagou.
transaction_id	string	Número identificador da transação na Marlim.
item_id	string	Número identificador da transação na sua plataforma.
card_holder_name	string	Nome do portador do cartão utilizado no pagamento.
card_brand	string	Bandeira do cartão utilizado no pagamento. Valores possíveis: `visa`, `mastercard`, `amex`, `hipercard` e `elo`.
card_first_digits	string	Primeiros 6 dígitos do cartão utilizado no pagamento.
card_last_digits	string	Últimos 4 dígitos do cartão utilizado no pagamento.
acquirer_status_code	string	Código identificador da resposta do Banco Emissor. Valores possíveis: `0000`, `1000`, `1011`, `1016` e `5000`.
acquirer_status_message	string	Mensagem referente ao código da resposta do Banco Emissor.

Exemplos

10 últimas transações
Filtro Data de Criação
Múltiplos Filtros

Request

curl -X GET -G "https://api.taya.marlim.co/v1/transactions" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \

Response200

{
  "total": 150,
  "page": 1,
  "offset": 15,
  "transactions": [
    {
      "status": "paid",
      "nsu": "032416400102",
      "date_created": "2024-04-08T16:39:09.372Z",
      "date_updated": "2024-04-08T17:39:09.372Z",
      "authorized_amount": 100000,
      "paid_amount": 100000,
      "refunded_amount": 0,
      "item_id": "ABC987654321",
      "installments": 1,
      "transaction_id": "k4m6Rw5rlQszEY7fiuRe",
      "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": "authorized",
      "nsu": "032416400102",
      "date_created": "2024-04-08T16:39:09.372Z",
      "date_updated": "2024-04-08T17:39:09.372Z",
      "authorized_amount": 100000,
      "paid_amount": 0,
      "refunded_amount": 0,
      "item_id": "ABC987654321",
      "installments": 1,
      "transaction_id": "Km62bUqtcvjQ2l6SOXUy",
      "card_holder_name": "Luke Skywalker",
      "card_brand": "visa",
      "card_first_digits": "555544",
      "card_last_digits": "2222",
      "acquirer_status_code": "0000",
      "acquirer_status_message": "The bank has authorized this amount on the card."
    },
    {
      "status": "review",
      "nsu": "032416400102",
      "date_created": "2024-04-08T16:39:09.372Z",
      "date_updated": "2024-04-08T17:39:09.372Z",
      "authorized_amount": 100000,
      "paid_amount": 0,
      "refunded_amount": 0,
      "item_id": "ABC987654321",
      "installments": 1,
      "transaction_id": "fxPaOlyZABICogQuWz0V",
      "card_holder_name": "Luke Skywalker",
      "card_brand": "visa",
      "card_first_digits": "555544",
      "card_last_digits": "2222",
      "acquirer_status_code": "0000",
      "acquirer_status_message": "The bank has authorized this amount on the card."
    },
    {
      "status": "rejected",
      "nsu": null,
      "date_created": "2024-04-08T16:39:09.372Z",
      "date_updated": "2024-04-08T17:39:09.372Z",
      "authorized_amount": 0,
      "paid_amount": 0,
      "refunded_amount": 0,
      "item_id": "ABC987654321",
      "installments": 1,
      "transaction_id": "JO0uj0yp0mztpStgKDgf",
      "card_holder_name": "Luke Skywalker",
      "card_brand": "visa",
      "card_first_digits": "555544",
      "card_last_digits": "2222",
      "acquirer_status_code": null,
      "acquirer_status_message": null
    },
    {
      "status": "refused",
      "nsu": "032416400102",
      "date_created": "2024-04-08T16:39:09.372Z",
      "date_updated": "2024-04-08T17:39:09.372Z",
      "authorized_amount": 0,
      "paid_amount": 0,
      "refunded_amount": 0,
      "item_id": "ABC987654321",
      "installments": 1,
      "transaction_id": "kWfa0mYzcxNWrxP8i4UD",
      "card_holder_name": "Luke Skywalker",
      "card_brand": "visa",
      "card_first_digits": "555544",
      "card_last_digits": "2222",
      "acquirer_status_code": "1011",
      "acquirer_status_message": "Some of the card numbers are incorrect. Check the numbers and try again."
    },
    {
      "status": "canceled",
      "nsu": "032416400102",
      "date_created": "2024-04-08T16:39:09.372Z",
      "date_updated": "2024-04-08T17:39:09.372Z",
      "authorized_amount": 0,
      "paid_amount": 0,
      "refunded_amount": 100000,
      "item_id": "ABC987654321",
      "installments": 1,
      "transaction_id": "FXNcs0BUdQQsBbHonS5b",
      "card_holder_name": "Luke Skywalker",
      "card_brand": "visa",
      "card_first_digits": "555544",
      "card_last_digits": "2222",
      "acquirer_status_code": "0000",
      "acquirer_status_message": "The amount has been refunded to the card."
    },
    {
      "status": "refunded",
      "nsu": "032416400102",
      "date_created": "2024-04-08T16:39:09.372Z",
      "date_updated": "2024-04-08T17:39:09.372Z",
      "authorized_amount": 100000,
      "paid_amount": 0,
      "refunded_amount": 100000,
      "item_id": "ABC987654321",
      "installments": 1,
      "transaction_id": "qBLC0ZRA4i6Mdx3SdLsp",
      "card_holder_name": "Luke Skywalker",
      "card_brand": "visa",
      "card_first_digits": "555544",
      "card_last_digits": "2222",
      "acquirer_status_code": "0000",
      "acquirer_status_message": "The amount has been refunded to the card."
    },
    {
      "+3n": "..."
    }
  ]
}

Request

curl -X GET -G "https://api.taya.marlim.co/v1/transactions" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d date_created=">=1712488080000" \ 
-d date_created="<=1712488320000"

Response200

{
  "total": 2,
  "page": 1,
  "offset": 1,
  "transactions": [
    {
      "status": "paid",
      "nsu": "032416400102",
      "date_created": "2024-04-08T16:39:09.372Z",
      "date_updated": "2024-04-08T17:39:09.372Z",
      "authorized_amount": 100000,
      "paid_amount": 100000,
      "refunded_amount": 0,
      "item_id": "ABC987654321",
      "installments": 1,
      "transaction_id": "k4m6Rw5rlQszEY7fiuRe",
      "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": "authorized",
      "nsu": "032416400102",
      "date_created": "2024-04-08T16:39:09.372Z",
      "date_updated": "2024-04-08T17:39:09.372Z",
      "authorized_amount": 100000,
      "paid_amount": 0,
      "refunded_amount": 0,
      "item_id": "ABC987654321",
      "installments": 1,
      "transaction_id": "Km62bUqtcvjQ2l6SOXUy",
      "card_holder_name": "Luke Skywalker",
      "card_brand": "visa",
      "card_first_digits": "555544",
      "card_last_digits": "2222",
      "acquirer_status_code": "0000",
      "acquirer_status_message": "The bank has authorized this amount on the card."
    }
  ]
}

Request

curl -X GET -G "https://api.taya.marlim.co/v1/transactions" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d date_created=">=1712488080000" \ 
-d date_created="<=1712488320000" \ 
-d status="paid" \ 
-d count=10 \ 
-d page=1

Response200

{
  "total": 250,
  "page": 1,
  "offset": 25,
  "transactions": [
    {
      "status": "paid",
      "nsu": "032416400102",
      "date_created": "2024-04-08T16:39:09.372Z",
      "date_updated": "2024-04-08T17:39:09.372Z",
      "authorized_amount": 100000,
      "paid_amount": 100000,
      "refunded_amount": 0,
      "item_id": "ABC987654321",
      "installments": 1,
      "transaction_id": "k4m6Rw5rlQszEY7fiuRe",
      "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": "paid",
      "nsu": "032416400102",
      "date_created": "2024-04-08T16:39:09.372Z",
      "date_updated": "2024-04-08T17:39:09.372Z",
      "authorized_amount": 100000,
      "paid_amount": 100000,
      "refunded_amount": 0,
      "item_id": "ABC987654321",
      "installments": 1,
      "transaction_id": "Km62bUqtcvjQ2l6SOXUy",
      "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."
    },
    {
      "+8n": "..."
    }
  ]
}

Request Query Params​

Response Object​

Array Transactions​

Exemplos​

Request Query Params

Response Object

Array Transactions

Exemplos