Sign in

v1

latestOpenAPI 3.1.02026-07-26477322.4 KB

Obter recebíveis

Retorna os recebíveis da sua loja.

get/payables

Query parameters

created_sincestring date

Filtro pela data de criação do recebível como data de partida. Quando não informado, o padrão é a data atual menos 6 meses

created_untilstring date

Filtro pela data de criação do recebível como data limite

statusstring

Filtro pelo status do recebível, paid ou waiting_funds

payment_date_sincestring date

Filtro pela data de pagamento do recebível, como data de partida

payment_date_untilstring date

Filtro pela data de pagamento do recebível, como data limite

typestring

Filtro pelo type do recebível. Pode ser chargeback, refund, chargeback_refund ou credit

updated_sincestring date

Filtro pela data de atualização do recebível, como data de partida

updated_untilstring date

Filtro pela data de atualização do recebível, como data limite

charge_idstring

Filtro pelo código da cobrança

recipient_idstring

Filtro pelo código do recebedor

split_idstring

Filtro pelo identificador da regra de split

idstring

Filtro pelo identificador do recebível

sizeinteger

Filtro pela quantidade de objetos retornados. Deve ser menor ou igual a 1000

pageinteger

Filtro pela página de retorno. Utilize o parâmetro forward_cursor para paginação

forward_cursorstring

Cursor para retorno da próxima página, seu valor é retornado no corpo da resposta em paging.forward_cursor

Response

200

OR

Example response

{
  "data": [
    {
      "id": 4304241393,
      "status": "waiting_funds",
      "amount": 3090,
      "fee": 155,
      "installment": 1,
      "charge_id": "ch_xj9w8g8CEdhOX0BM",
      "recipient_id": "re_cjlnpqrq0006vn56e1nig0tcv",
      "payment_date": "2023-08-03T03:00:00Z",
      "type": "credit",
      "payment_method": "credit_card",
      "accrual_at": "2023-07-03T13:06:21Z",
      "created_at": "2023-07-03T13:06:22Z"
    }
  ]
}