Sign in

v1

latestOpenAPI 3.0.2Apache License 2.02026-07-13109285691.8 KB
Source Accounts

Get details about given source account.

Get details about given source account.

get/v3/sourceAccounts/{sourceAccountId}

Path parameters

sourceAccountIdstring uuid required

Source account id

Response

Source account response

idstring uuid required

Source Account Id

balanceinteger

Decimal implied

currencystring

Valid ISO 4217 3 letter currency code. See the <a href="https://www.iso.org/iso-4217-currency-codes.html" target="_blank" a>ISO specification</a> for details.

fundingRefstring

The funding reference (will not be set for DECOUPLED accounts).

physicalAccountNamestring

The physical account name (will not be set for DECOUPLED accounts).

railsIdstring required
payorIdstring uuid
namestring
pooledboolean

The pooled account flag (will not be set for DECOUPLED accounts).

customerIdstring nullable
physicalAccountIdstring uuid

The physical account id (will not be set for DECOUPLED accounts).

typestring required
countrystring

Valid ISO 3166 2 character country code. See the <a href="https://www.iso.org/iso-3166-country-codes.html" target="_blank" a>ISO specification</a> for details.

deletedboolean

An optional flag for whether the source account has been deleted. Only present in the response if true.

userDeletedboolean

An optional flag for whether the source account has been deleted by a user. Only present in the response if true.

deletedAtstring date-time

An optional timestamp when the source account has been deleted. Only present in the response if deleted.

transmissionTypesstring[]

List of supported transmission types.

Example response

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