Access Specific Financial Balance Details

When you retrieve a balance from Payiano, you are essentially obtaining information about the amount of money that is currently available and can be utilized for various financial transactions. These funds are ready and accessible for a range of financial operations and can be used as needed. The funds in your balance are ready for immediate use. You don't need to wait or go through additional steps to access these funds. They are readily available for your financial needs.

GET/balances/{id}
Sandbox: https://api.payiano.dev/v1/balances/{id}
Live: https://api.payiano.com/v1/balances/{id}
Security
  • Authorization header with access token is required to access this endpoint: Bearer ACCESS-TOKEN
  • Your access token should be associated to this permission balances_view
Request
Request body schema:
application/json
Path parameters:
id
required
Type: ulid
Length: 26

The unique ID assigned to each balance which is generated by our system using the ULID format. Each ID is precisely 26 characters long, ensuring a unique and consistent identifier for every balance. This ULID is automatically created by our system and is used to uniquely identify and track each balance in our database.

Response
200
Response schema:
application/json
Response body:
balance
Type: object

The balance model details.

id
Type: ulid
Length: 26

The unique ID assigned to each balance which is generated by our system using the ULID format. Each ID is precisely 26 characters long, ensuring a unique and consistent identifier for every balance. This ULID is automatically created by our system and is used to uniquely identify and track each balance in our database.

currency_code
Type: enum
Possible values:
[ "EGP" ]

The three-character ISO-4217 Currency Code that identifies the currency for the balance. Your business should be eligible to use the selected currency code.

available_amount
Type: decimal

The available amount value to be withdrawn. The length includes the value, the decimal digit and the decimal value. The API accepts 2 digits like 50.53.

pending_amount
Type: decimal

The pending amount value to be collected. The length includes the value, the decimal digit and the decimal value. The API accepts 2 digits like 50.53.

Response sample:
1
{ 2
 "balance": { 3 "id": "01hqh45s7826hfwdze8dp1z21f", 4 "currency_code": "EGP", 5 "available_amount": 1000, 6 "pending_amount": 550 7 } 8}