Skip to main content
GET
/
v1.1
/
balance
Query current balance
curl --request GET \
  --url https://api.paymee.com.br/v1.1/balance \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-api-token: <x-api-token>'
{
  "status": 0,
  "message": "success",
  "balance": 17494.02,
  "date": "2020-02-17T17:49:28Z"
}

Headers

​
x-api-key
string
required
Example:

"your-x-api-key"

​
x-api-token
string
required
Example:

"your-x-api-token"

Response

success response

​
status
number

Response status code (0 = success)

Example:

0

​
message
string

Response status message

Example:

"success"

​
balance
number

Current balance

Example:

17494.02

​
date
string

Balance timestamp (ISO‑8601, GMT‑3)

Example:

"2020-02-17T17:49:28Z"