Skip to content
API listPayment accounts
API list

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 - requiredstring

Bearer <secretKey> for the API key in use.

X-Api-Key - requiredstring

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
200 OK
application/json
Success

The 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.

idstring

Payment account code.

typeTOP_UP | DEBIT

TOP_UP: prepaid account. DEBIT: account used for purchases on credit.

balancenumber

Current balance in VND. Spending on a DEBIT account is recorded as a negative balance.

statusACTIVE | INACTIVE

Account activity status.

isBlockedboolean

true if the account is blocked.

isDefaultboolean

true if this is the default account used for payments.

debtStatementnumber

Outstanding statement debt in VND. Only present for DEBIT; omitted for TOP_UP. This is separate from the current balance.

currencyVND

Currency; currently always VND.

dueDatestring (YYYY-MM-DD)

The 5th of the current month in Asia/Ho_Chi_Minh, matching the monthly statement payment deadline. Only present for DEBIT; omitted for TOP_UP. The date does not roll forward to next month after the 5th has passed.

GET
/api/v1/accounts
Sample Request
Try it on Swagger
Nodejs
PHP
C#
Java
Go
Curl

_11
import axios from "axios";
_11
_11
const response = await axios.get("https://merchant.simplifytrip.com/api/v1/accounts", {
_11
headers: {
_11
"accept": "application/json",
_11
"content-type": "application/json",
_11
"authorization": "Bearer sk_live_xxxxxxxxxxxxxxxxxx",
_11
"x-api-key": "pk_live_xxxxxxxxxxxxxxxxxx"
_11
}
_11
});
_11
console.log(response.data);

Sample Response

Example response during September 2026. Account codes and amounts are illustrative.

Success
Empty

_22
[
_22
{
_22
"id": "account-001",
_22
"type": "TOP_UP",
_22
"balance": 2500000,
_22
"status": "ACTIVE",
_22
"isBlocked": false,
_22
"isDefault": true,
_22
"currency": "VND"
_22
},
_22
{
_22
"id": "account-002",
_22
"type": "DEBIT",
_22
"balance": -1200000,
_22
"status": "ACTIVE",
_22
"isBlocked": false,
_22
"isDefault": false,
_22
"debtStatement": 1000000,
_22
"dueDate": "2026-09-05",
_22
"currency": "VND"
_22
}
_22
]