Get a balance

Retrieves a single balance by ID

GET /balances/{id}

NodeJs

JavaScript

const { FedaPay, Balance } = require('fedapay');
/* Replace YOUR_SECRETE_API_KEY with your real API key */
FedaPay.setApiKey("YOUR_SECRETE_API_KEY");
/* Specify whether you want to run your query in test or live mode */
FedaPay.setEnvironment('sandbox'); //or setEnvironment('live');
/* Show balance */
const balance = await Balance.retrieve( ID, params = {}, headers = {} );

200

[
  {
    "id": 123,
    "amount": 123,
    "mode": "<string>",
    "account_id": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
]

Autorisations

Authorization · string · header · requis

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Paramètres de chemin

id · integer · requis

Balance ID

Réponse

200

application/json

List of balance

id · integer

Balance ID.

amount · integer

Balance amount.

mode · string

Balance mode

account_id · integer

Account ID associated with the balance

created_at · string<date-time>

Date and time of balance creation.

updated_at · string<date-time>

Date and time of last balance update.