Search virtual accounts

Search and filter virtual accounts based on various criteria like account name, master account number, purpose, dates, balances, and status

SecurityoAuth2
Request
query Parameters
page
integer
Default: 0

Page number

size
integer
Default: 10

Page size

Request Body schema: application/json

Account Info

partnerId
string
customerUID
string

Unique Customer Id

accountName
string <= 255 characters

Name for the account. Only letters, numbers, and spaces are allowed.

masterAccountNumber
string <= 255 characters

Name for the account. Only letters, numbers, and spaces are allowed.

purpose
string

purpose

createdDateFrom
string <date>
createdDateTo
string <date>
lastUpdatedDateFrom
string <date>
lastUpdatedDateTo
string <date>
balanceFrom
number <double>
balanceTo
number <double>
status
Array of strings

List of statuses to filter virtual accounts

Items Enum: "Active" "Closed"
Responses
200

OK

400

Bad request

401

You are not authorized to access the resource

403

Accessing the resource you were trying to reach is forbidden

404

The resource you were trying to reach is not found

500

Internal server error

503

Service unavailable

default

Successful

post/v2/virtual-accounts/search
Request samples
application/json
{
  • "partnerId": "string",
  • "customerUID": "string",
  • "accountName": "xyz 123",
  • "masterAccountNumber": "xyz 123",
  • "purpose": "string",
  • "createdDateFrom": "2019-08-24",
  • "createdDateTo": "2019-08-24",
  • "lastUpdatedDateFrom": "2019-08-24",
  • "lastUpdatedDateTo": "2019-08-24",
  • "balanceFrom": 0,
  • "balanceTo": 0,
  • "status": [
    ]
}
Response samples
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}