Funding

Get Funding Accounts

Get the funding accounts.

get/v2/fundingAccounts

Query parameters

payorIdstring uuid

namestring

The descriptive funding account name

countryCodestring

Example:US

The 2 letter ISO 3166-1 country code (upper case)

currencystring

Example:USD

The ISO 4217 currency code

typestring

Funding account type. One of the following values: FBO, PRIVATE

Example:FBO

The type of funding 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=accountName:asc,name:asc) Default is accountName:asc The supported sort fields are - accountName, name.

sensitiveboolean

Response

Get Funding Accounts 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": 1,
    "totalPages": 2,
    "pageSize": 25,
    "page": 1,
    "totalElements": 1
  },
  "content": [
    {
      "routingNumber": 12345678,
      "archived": true,
      "accountName": "Payor Corp",
      "countryCode": "US",
      "name": "My Funding Account",
      "currency": "USD",
      "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "accountNumber": "7001001234",
      "type": "FBO"
    },
    {
      "routingNumber": 12345678,
      "archived": true,
      "accountName": "Payor Corp",
      "countryCode": "US",
      "name": "My Funding Account",
      "currency": "USD",
      "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "accountNumber": "7001001234",
      "type": "FBO"
    }
  ]
}

Changes

Changed in 9 of the 50 revisions of this API.5622

Aug 15, 2023b924ba134e0922See the full diff
- ●
  deleted the query request parameter country
  request-parameter-removed
- ●
  removed the optional property // from the response with the status
  response-optional-property-removed
- ○
  added the new optional query request parameter countryCode
  new-optional-request-parameter
- ○
  added the optional property // to the response with the status
  response-optional-property-added
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Dec 20, 202227443d5dc9982See the full diff
- ○
  api tag Funding added
  api-tag-added
- ○
  api tag Funding Manager removed
  api-tag-removed
This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 27, 20221e7a1734a45c22See the full diff
- ▲
  removed the enum value FBO from the query request parameter type
  request-parameter-enum-value-removed
- ▲
  removed the enum value WUBS_DECOUPLED from the query request parameter type
  request-parameter-enum-value-removed
- ○
  removed the FBO enum value from the // response property for the response status
  response-property-enum-value-removed
- ○
  removed the WUBS_DECOUPLED enum value from the // response property for the response status
  response-property-enum-value-removed
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
May 9, 202289ba2b31611621See the full diff
- ●
  added the new FBO enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new WUBS_DECOUPLED enum value to the // response property for the response status
  response-property-enum-value-added
- ○
  the // response's property pattern ^[A-Z]{3}$ was added for the status
  response-property-pattern-added
This revision also has 10 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Sep 25, 2020dd71433847a6212See the full diff
- ▲
  the / response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the / response's property type changed from no type to object for status
  response-property-type-changed
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  response property errors/items/locationType deprecated
  response-property-deprecated
- ○
  response property errors/items/locationType deprecated
  response-property-deprecated
- ○
  response property errors/items/reasonCode deprecated
  response-property-deprecated
- ○
  response property errors/items/reasonCode deprecated
  response-property-deprecated
This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 13, 202075bb7af5ae631See the full diff
- ○
  added the optional property // to the response with the status
  response-optional-property-added
Jun 24, 2020aded220b0d7b21See the full diff
- ●
  for the query request parameter pageSize, the max was set to 100.00
  request-parameter-max-set
- ●
  for the query request parameter pageSize, the min was set to 1.00
  request-parameter-min-set
- ○
  added the new enum value WUBS_DECOUPLED to the query request parameter type
  request-parameter-enum-value-added
This revision also has 26 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Mar 19, 202010644a139f811See the full diff
- ○
  endpoint added
  endpoint-added
Jul 15, 2019ced8e167a97c1See the full diff
- ▲
  api path removed without deprecation
  api-path-removed-without-deprecation
This revision also has 257 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history