Skip to main content
GET
/
bank-account
/
list
Get customer's bank account list
curl --request GET \
  --url https://ramp-sandbox.hexarails.ai/bank-account/list \
  --header 'X-API-Key: <api-key>'
{
  "status": "SUCCESS",
  "data": {
    "list": [
      {
        "id": "67890",
        "customerId": "12345",
        "currency": "USD",
        "bankName": "Chase Bank",
        "accountNo": "1234567890",
        "createTime": "2024-01-01T00:00:00Z",
        "updateTime": "2024-01-02T00:00:00Z",
        "swift": "CHASUS33"
      }
    ],
    "total": 123,
    "pageNum": 123,
    "pageSize": 123
  }
}

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
pageNum
number
default:1

Page number

Required range: x >= 1
​
pageSize
number
default:10

Page size

Required range: 1 <= x <= 100
​
customerId
string

Customer (party) ID; omit to return bank accounts for all customers under the partner

Example:

"12345"

​
currency
string

Currency

Example:

"USD"

Response

Get bank account list successful

​
status
enum<string>
required

Success response status

Available options:
SUCCESS
Example:

"SUCCESS"

​
data
object
required

Response data