O saldo da Pagar.me é o compilado de todos os valores que passaram pela sua conta Pagar.me sendo dividido em 3 valores: "a receber", "disponível" e "transferido". O saldo à receber é referente aos valores que vão ser compensados no futuro, ou seja transações que foram aprovadas porém não foram liquidadas ainda. O saldo disponível será composto de todos os valores que já foram liquidados e estão disponíveis na conta Pagar.me. Por fim o saldo transferido irá representar o montante que já foi liquidado e transferido para uma conta bancária.

Saldo na dashboard

É possível visualizar o saldo disponível e à receber na dashboard compilado por recebedor.

Na dashboard legado basta acessar "Menu > Extrato"

977977 233233 303303

Na nova dashboard no menu lateral, basta clicar em Extrato

209209 728728

Além do valor consolidado, na dashboard também existe o extrato, uma visualização mais detalhada sobre as datas de compensação de cada valor.

Saldo na API

Além da visualização através da dashboard também é possível recuperar os valores de saldo através da API, sendo que para informações apenas da conta principal é possível utilizar a rota /balance e para empresas que utilizam o modelo de marketplace é possivel verificar cada recebedor separadamente através da rota /recipients/:id/recipients.

O JSON retornado é o seguinte:

{
    "object": "balance",
    "waiting_funds": {
        "amount": 0
    },
    "available": {
        "amount": 0
    },
    "transferred": {
        "amount": 0
    }
}

🚧

Vale ressaltar

O amount para waiting_funds e available no retorno da API é mostrado já descontado das taxas Pagar.me