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>'
import requests

url = "https://api.paymee.com.br/v1.1/balance"

headers = {
"x-api-key": "<x-api-key>",
"x-api-token": "<x-api-token>"
}

response = requests.get(url, headers=headers)

print(response.text)
const options = {
method: 'GET',
headers: {'x-api-key': '<x-api-key>', 'x-api-token': '<x-api-token>'}
};

fetch('https://api.paymee.com.br/v1.1/balance', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.paymee.com.br/v1.1/balance",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <x-api-key>",
"x-api-token: <x-api-token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.paymee.com.br/v1.1/balance"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("x-api-key", "<x-api-key>")
req.Header.Add("x-api-token", "<x-api-token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.paymee.com.br/v1.1/balance")
.header("x-api-key", "<x-api-key>")
.header("x-api-token", "<x-api-token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.paymee.com.br/v1.1/balance")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<x-api-key>'
request["x-api-token"] = '<x-api-token>'

response = http.request(request)
puts response.read_body
{
  "status": 0,
  "message": "success",
  "balance": 17494.02,
  "date": "2020-02-17T17:49:28Z"
}
{
"errorCount": 1,
"errors": [
{
"error": "Forbidden",
"message": "Access Denied"
}
],
"message": "field validation failure",
"status": -1
}

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"