Sign in
latestSwagger 2.02026-08-20196638916.1 KB

23d8982b533d

Payment.Settlement Accounts

List accounts

List all settlement accounts for a given merchant.

get/payment/v1/merchants/{merchantId}/accounts

Path parameters

merchantIdstring required

The id of the merchant.

Query parameters

pageSizeinteger

The maximum number of items to return.

pageTokenstring

Token to the requested page.

appIdEqstring

App id to filter the accounts by.

Response

A successful response.

nextPageTokenstring

Token to the next page.

prevPageTokenstring

Token to the previous page.

totalSizeinteger

Total number of accounts.

Example response

{
  "accounts": [
    {
      "accountIdentifier": {
        "identifier": "00000012345678",
        "type": "SORT_CODE"
      },
      "appId": "",
      "availableBalance": {
        "currencyCode": "GBP",
        "value": {
          "scale": "2",
          "unscaledValue": "271100"
        }
      },
      "balance": {
        "currencyCode": "GBP",
        "value": {
          "scale": "2",
          "unscaledValue": "276400"
        }
      },
      "countryCode": "GB",
      "currencyCode": "GBP",
      "id": "744cf927-29cd-475e-9ef2-2b11951d3cc9",
      "merchantId": "2c9ba5fd-cbdb-4ed5-84a4-01db5698f0d9",
      "name": "Account name",
      "payoutAccount": {
        "currencyCode": "GBP",
        "frequency": "MONTHLY",
        "identifier": {
          "identifier": "00000070438943",
          "type": "SORT_CODE"
        }
      },
      "reservedAmount": {
        "scale": "1",
        "unscaledValue": "100"
      },
      "status": "ENABLED",
      "type": "APP_ACCOUNT"
    }
  ],
  "nextPageToken": "MA=",
  "prevPageToken": "MA==",
  "totalSize": "1"
}