Retornar Cash-Out por Filtros

Esta rota será usada para buscar operações de transferência, este endpoint retorna um array contendo objetos de cash-out, classificados a partir da transferência realizada mais recentemente.

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

GETv1/chash-out

Request Query Params

Atributo	Tipo	Descrição
item_id	string	Filtrar por um ID específico de cobrança/pedido.
cash_out_id	string	Filtrar por um ID de cash-out de marlim específico.
date_created	dateTime	Filtrar por data de criação.
date_updated	dateTime	Filtrar por data de atualização.
status	string	Filtrar por status. Valores aceitos: `processing`, `fulfilled`, `pending`, `failed` e `cancelled`.
customer_document_number	string	Filtrar por documento CPF do usuário titular de conta de transferência.
count	int32	Retorna `n` objetos de cash-out. 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.pix.marlim.co/v1/chash-out" \
-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-out, retorna um objeto com 4 propriedades: total, page, offset e operations.

Atributo	Tipo	Descrição
total	int32	Total de operações que atendem ao filtro passado na consulta.
page	int32	Página atual referente ao `offset` das páginas.
offset	int32	Total de páginas para `count` dividido por `total` de operações tratadas no consultas.
operations	array	Array de objetos contendo dados de cash-out.

Operations Array

Se a resposta da consulta for maior ou igual a 1, dentro da propriedade operations, este é o array de objetos que você recebe como resposta. Se o filtro utilizado não encontrar nenhuma operação de cash-out, um array vazio será retornado.

Propriedade	Tipo	Descrição
status	string	Representa o estado atual da operação de saque. Valores possíveis: `processing`, `fulfilled`, `pending`, `failed` and `cancelled`.
status_description	string	Descrição para esclarecer sobre o status da transferência.
cash_out_id	string	Número identificador da operação Marlim.
item_id	string	ID de cobrança/pedido em sua plataforma.
date_created	dateTime	Data de criação da operação no formato ISODateTime.
date_updated	dateTime	Data de atualização do status da operação no formato ISODateTime.
amount	int32 \|\| float	Valor a ser transferido para a conta do cliente.
paid_off_amount	int32 \|\| float	Valor final transferido para a conta do cliente de acordo com o status atual.
customer_name	string	Nome da pessoa responsável pela conta de transferência.
customer_document_number	string	Número do documento CPF do responsável pela conta de transferência.

Exemplos

Últimas 10 operações de cash-out

Request

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

Response200

{
  "total": 150,
  "page": 1,
  "offset": 15,
  "operations": [
    {
      "status": "processing",
      "status_description": "The transfer is being processed.",
      "cash_out_id": "BksUV4Bg0BOX3kEqlOsH",
      "item_id": "123456789",
      "date_created": "2023-12-08T17:36:19.742Z",
      "date_updated": "2023-12-08T17:36:19.742Z",
      "amount": 100,
      "paid_off_amount": 0,
      "customer_name": "Luke Skywalker",
      "customer_document_number": "00099988877"
    },
    {
      "status": "pending",
      "status_description": "Transfer created successfully and processed and is pending finalization.",
      "cash_out_id": "a25AwZmhvMagXV6DduCP",
      "item_id": "234567890",
      "date_created": "2023-12-08T17:36:19.742Z",
      "date_updated": "2023-12-08T17:36:19.742Z",
      "amount": 1000.5,
      "paid_off_amount": 0,
      "customer_name": "Lord Darth Vader",
      "customer_document_number": "00066699966"
    },
    {
      "status": "fulfilled",
      "status_description": "Transfer completed successfully and the amount was transferred to the customer's account.",
      "cash_out_id": "1xC3EH9OKNLk9GH5FfA1",
      "item_id": "345678901",
      "date_created": "2023-12-08T17:36:19.742Z",
      "date_updated": "2023-12-08T17:36:19.742Z",
      "amount": 250,
      "paid_off_amount": 250,
      "customer_name": "Leia S. O. Solo",
      "customer_document_number": "99988877766"
    },
    {
      "status": "failed",
      "status_description": "The bank informed us that there was a failure during the transfer.",
      "cash_out_id": "xRNlaNykjED2WU1tkVqo",
      "item_id": "456789012",
      "date_created": "2023-12-08T17:36:19.742Z",
      "date_updated": "2023-12-08T17:36:19.742Z",
      "amount": 250,
      "paid_off_amount": 0,
      "customer_name": "Wookiee Chewbacca",
      "customer_document_number": "66600066699"
    },
    {
      "+6n": "..."
    }
  ]
}

Request Query Params​

Response Object​

Operations Array​

Exemplos​

Request Query Params

Response Object

Operations Array

Exemplos