Source Accounts
Get list of source accounts
List source accounts.
get/v3/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
includeUserDeletedstring boolean
A filter for retrieving both active accounts and user deleted ones
typestring
Type of source account. One of the following values: FBO, PRIVATE
The type of source account.
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/v3/sourceAccounts?payorId=a2967711-df07-41e5-b5ea-f563088911c6&page=1&pageSize=0&sort=fundingRef:asc"
},
{
"rel": "first",
"href": "https://api.sandbox.velopayments.com/v3/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",
"country": "US",
"userDeleted": true,
"type": "FBO",
"deletedAt": "2021-01-27T10:08:25.701Z",
"fundingRef": "a1b2c3d4",
"deleted": true,
"balance": 1203489,
"pooled": true,
"transmissionTypes": [
"ACH",
"SAME_DAY_ACH"
],
"name": "MyAccountName",
"customerId": "Joe Customer",
"physicalAccountId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"autoTopUpConfig": {
"targetBalance": 300000,
"fundingAccountId": "640ab1bd-8a6a-4603-a83a-1edbc3ed5689",
"minBalance": 10000,
"enabled": true
},
"currency": "USD",
"railsId": "BOA_RAIL",
"id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"notifications": {
"minimumBalance": 120000
}
},
{
"physicalAccountName": "VELO_FBO_MYBANKA_USD",
"country": "US",
"userDeleted": true,
"type": "FBO",
"deletedAt": "2021-01-27T10:08:25.701Z",
"fundingRef": "a1b2c3d4",
"deleted": true,
"balance": 1203489,
"pooled": true,
"transmissionTypes": [
"ACH",
"SAME_DAY_ACH"
],
"name": "MyAccountName",
"customerId": "Joe Customer",
"physicalAccountId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"autoTopUpConfig": {
"targetBalance": 300000,
"fundingAccountId": "640ab1bd-8a6a-4603-a83a-1edbc3ed5689",
"minBalance": 10000,
"enabled": true
},
"currency": "USD",
"railsId": "BOA_RAIL",
"id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"notifications": {
"minimumBalance": 120000
}
}
]
}