Retornar Cash-In por Filtros

Esta rota será usada para buscar operações de cash-in, este endpoint retorna um array contendo objetos de cash-in, classificados a partir da operaçã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/chash-in

Request Query Params

Atributo	Tipo	Descrição
item_id	string	Filtrar por um ID específico de cobrança/pedido.
cash_in_id	string	Filtrar por um ID de cash-in específico da Marlim.
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: paid and failed.
customer_document_number	string	Filtrar por CPF de um cliente pagador.
count	int32	Retorna n objetos de cash-in. 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-in" \
-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 operaçõ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 operações retornadas na consulta.
operations	array	Array de objetos contendo as operações de cash-in.

Array Operations

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

Propriedade	Tipo	Descrição
status	string	Representa o estado atual do saque. Valores possíveis: paid, failed, cancelled e expired.
cash_in_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 cobrado do cliente pagante.
paid_amount	int32 || float	Valor pago pelo cliente pagante.
customer_name	string	Nome do cliente pagante.
customer_document_number	string	Número do documento do cliente pagador.

info

Quando uma resposta é retornada usando os filtros acima, os campos pix_copy_paste e pix_image_base64 não são retornados no payload da resposta, porque são strings muito grandes. Para obter esses dados, será necessário fazer uma nova solicitação no endpoint GET utilizando o ID do Cash-In, que descrevemos na página Read Cash-In por ID.

Exemplos

10 últimas operações de cash-in

Request

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

Response200

{
  "total": 150,
  "page": 1,
  "offset": 15,
  "operations": [
    {
      "status": "active",
      "cash_in_id": "os7WT0bCGbWxAjAv2eT6",
      "item_id": "123456789",
      "date_created": "2023-10-05T12:51:47.446Z",
      "date_updated": "2023-10-05T12:51:47.446Z",
      "amount": 10,
      "paid_amount": 0,
      "customer_name": "Luke Skywalker",
      "customer_document_number": "00099988877"
    },
    {
      "status": "paid",
      "cash_in_id": "rGcsz08YXVpjWu9908w3",
      "item_id": "987654321",
      "date_created": "2023-10-05T12:51:47.446Z",
      "date_updated": "2023-10-05T12:51:47.446Z",
      "amount": 100,
      "paid_amount": 100,
      "customer_name": "Leia S. O. Solo",
      "customer_document_number": "99988877766"
    },
    {
      "status": "expired",
      "cash_in_id": "NiKhnskL91jWu3vzmugd",
      "item_id": "129834765",
      "date_created": "2023-10-05T12:51:47.446Z",
      "date_updated": "2023-10-05T12:51:47.446Z",
      "amount": 199.25,
      "paid_amount": 0,
      "customer_name": "Lord Darth Vader",
      "customer_document_number": "00066699966"
    },
    {
      "+7n": "..."
    }
  ]
}