API Reference

Get a Virtual Account Details/Status

get
https://example.com/api/v1/virtualAccount

This API gives details of a created Virtual Account. The details includes expiration date, amount, etc. The API returns a 200 HTTP response code in case of a successful retrieval of a created Virtual Account details. The API returns a 401 HTTP response code in case of a missing or invalid token. The API returns a 503 HTTP response code in case of service unavailable because of bad request (e.g. missing and/or wrong headers), or a validation error (e.g. missing and/or wrong parameters) or any other server issue.

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

Unique identifier (27 alphanumeric characters) to identify the associated Virtual Account.

string
required
length between 32 and 32

Unqiue per each API request

string
required
length between 3 and 3

3 digit code of a bank

string
required
length between 13 and 26

Received in the 'create' Virtual Account API. Ayoconnect's CustomerId. AlphaNumeric.

Headers
string
required
length between 35 and 35

Authorization header. Only 'bearer' authentication is supported.

string
required
length between 16 and 16

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

string
required
length between 16 and 16

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

string
required
length between 32 and 32

Unique identifier (32 alphanumeric characters) to identify a Virtual Account flow. It must be unique per flow and can't be reused for different flows. A flow is a set of API calls, for example, all the calls (create, get, update, delete) related to a Virtual Account, and are part of one flow. Merchants can link API calls into one flow using this header.

string
required
length between 6 and 6

Merchant Code. 6 alphanumeric characters. It is used to identify a merchant.

Responses

Updated 6 months ago

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

Updated 6 months ago