v1

latestOpenAPI 3.0.12026-08-0674476716.0 KB

Settlement Accounts

Get a settlement rule

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}

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"
    },
    "description": "Auto Payout"
  }
}