Transaction API

Documentation on how to use the transaction API via OAuth2 in SePay.

Introduction

SePay’s transaction API allows you to query information about banking transactions that have occurred. You can retrieve a list of transactions, filter by various criteria, and view details of each transaction.
To use this API, your Access Token must include the transaction:read scope.

Get transaction list

GET

/api/v1/transactions

Authorization: Bearer {YOUR_ACCESS_TOKEN}

This endpoint returns the list of transactions belonging to your company. You can filter results by various criteria.
Required permissions
- Scope: transaction:read
- User permission: Bank Transactions (View transaction list)

Query parameters

Name	Type	Required	Description
`bank_account_id`	integer	Not required	Filter by bank account ID
`account_number`	string	Not required	Filter by bank account number
`reference_number`	string	Not required	Filter by transaction reference number
`from_date`	date	Not required	Filter transactions from date (format YYYY-MM-DD)
`to_date`	date	Not required	Filter transactions up to date (format YYYY-MM-DD)
`amount_out`	numeric	Not required	Filter by outgoing amount
`amount_in`	numeric	Not required	Filter by incoming amount
`page`	integer	Not required	Page number, starting from 1
`limit`	integer	Not required	Number of results per page

RESPONSE

{
  "status": "success",
  "data": [
    {
      "id": 49682,
      "bank_account_id": 19,
      "bank_brand_name": "Vietcombank",
      "account_number": "0071000888888",
      "transaction_date": "2025-02-25 19:59:48",
      "amount_out": 0,
      "amount_in": 18067000,
      "accumulated": 1200541768,
      "transaction_content": "DUONG THUY ANH transferred money for online purchase",
      "reference_number": "677760.250225.080001",
      "code": "DH123456",
      "sub_account": "VCB0011ABC004"
    },
    {
      "id": 49582,
      "bank_account_id": 19,
      "bank_brand_name": "Vietcombank",
      "account_number": "0071000888888",
      "transaction_date": "2025-02-25 17:59:47",
      "amount_out": 0,
      "amount_in": 13646000,
      "accumulated": 1182474768,
      "transaction_content": "DINH NHU TOAN transferred money DH789012",
      "reference_number": "171158.250225.060001",
      "code": "DH789012",
      "sub_account": "VCB0011ABC002"
    },
    {
      "id": 49465,
      "bank_account_id": 19,
      "bank_brand_name": "Vietcombank",
      "account_number": "0071000888888",
      "transaction_date": "2025-02-24 15:59:47",
      "amount_out": 0,
      "amount_in": 21782000,
      "accumulated": 1168828768,
      "transaction_content": "DUONG THUY ANH transferred money for invoice payment",
      "reference_number": "989543.240225.040001",
      "code": null,
      "sub_account": "VCB0011ABC001"
    }
  ],
  "meta": {
    "pagination": {
      "total": 86,
      "per_page": 20,
      "current_page": 1,
      "last_page": 5
    }
  }
}

idinteger

Transaction ID

bank_account_idinteger

Bank account ID

bank_brand_namestring

Bank name

account_numberstring

Bank account number

transaction_datedatetime

Date and time of the transaction

amount_outfloat

Outgoing amount (VND)

amount_infloat

Incoming amount (VND)

accumulatedfloat

Balance after the transaction (VND)

transaction_contentstring

Transaction description/content

reference_numberstring

Transaction reference number

codestring/null

Payment code extracted from transaction content (if any)

sub_accountstring/null

Receiving sub-account (if any)

Error codes

Below are possible error codes when using the transaction API:
HTTP Code Error Code Description
400
validation_error
Input data validation error
401
unauthorized
Token is invalid or expired
403
forbidden
You do not have permission to access this resource

HTTP Code	Error Code	Description
400	validation_error	Input data validation error
401	unauthorized	Token is invalid or expired
403	forbidden	You do not have permission to access this resource