Source Accounts
Get list of source accounts
List source accounts.
get/v2/sourceAccounts
Query parameters
physicalAccountNamestring
Physical Account Name
physicalAccountIdstring uuid
The physical account ID
payorIdstring uuid
The account owner Payor ID
fundingAccountIdstring uuid
The funding account ID
pageinteger
Page number. Default is 1.
pageSizeinteger
The number of results to return in a page
sortstring
List of sort fields e.g. ?sort=name:asc Default is name:asc The supported sort fields are - fundingRef, name, balance
Response
List Source Account response
Example response
{
"links": [
{
"rel": "first",
"href": "https://api.sandbox.velopayments.com/v2/sourceAccounts?payorId=a2967711-df07-41e5-b5ea-f563088911c6&page=1&pageSize=0&sort=fundingRef:asc"
},
{
"rel": "first",
"href": "https://api.sandbox.velopayments.com/v2/sourceAccounts?payorId=a2967711-df07-41e5-b5ea-f563088911c6&page=1&pageSize=0&sort=fundingRef:asc"
}
],
"page": {
"numberOfElements": 12,
"totalPages": 2,
"pageSize": 25,
"page": 1,
"totalElements": 33
},
"content": [
{
"physicalAccountName": "VELO_FBO_MYBANKA_USD",
"accountType": "FBO",
"fundingAccountId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"fundingRef": "a1b2c3d4",
"balance": 1203489,
"pooled": true,
"name": "MyAccountName",
"customerId": "Joe Customer",
"physicalAccountId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"autoTopUpConfig": {
"targetBalance": 300000,
"minBalance": 10000,
"enabled": true
},
"currency": "USD",
"railsId": "BOA_RAIL",
"balanceVisible": true,
"id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"notifications": {
"minimumBalance": 120000
}
},
{
"physicalAccountName": "VELO_FBO_MYBANKA_USD",
"accountType": "FBO",
"fundingAccountId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"fundingRef": "a1b2c3d4",
"balance": 1203489,
"pooled": true,
"name": "MyAccountName",
"customerId": "Joe Customer",
"physicalAccountId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"autoTopUpConfig": {
"targetBalance": 300000,
"minBalance": 10000,
"enabled": true
},
"currency": "USD",
"railsId": "BOA_RAIL",
"balanceVisible": true,
"id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"notifications": {
"minimumBalance": 120000
}
}
]
}