Objeto Saldo

❗️

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.

1. Propriedades de um saldo

Com este objeto, você pode obter informações gerais sobre o saldo da sua conta.

ParâmetroDescrição
object
String
Nome do tipo do objeto criado/modificado.
Valor retornado: balance
waiting_funds
Object
Possui a propriedade amount, que representa quanto, em centavos, você tem a receber do Pagar.me
available
Object
Possui a propriedade amount, que representa quanto, em centavos, você tem disponível em sua conta Pagar.me
transferred
Object
Possui a propriedade amount, que representa quanto, em centavos, você já transferiu para sua conta bancária (quanto já recebeu efetivamente)
{
    "object": "balance",
    "waiting_funds": {
        "amount": 0
    },
    "available": {
        "amount": 3169323
    },
    "transferred": {
        "amount": 3163500
    }
}