Settlement Accounts

Get settlement rules

Changed on

The GET /virtual-accounts/{accountId}/settlement-rules endpoint retrieves information about settlement rules, for a given settlement account, according to the settlement rule status in the request. If no status is provided, the endpoint retrieves all settlement rules for the settlement account.

get/virtual-accounts/{accountId}/settlement-rules

Request

  • Base URL
    https://api.token.io
  • URL
    https://api.token.io/virtual-accounts/{accountId}/settlement-rules
  • Auth
    • HTTP bearer
    • or API key in header Authorization

Path parameters

accountIdstring required

The system-generated, unique id which specifies the settlement account.

Request body

accountIdstring

The settlement account id.

status'ACTIVE' | 'INACTIVE'

The status of the settlement rule.

Example request

{
  "accountId": "pa:8DbPteGnytmMbKXdnWTReeRB6cYWKXZ84JgLTBC7fKL4:5zKcENpV"
}

Response

Successful response

Example response

{
  "settlementRule": [
    {
      "payeeAccountDetails": {
        "name": "Customer Inc.",
        "ultimateCreditorName": "Customer Inc.",
        "accountNumber": "12345678",
        "bic": "HBUKGB7F261",
        "iban": "GB29NWBK60161331926819"
      },
      "intradayIntervalHours": 2,
      "intradayIntervalMinutes": 10,
      "onBehalfOfId": "c5a863bc-86f2-4418-a26f-25b24c7983c7",
      "description": "Auto Payout",
      "enableDynamicRef": true
    }
  ]
}

Changes

  • 4e8c473aff5cRevision changes
    • warning

      removed the optional property // from the response with the status

    • warning

      added the new PREVIOUS_DAY_TOTAL enum value to the // response property for the response status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status