v1

latestOpenAPI 3.0.2Apache License 2.02026-07-13109285691.8 KB

Source Accounts

Get Source Account

Get details about given source account.

get/v2/sourceAccounts/{sourceAccountId}

Path parameters

sourceAccountIdstring uuid required

Source account id

Response

Source account response

idstring uuid required

Source Account Id

balanceinteger

Decimal implied

currencystring

fundingRefstring required

physicalAccountNamestring required

railsIdstring required

payorIdstring uuid

namestring

pooledboolean required

balanceVisibleboolean required

customerIdstring nullable

physicalAccountIdstring uuid

fundingAccountIdstring uuid nullable

accountTypestring required

Example response

{
  "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
  }
}