Pular para o conteúdo principal

Retornar Transações

Esta rota será usada para buscar transações do tipo cartão de crédito e pix, 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.

GETv3/transactions

Request Query Params​

AtributoTipoDescrição
transaction_idstringFiltrar por um ID de uma transação específica da Marlim.
statusstringFiltrar por status.

Valores aceitos: paid, review, rejected, refused, expired, failed, refunded e chargeback
payment_methodstringFiltrar por método de pagamento.

Valores aceitos: credit_card e pix
sub_seller_idstringFiltrar por um ID de parceiro.
external_sub_seller_idstringFiltrar por um ID da sua plataforma do seu parceiro de venda.
external_sub_seller_document_numberstringFiltrar por um CNPJ do seu parceiro de venda.
date_createddateTimeFiltrar por data de criação.
date_updateddateTimeFiltrar por data de atualização.
item_idstringFiltrar por um ID específico de cobrança/pedido.
countint32Retorna n objetos de transações. Máximo de 1.000 e padrão de 10.
pageint32Útil para implementar uma paginação de resultados.
Dica

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

AtributoDescrição
<menor que
>maior que
<=menor ou igual a
>=maior ou igual a
Request
curl -X GET -G "https://api.marlim.co/v3/transactions" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d date_created=">=1620086400000" \ 
-d date_created="<=1620172799000"
Atenção

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 transações, retorna um objeto com 4 propriedades: total, page, offset e transactions.

AtributoTipoDescrição
totalint32Total de transações que atendem ao filtro passado na consulta.
pageint32Página atual referente ao offset de páginas.
offsetint32Total de páginas para count dividido por total de transações retornadas na consulta.
transactionsarrayArray de objetos contendo as transações.

Array Transactions​

Se a resposta da consulta for maior ou igual a 1, a propriedade transactions trará um array de objetos com estrutura diferente de acordo com o método de pagamento utilizado (credit_card ou pix). Se o filtro utilizado não encontrar nenhuma transação, um array vazio será retornado.

Credit Card​

PropriedadeTipoDescrição
statusstringRepresenta o estado atual da transação. Valores possíveis: paid, review, rejected, refused, refunded 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.
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 na Marlim.
item_idstringNúmero identificador da transação na sua plataforma.
payment_methodstringMétodo de pagamento utilizado na transação. Valores possíveis: credit_card.
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.
sub_seller_idstringParâmetro opcional que identifica um sub_seller cadastrado na Marlim anteriormente, responsável pela transação.
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.

Pix​

PropriedadeTipoDescrição
statusstringRepresenta o estado atual da transação. Valores possíveis: paid, refunded, failed, expired.
date_createddateTimeData de criação da transação no formato ISODateTime.
date_updateddateTimeData de atualização do status da transação no formato ISODateTime.
item_idstringID da transação na sua plataforma.
transaction_idstringNúmero identificador Marlim da transação.
amountint32Valor em centavos a ser cobrado na transação.
payout_amountint32Valor em centavos a ser repassado.
payment_methodstringMétodo de pagamento utilizado na transação. Valores possíveis: pix.
paid_amountint32Valor em centavos capturado na transação.
refunded_amountint32Valor em centavos estornado na transação.
customer_namestringNome do cliente que realizou a transação.
customer_document_numberstringDocumento (CPF) do cliente formatado.
pix_copy_pastestring | nullCódigo Pix Copia e Cola que deve ser apresentado ao cliente para pagamento. Retorna null quando a transação falha ou é rejeitada.

Exemplos​

Request
curl -X GET -G "https://api.marlim.co/v3/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": "2025-08-13T15:40:43.140Z",
      "date_updated": "2025-08-13T16:40:43.140Z",
      "authorized_amount": 100000,
      "paid_amount": 100000,
      "refunded_amount": 0,
      "item_id": "ABC987654321",
      "payment_method": "credit_card",
      "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": "review",
      "nsu": "032416400102",
      "date_created": "2025-08-13T15:40:43.140Z",
      "date_updated": "2025-08-13T16:40:43.140Z",
      "authorized_amount": 100000,
      "paid_amount": 0,
      "refunded_amount": 0,
      "item_id": "ABC987654321",
      "payment_method": "credit_card",
      "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": "refunded",
      "date_created": "2025-08-13T15:40:43.140Z",
      "date_updated": "2025-08-13T16:40:43.140Z",
      "transaction_id": "q7DzyuTuu0mgmKqXjljD",
      "item_id": "ABC987654321",
      "payment_method": "pix",
      "amount": 1048,
      "payout_amount": 1048,
      "paid_amount": 0,
      "refunded_amount": 1048,
      "customer_name": "João da Silva",
      "customer_document_number": "02863937006",
      "pix_copy_paste": "00020126360014br.gov.bcb.pix0114+5511999999995204000053039865802BR5920Nome Exemplo da Silva6009SAO PAULO62070503***6304ABCD"
    },
    {
      "status": "rejected",
      "nsu": null,
      "date_created": "2025-08-13T15:40:43.140Z",
      "date_updated": "2025-08-13T16:40:43.140Z",
      "authorized_amount": 0,
      "paid_amount": 0,
      "refunded_amount": 0,
      "item_id": "ABC987654321",
      "payment_method": "credit_card",
      "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": "failed",
      "date_created": "2025-08-13T15:40:43.140Z",
      "date_updated": "2025-08-13T16:40:43.140Z",
      "transaction_id": "q7DzyuTuu0mgmKqXjljD",
      "item_id": "ABC987654321",
      "payment_method": "pix",
      "amount": 1048,
      "payout_amount": 0,
      "paid_amount": 0,
      "refunded_amount": 0,
      "customer_name": "João da Silva",
      "customer_document_number": "02863937006",
      "pix_copy_paste": null
    },
    {
      "status": "refused",
      "nsu": "032416400102",
      "date_created": "2025-08-13T15:40:43.140Z",
      "date_updated": "2025-08-13T16:40:43.140Z",
      "authorized_amount": 0,
      "paid_amount": 0,
      "refunded_amount": 0,
      "item_id": "ABC987654321",
      "payment_method": "credit_card",
      "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": "refunded",
      "nsu": "032416400102",
      "date_created": "2025-08-13T15:40:43.140Z",
      "date_updated": "2025-08-13T16:40:43.140Z",
      "authorized_amount": 100000,
      "paid_amount": 0,
      "refunded_amount": 100000,
      "item_id": "ABC987654321",
      "payment_method": "credit_card",
      "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": "..."
    }
  ]
}