Consultando o seu saldo

Existem duas formas de consultar o seu saldo no Pagar.me:

1. Dashboard

A primeira delas é utilizando a nossa Dashboard, conforme a imagem abaixo. Nessa tela é possível verificar o seu saldo disponível (quanto você já pode sacar) e o saldo a receber (quanto já foi vendido e ainda vai cair na sua conta):

358

📘

Mais informações

Caso queira saber mais a respeito da diferença entre saldo atual e saldo a receber, acesse a nossa FAQ em: Saldo a receber X Saldo disponível

2. API

Também é possível consultar o saldo do recebedor principal da sua empresa a partir da seguinte chamada para a nossa API:

curl -X GET https://api.pagar.me/1/balance -H 'content-type: application/json' -d '{
    "api_key": "SUA API KEY"
}'
require 'pagarme'

PagarMe.api_key = 'SUA API KEY'
balance = PagarMe::Balance.balance
balance.waiting_funds.amount 
balance.available.amount   
balance.transferred.amount
<?php
require("vendor/autoload.php");
$pagarme = new PagarMe\Client('SUA_CHAVE_DE_API');

$balance = $pagarme->balances()->get();
PagarMeService.DefaultApiKey = "SUA API KEY";

var recipient = PagarMeService.GetDefaultService().Recipients.Find("re_ci7nhf1ay0007n016wd5t22nl");

recipient.Balance;
import pagarme from 'pagarme'

pagarme.client.connect({ api_key: 'SUA_API_KEY' })
  .then(client => client.balance.primary())
  .then(balance => console.log(balance))
import pagarme

pagarme.authentication_key('SUA_API_KEY')

balance = pagarme.balance.default_recipient_balance()

print (balance)

O retorno é o seguinte:

{
  "object": "balance",
  "waiting_funds": {
    "amount": 970597152
  },
  "transferred": {
    "amount": 193340
  },
  "available": {
    "amount": 111706473
  }
}

Significado das chaves:

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

🚧

Vale ressaltar

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

Saldo de recebedores secundários

Para verificar o saldo de um recebedor específico utilizando a nossa API, é necessário especificar o ID dele e realizar uma requisição, conforme o exemplo abaixo:

curl -X GET https://api.pagar.me/1/recipients/re_ci7nhf1ay0007n016wd5t22nl/balance -H 'content-type: application/json' -d '{
    "api_key": "SUA API KEY"
}'
require 'pagarme'

PagarMe.api_key = 'SUA API KEY'  

balance = PagarMe::Recipient.find(recipient_id).balance
balance.waiting_funds.amount # money to be received in his account
balance.available.amount     # in his pagarme account
balance.transferred.amount   # transferred to his bank account
PagarMeService.DefaultApiKey = "SUA API KEY";

var recipient = PagarMeService.GetDefaultService().Recipients.Find("re_ci7nhf1ay0007n016wd5t22nl");

recipient.Balance;
<?php
require("vendor/autoload.php");
$pagarme = new PagarMe\Client('SUA_CHAVE_DE_API');

$recipientBalance = $pagarme->recipients()->getBalance([
  'recipient_id' => 'ID_DO_RECEBEDOR',
]);
import pagarme from 'pagarme'

pagarme.client.connect({ api_key: 'SUA_API_KEY' })
  .then(client => client.balance.find({
    recipientId: 'recipient_id'
  }))
  .then(balance => console.log(balance))
import pagarme

pagarme.authentication_key('SUA_API_KEY')

recipient_balance = pagarme.recipient.recipient_balance('RECIPIENT_ID')

print (recipient_balance)

O retorno tem o mesmo template, como segue:

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

Próximos passos

Caso você tenha apenas valores a receber na sua conta do Pagar.me, você pode realizar uma antecipação desses valores. Aprenda mais em Criando uma antecipação.


Próximo

Agora que você já sabe consultar o seu saldo, aprenda como realizar um saque!