Version: v1

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) ou pedido de devolução (chargeback).

Nota

Transações rejeitadas (rejected) pelo Antifraude Marlim não são retornadas, uma vez que elas são barradas nesse fluxo e com isso não geram nenhuma transação no nosso Adquirente.

GETv1/transactions

Request Query Params

Atributo	Tipo	Descrição
transaction_id	string	Filtro por uma Transação de ID Específico.
date_created	dateTime	Filtro para Data de Criação.
status	string	Filtro por Status da Transação: Valores aceitos: `paid`, `review`, `refused`, `refunded` e `chargeback`.
count	int32	Retorna `n` objetos de transação. Máximo de 1.000 e default de 10.
page	int32	Útil para implementação de uma paginação de resultados.

Tip

A propriedade date_created no endpoint transactions pode ser usada para filtrar buscas em ranges de data utilizando os seguintes prefixos:

Prefixo	Significado
<	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/v1/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, retorna-se um objeto com 4 propriedades: total, page, offset e transactions.

Propriedade	Tipo	Descrição
total	int32	Total de transações que atende ao filtro passado na query.
page	int32	Página atual referente ao `offset` de páginas.
offset	int32	Total de páginas referente ao `count` dividido pelo `total` de transações atendidas nas query.
transactions	array	Array de objetos contendo os dados das transações.

Transactions Array

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

Propriedade	Tipo	Descrição
status	string	Representa o estado atual da transação. Valores possíveis: `paid`, `review`, `refused`, `refunded` e `chargeback`.
authorization_code	string	Código de autorização retornado pelo banco emissor.
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.
net_value	int32	Valor em centavos a ser cobrado sem as taxas de adquirência.
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.
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 por ID
Múltiplos Filtros

Request

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

Response200

{
  "total": 50,
  "page": 1,
  "offset": 5,
  "transactions": [
    {
      "status": "paid",
      "authorization_code": "112233",
      "nsu": "98765432",
      "date_created": "2022-05-04T00:00:00.000Z",
      "date_updated": "2022-05-04T00:00:00.000Z",
      "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",
      "authorization_code": "223344",
      "nsu": "12344321",
      "date_created": "2022-05-04T01:00:00.000Z",
      "date_updated": "2022-05-04T01:00:00.000Z",
      "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",
      "authorization_code": "334455",
      "nsu": "55554444",
      "date_created": "2022-05-04T02:00:00.000Z",
      "date_updated": "2022-05-04T03:00:00.000Z",
      "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",
      "authorization_code": null,
      "nsu": "99988877",
      "date_created": "2022-05-04T04:00:00.000Z",
      "date_updated": "2022-05-04T04:00:00.000Z",
      "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": "0000",
      "acquirer_status_message": "The amount has been refunded to the card."
    },
    {
      "+6n": "..."
    }
  ]
}

Request

curl -X GET -G "https://api.crypto.marlim.co/v1/transactions" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d transaction_id="12344321"

Response200

{
  "total": 1,
  "page": 1,
  "offset": 1,
  "transactions": [
    {
      "status": "review",
      "authorization_code": "223344",
      "nsu": "12344321",
      "date_created": "2022-05-04T01:00:00.000Z",
      "date_updated": "2022-05-04T01:00:00.000Z",
      "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."
    }
  ]
}

Request

curl -X GET -G "https://api.crypto.marlim.co/v1/transactions" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d date_created=">=1651622400000" \ 
-d date_created="<=1651708799999" \ 
-d status="paid" \ 
-d count=100

Response200

{
  "total": 500,
  "page": 1,
  "offset": 5,
  "transactions": [
    {
      "status": "paid",
      "authorization_code": "112233",
      "nsu": "98765432",
      "date_created": "2022-05-04T00:00:00.000Z",
      "date_updated": "2022-05-04T00:00:00.000Z",
      "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."
    },
    {
      "+99n": "..."
    }
  ]
}

Nota

Request Query Params​

Tip

Atenção

Response Object​

Transactions Array​

Exemplos​

Request Query Params

Response Object

Transactions Array

Exemplos