Operações
Esta rota pode ser utilizada para ler todas as operações de Cash-In e Cash-out utilizando algum filtro específico.
Se nenhum filtro for passado, ele retornará um array de objetos contendo suas últimas 10 operações realizadas com o Marlim.
GETv1/operations
Request Query Params
| Atributo | Tipo | Descrição |
|---|---|---|
| date_created | dateTime | Filtrar por data de criação. |
| date_updated | dateTime | Filtrar por data de atualização. |
| customer_document_number | string | Filtrar por número do documento CPF de um cliente. |
| count | int32 | Retorna n objetos de operação. 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 |
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-In e Cash-Out, retorna um objeto com 4 propriedades: total, page, offset e operations.
| Attribute | Type | Description |
|---|---|---|
| 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 na consultas. |
| operations | array | Array de objetos contendo dados de Cash-In e 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 sua aplicação recebe como resposta. Se o filtro utilizado não encontrar nenhuma operação, um array vazio será retornado.
| Property | Type | Operation | Description |
|---|---|---|---|
| status | string | cash-in || cash-out | Representa o status atual da operação. |
| cash_out_id | string | cash-out | Número identificador da operação Marlim. |
| item_id | string | cash-in || cash-out | ID de cobrança/pedido em sua plataforma. |
| status_description | string | cash-out | Descrição para esclarecer sobre o status da transferência. |
| cash_in_id | string | cash-in | Número identificador de operação na Marlim. |
| date_created | dateTime | cash-in || cash-out | Data de criação da operação no formato ISODateTime. |
| date_updated | dateTime | cash-in || cash-out | Data atualizada do status da operação no formato ISODateTime. |
| amount | int32 || float | cash-in || cash-out | Valor a ser cobrado ou transferido ao cliente. |
| paid_amount | int32 || float | cash-in | Valor pago pelo cliente pagante. |
| paid_off_amount | int32 || float | cash-out | Valor final transferido para a conta do cliente de acordo com a situação atual. |
| customer_name | string | cash-in || cash-out | Nome do cliente. |
| customer_document_number | string | cash-in || cash-out | Número do documento do cliente pagador. |
Exemplos
- Últimas 10 operações
curl -X GET -G "https://api.pix.marlim.co/v1/operations" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
{
"total": 300,
"page": 1,
"offset": 30,
"operations": [
{
"status": "active",
"cash_in_id": "os7WT0bCGbWxAjAv2eT6",
"item_id": "123456789",
"date_created": "2023-10-05T12:51:47.493Z",
"date_updated": "2023-10-05T12:51:47.493Z",
"amount": 10,
"paid_amount": 0,
"customer_name": "Luke Skywalker",
"customer_document_number": "00099988877"
},
{
"status": "processing",
"status_description": "The transfer is being processed.",
"cash_out_id": "BksUV4Bg0BOX3kEqlOsH",
"item_id": "123456789",
"date_created": "2023-10-05T12:51:47.493Z",
"date_updated": "2023-10-05T12:51:47.493Z",
"amount": 100,
"paid_off_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.493Z",
"date_updated": "2023-10-05T12:51:47.493Z",
"amount": 100,
"paid_amount": 100,
"customer_name": "Leia S. O. Solo",
"customer_document_number": "99988877766"
},
{
"status": "pending",
"status_description": "Transfer created successfully and processed and is pending finalization.",
"cash_out_id": "a25AwZmhvMagXV6DduCP",
"item_id": "234567890",
"date_created": "2023-10-05T12:51:47.493Z",
"date_updated": "2023-10-05T12:51:47.493Z",
"amount": 1000.5,
"paid_off_amount": 0,
"customer_name": "Lord Darth Vader",
"customer_document_number": "00066699966"
},
{
"status": "expired",
"cash_in_id": "NiKhnskL91jWu3vzmugd",
"item_id": "129834765",
"date_created": "2023-10-05T12:51:47.493Z",
"date_updated": "2023-10-05T12:51:47.493Z",
"amount": 199.25,
"paid_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-10-05T12:51:47.493Z",
"date_updated": "2023-10-05T12:51:47.493Z",
"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-10-05T12:51:47.493Z",
"date_updated": "2023-10-05T12:51:47.493Z",
"amount": 250,
"paid_off_amount": 0,
"customer_name": "Wookiee Chewbacca",
"customer_document_number": "66600066699"
},
{
"+3n": "..."
}
]
}