Balance Inquiry

This API is used to check the current available balance for disbursement of the merchant account.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length between 32 and 32

32-character alphanumeric string generated by the merchant. Used as the balance inquiry identifier.

string
required

Merchant code identifier registered with Ayoconnect.

Headers
string
required
length between 16 and 16

Content type accepted by the service. Only 'application/json' is supported.

string
required
length between 35 and 35

Authorization header. Only 'bearer' authentication is supported.

string
required
length between 32 and 32

Unique identifier (32 alphanumeric characters) to identify the request. It must be unique per request and can't be reused in subsequent requests.

If the same value is used in another request, it will be considered as a duplicated request, and consequently rejected.

string
required
length between 6 and 6

Unique identifier (6 alphanumeric characters) to identify the particular merchant. It must be unique per merchant.

string
required

Geographical coordinates of the end customer location

string
required

Geographical coordinates of the end customer location.

string
required
length between 24 and 27

Client's current local time in yyyy-MM-ddTHH:mm:ss.SSSTZD format.

string
required

Integrity checking. Asymmetric Signature: SHA256withRSA(Private_Key, stringToSign)

stringToSign = client_ID + "|" + X-TIMESTAMP

string
required

Public IP Address of the end customer.

string
required
length between 5 and 5

Numeric ID that shows which client or application sent the request. It is used for tracking and reporting.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json