Bank Account API

The Bank Account API helps you retrieve the list of bank accounts added to SePay, query detailed information for each account, and check account balances.

What can you do with this API?

SePay allows you to perform the following queries with Bank Accounts:
GET
https://my.sepay.vn/userapi/bankaccounts/list
- Retrieve a list of bank accounts
GET
https://my.sepay.vn/userapi/bankaccounts/details/{bank_account_id}
- Retrieve details of a specific bank account
GET
https://my.sepay.vn/userapi/bankaccounts/count
- Count the total number of bank accounts

Retrieve bank account list

GET

/userapi/bankaccounts/list

Content-Type: application/json
Authorization: Bearer {YOUR_API_TOKEN}

Retrieves all bank accounts. By default, only the 100 most recently added bank accounts are displayed.

Query parameters

Name	Type	Required	Description
`short_name`	string	Not required	Bank name corresponding to the short_name field
`last_transaction_date_min`	string	Not required	Filter accounts with the latest transaction after (>=) this date. Format: yyyy-mm-dd
`last_transaction_date_max`	string	Not required	Filter accounts with the latest transaction before (<=) this date. Format: yyyy-mm-dd
`since_id`	integer	Not required	Show bank accounts from the specified ID (>=)
`limit`	integer	Not required	Limit the number of returned accounts. Default is 100
`accumulated_min`	number	Not required	Filter accounts with balance greater than or equal to (>=)
`accumulated_max`	number	Not required	Filter accounts with balance less than or equal to (<=)

Information

View the list of bank short names here

bash

RESPONSE

{
  "status": 200,
  "error": null,
  "messages": {
    "success": true
  },
  "bankaccounts": [
    {
      "id": "25",
      "account_holder_name": "NGUYEN THI B",
      "account_number": "102871015203",
      "accumulated": "2525493.00",
      "last_transaction": "2023-02-16 16:16:00",
      "label": "",
      "active": "1",
      "created_at": "2023-02-16 15:57:26",
      "bank_short_name": "VietinBank",
      "bank_full_name": "Vietnam Joint Stock Commercial Bank for Industry and Trade",
      "bank_bin": "970415",
      "bank_code": "ICB"
    },
    {
      "id": "24",
      "account_holder_name": "NGUYEN VAN A",
      "account_number": "084704070006848",
      "accumulated": "551564.00",
      "last_transaction": "2023-02-16 15:38:50",
      "label": "",
      "active": "1",
      "created_at": "2023-02-16 15:33:46",
      "bank_short_name": "HDBank",
      "bank_full_name": "Ho Chi Minh City Development Joint Stock Commercial Bank",
      "bank_bin": "970437",
      "bank_code": "HDB"
    }
  ]
}

Example usage

Retrieve bank accounts with transactions after 08:00 on April 30, 2023, and before 12:00 on May 2, 2023

cURL

curl -X GET "https://my.sepay.vn/userapi/bankaccounts/list?last_transaction_date_min=2023-04-30%2008:00:00&last_transaction_date_max=2023-05-02%2012:00:00" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Retrieve bank accounts starting from ID 20

cURL

curl -X GET "https://my.sepay.vn/userapi/bankaccounts/list?since_id=20" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Retrieve 20 Vietcombank accounts

cURL

curl -X GET "https://my.sepay.vn/userapi/bankaccounts/list?short_name=Vietcombank&limit=20" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Filter bank accounts with a balance ≥ 1 VND

cURL

curl -X GET "https://my.sepay.vn/userapi/bankaccounts/list?accumulated_min=1" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Retrieve details of a specific bank account

GET

/userapi/bankaccounts/details/{bank_account_id}

Content-Type: application/json
Authorization: Bearer {YOUR_API_TOKEN}

Retrieve detailed information about a specific bank account by ID
Path parameters
Name Type Required Description
bank_account_id
integer Required
ID of a bank account

Name	Type	Required	Description
`bank_account_id`	integer	Required	ID of a bank account

bash

RESPONSE

{
  "status": 200,
  "error": null,
  "messages": {
    "success": true
  },
  "bankaccount": {
    "id": "18",
    "account_holder_name": "NGUYEN VAN A",
    "account_number": "0071000899999",
    "accumulated": "2625076186.00",
    "last_transaction": "2023-08-09 07:59:48",
    "label": "",
    "active": "1",
    "created_at": "2023-02-12 20:05:47",
    "bank_short_name": "Vietcombank",
    "bank_full_name": "Joint Stock Commercial Bank for Foreign Trade of Vietnam",
    "bank_bin": "970436",
    "bank_code": "VCB"
  }
}

idinteger

ID of the bank account on SePay

account_holder_namestring

Account holder name

account_numberstring

Bank account number

accumulatedstring

Current balance (VND)

last_transactionstring

Most recent transaction time (YYYY-MM-DD HH:mm:ss)

labelstring

Display label (if any)

activeinteger

Account status (1: active, 0: inactive)

created_atstring

Account creation date on SePay (YYYY-MM-DD HH:mm:ss)

bank_short_namestring

Bank short name (e.g., Vietcombank)

bank_full_namestring

Bank full name (e.g., Joint Stock Commercial Bank for Foreign Trade of Vietnam)

bank_binstring

Bank BIN code (6 digits)

bank_codestring

Bank identification code (e.g., VCB)

Count total number of bank accounts

GET

/userapi/bankaccounts/count

Authorization: Basic secret_key
Content-Type: application/json

Count the total number of existing bank accounts.

Name	Type	Required	Description
`short_name`	string	Not required	Bank name corresponding to the short_name field
`last_transaction_date_min`	string	Not required	Filter accounts with last transaction after (>=). Format: yyyy-mm-dd
`last_transaction_date_max`	string	Not required	Filter accounts with last transaction before (<=). Format: yyyy-mm-dd
`since_id`	integer	Not required	Show bank accounts from the specified ID (>=)
`accumulated_min`	number	Not required	Filter accounts with balance greater than or equal to (>=)
`accumulated_max`	number	Not required	Filter accounts with balance less than or equal to (<=)

Example usage

Count total number of bank accounts with balance ≥ 1

cURL

curl -X GET "https://my.sepay.vn/userapi/bankaccounts/count?accumulated_min=1" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"