Skip to main content
GET
/
v1
/
balance
Consultar saldo
curl --request GET \
  --url https://api-payment.safefypay.com.br/v1/balance \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "currency": "BRL",
    "balance": {
      "available": 150000,
      "pending": 25000,
      "reserved": 0,
      "total": 175000
    },
    "totals": {
      "lifetimeVolume": 5000000,
      "lifetimePayouts": 4800000,
      "lifetimeRefunds": 50000
    },
    "period": {
      "volumeToday": 100000,
      "volumeThisWeek": 500000,
      "volumeThisMonth": 2000000
    },
    "updatedAt": "2025-01-15T15:00:00Z"
  },
  "message": null,
  "error": null
}

Documentation Index

Fetch the complete documentation index at: https://docs.safefypay.com.br/llms.txt

Use this file to discover all available pages before exploring further.

Returns the current balance of the authenticated merchant. All monetary values are in cents (e.g., 1500 = R$15.00).
Always use withdrawNowAvailable when creating a cashout. If requiresFullWithdrawalNow is true, your cashout request must use that exact amount.

Authorizations

​
Authorization
string
header
required

Token JWT obtido via /v1/auth/token

Response

Dados do saldo

​
data
object
​
message
string | null
​
error
object