These docs are for v4. 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…
❗️

Atenção: Essa versão de API será descontinuada

Essa versão da API Pagar.me já não é mais atualizada e, em breve, deixará de funcionar. Para que sua loja possa vender sem problemas, você precisa realizar sua integração usando a versão mais recente da nossa API, a V5.

No canto superior esquerdo da tela é indicado qual versão da documentação você está vendo. Clique na seta onde indica a versão e altere para a V5 para acessar a documentação.

Se você já é cliente, precisa realizar obrigatoriamente a migração para a versão V5.

Em caso de dúvidas, basta entrar em contato com o nosso time de atendimento através do e-mail, enviando a sua dúvida para [email protected] e por telefone, ligando para 4004-1330. Se você já é cliente pode também entrar em contato através do chat dentro da sua Dashboard.

📘

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

🚧

Rate Limit

Essa rota possui um limite de requisições.
Caso você ultrapasse esse valor será retornado o erro “StatusCode 429” por nossa API.

Para saber qual o limite dessa e demais rotas acesse : Rate Limit

Query Params
date

Filtro pela data de criação do payable

date

Filtro para data de último update

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

string

Filtro pelo ID da liquidação 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