These docs are for v3. Click to read the latest docs for v5.

Retornando recebíveis

Retorna os recebíveis da sua empresa.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

Filtros

Todos os filtros mencionados podem ser usados para buscas em ranges usando os prefixos:

PrefixoSignificado
<menor que
>maior que
<=menor ou igual a
>=maior ou igual a

Por exemplo, para buscar em um range de date_created:

curl -X GET https://api.pagar.me/1/payables \
-d 'api_key=ak_test_grXijQ4GicOa2BLGZrDRTR5qNQxJW0'
-d 'created_at=>=1483236000000'
-d 'created_at=<=1484689847590'

Para campos que sejam strings, a comparação é lexicográfica, letras maiúsculas sendo 'maiores' que minúsculas.

🚧

Filtros de data

É importante notar que a filtragem por data utiliza ISO datetime (timestamp com milissegundos) para representá-la. Para gerar o datetime de uma data, é possível utilizar o console do Google Chrome e utilizar o seguinte código em Javascript :
new Date().toISOString()
que retornará algo no formato:
2017-01-25T12:30:21.753Z

Query Params
date

Filtro pela data de criação do payable

string

Filtro pelo valor do recebível

string

Filtro pelo ID do recebedor atrelado

string

Filtro pelo id da antecipação

string

Filtro pelo status do recebível. paid ou waiting_funds

string

Filtro pelo installment do recebível - a qual parcela da transação o recebível se refere

string

Filtro pelo ID da transação referida pelo recebível

string

Filtro pelo ID da regra de split atrelada

date

Filtro pela data de pagamento do recebível

string

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

string

Filtro pelo ID do recebível

int32
Defaults to 10

Retorna n resultados, com um máximo de 1000

int32
Defaults to 1

Parâmetro de paginação: aplica um offset de page * count nos resultados

Response

Language
Credentials
Query
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json