OPopenpayd

List Accounts

Get a list of all accounts filtered by various params.

get/accounts

Request

  • Base URL
    https://sandbox.openpayd.com/api
  • URL
    https://sandbox.openpayd.com/api/accounts
  • Auth
    API key in header Authorization

Query parameters

accountNumberstring

internalAccountId of an account.

currencystring

Three-letter ISO 4217 currency code of the account. e.g. EUR

currencyExcludingstring

One or more currencies to exclude from the search e.g. EUR,USD

friendlyNamestring
ibanstring

iban from the bank-account associated with the account.

balanceFromnumber float

Balance greater than or equal to the specified value.

balanceTonumber float

Balance lower than or equal to the specified value.

searchstring

search using iban or friendlyName.

statusstring

PENDING, ACTIVE, FAILED, SUSPENDED, CLOSED

pageinteger
sizeinteger
sortstring

Sort by a parameter on the object. e.g. status

Response

200

totalElementsinteger
totalPagesinteger
lastboolean
sizeinteger
numberinteger
numberOfElementsinteger
firstboolean
emptyboolean

Example response

{
  "content": [
    {
      "id": "aTh2VVptWEU0eWhXSTFFU01vOElqUT09",
      "createdOn": "2022-11-08T11:37:00.869Z",
      "status": "ACTIVE",
      "actualBalance": {
        "value": 999984,
        "currency": "EUR"
      },
      "availableBalance": {
        "value": 999984,
        "currency": "EUR"
      },
      "friendlyName": "eur account",
      "primary": true,
      "accountHolderId": "ed7b1909-0091-4e39-aa1f-673059a431c4",
      "transactionCategory": "OTHER",
      "internalAccountId": "EUR11675924614470"
    }
  ],
  "pageable": {
    "sort": {
      "empty": true,
      "unsorted": true
    },
    "pageSize": 1,
    "paged": true
  },
  "totalElements": 1,
  "totalPages": 1,
  "size": 1,
  "sort": {
    "empty": true,
    "unsorted": true
  },
  "numberOfElements": 1,
  "first": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.