Balance query
Request
To get the balance of your account with the payment method provider, send a POST
request to https://api.bepaid.by/beyag/balance
with the following parameters:
Parameter |
Type |
Description |
gateway_id * required
|
integer |
An ID of the payment gateway provided to you by the payment method provider and enabled for your shop in the bePaid system. |
account |
string |
An account number. If not submitted, the provider returns the balance amount of your default account. |
currency |
string |
An account currency in the ISO-4217 alpha-3 code format. For example, USD . |
Request example
{
"gateway_id": 1234,
"account":"40701810842020395221",
"currency":"USD"
}
Response
Parameter |
Type |
Description |
status * required
|
string |
A status of the processed transaction. |
code * required
|
string |
A transaction processing code. |
message * required
|
string |
A notification from the service of the bePaid system for merchants. |
friendly_message * required
|
string |
A description of the transaction processing code for customers. |
gateway_id * required
|
integer |
An ID of the payment gateway provided to you by the payment method provider and enabled for your shop in the bePaid system. |
account * required
|
string |
An account number. If the parameter is not submitted in the request, the provider returns the balance amount of your default account. |
amount * required
|
integer |
A balance amount in minimal currency units. |
currency * required
|
string |
An account currency in the ISO-4217 alpha-3 code format. For example, USD . |
provider_info * required
|
object |
A section of additional information provided by the acquirer or the payment method provider. |
Response example
{
"code":"S.0000",
"status":"Successful",
"message":"none",
"friendly_message":"Successfully processed",
"gateway_id": 1111,
"account":"40701810842020395221",
"amount":1290092162,
"currency":"RUB",
"provider_info":
{
"BankCode":200,
"OperDate":"2020-09-07T00:00:00",
"Credit":50152414.96,
"CreditRub":50152414.96,
"Debit":62000000.0,
"DebitRub":62000000.0,
"AmountIn":55205049.84,
"AmountInRub":55205049.84,
"AmountOut":43357464.8,
"AmountOutRub":43357464.8
}
}