Settlement Accounts

Get a settlement rule

Changed on

The GET /virtual-accounts/{accountId}/settlement-rules/{settlementRuleId} endpoint retrieves information for a specific settlement rule, for a given settlement account.

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

Request

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

Path parameters

accountIdstring required

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

settlementRuleIdstring required

The id of the settlement rule.

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