GET

Consultar Saldo (Balance)

Consulta o saldo disponível de uma empresa. Valores monetários são sempre em centavos (R$ 25,00 → 2500).

Dica Importante

Normalmente você já tem o companyId no retorno de /api/v1/transactions/create. Use esse mesmo valor nas chamadas de balance e withdraw.

Endpoint

GET/api/Balance/balance/{companyId}?currency=BRL

Consulta o saldo disponível da empresa

Base URL: https://rayopay.com.br

Headers

Parametro	Tipo	Descricao
`Accept`obrigatorio	`string`	application/json
`X-Client-Id`obrigatorio	`string`	Client ID do aplicativo
`X-API-Key`obrigatorio	`string`	Secret Key (Company)

Parâmetros

Parametro	Tipo	Descricao
`companyId`obrigatorio	`integer`	ID da empresa (obtido do retorno de create transaction). Path Parameter
`currency`	`string`	Moeda padrão: BRL. Query Parameter

Resposta de Sucesso (200 OK)

response.json

json

{
  "id": 1,
  "companyId": 1,
  "currency": "BRL",
  "enBalanceStatus": "Released",
  "accBalance": 5.00,
  "accBalanceCredit": 0.00,
  "accBalanceCreditAwaiting": 0.00
}

Campos da Resposta

Parametro	Tipo	Descricao
`accBalance`	`number`	Saldo disponível para saque (em reais)
`enBalanceStatus`	`string`	Status do saldo (Released = disponível)
`accBalanceCredit`	`number`	Saldo em créditos
`accBalanceCreditAwaiting`	`number`	Saldo em créditos aguardando liberação

Exemplos

cURL

bash

curl -X GET 'https://rayopay.com.br/api/Balance/balance/1?currency=BRL' \
  -H 'Accept: application/json' \
  -H 'X-Client-Id: e1c98954cc404cbcb2868af9b40c7a33' \
  -H 'X-API-Key: sua-api-key-secreta'

JavaScript / Node.js

javascript

const companyId = 1; // Do retorno de create transaction
const currency = 'BRL';
 
const response = await fetch(
  `https://rayopay.com.br/api/Balance/balance/${companyId}?currency=${currency}`,
  {
    method: 'GET',
    headers: {
      'Accept': 'application/json',
      'X-Client-Id': 'e1c98954cc404cbcb2868af9b40c7a33',
      'X-API-Key': 'sua-api-key-secreta'
    }
  }
);
 
const balance = await response.json();
console.log('Saldo disponível:', balance.accBalance);