Payment Accounts API
List payment accounts
Retrieve payment accounts for the institution identified by the API key. Results are filtered by the key’s TEST_MODE or LIVE_MODE and sorted by id in ascending order.
Request Headers
Authorization - required | string |
|
X-Api-Key - required | string | The public key matching the secret key. |
This endpoint does not require X-Signature. See API Keys for authentication setup.
Request Parameters
No path parameters, query parameters or request body are required. Do not send an institution ID or mode; both are determined by the API key. This endpoint is not paginated.
Responses
application/jsonThe response is a direct Account[] array, without a data or items wrapper. If no accounts match, it returns []. The list includes inactive or blocked accounts; check status and isBlocked when displaying account state.
id | string | Payment account code. |
type | TOP_UP | DEBIT |
|
balance | number | Current balance in VND. Spending on a |
status | ACTIVE | INACTIVE | Account activity status. |
isBlocked | boolean |
|
isDefault | boolean |
|
debtStatement | number | Outstanding statement debt in VND. Only present for |
currency | VND | Currency; currently always |
dueDate | string (YYYY-MM-DD) | The 5th of the current month in |
/api/v1/accountsSample Request
Try it on SwaggerSample Response
Example response during September 2026. Account codes and amounts are illustrative.