v1

latestOpenAPI 3.0.2Apache License 2.02026-07-13109285691.8 KB
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"
    }
  ]
}