Sign in

v1

latestOpenAPI 3.0.12026-08-0674476716.0 KB
Settlement Accounts

Create a settlement rule

The POST /virtual-accounts/{accountId}/settlement-rule endpoint creates a settlement rule, for a given settlement account.

post/virtual-accounts/{accountId}/settlement-rule

Path parameters

accountIdstring required

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

Request body

accountIdstring required

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

amountType'FIXED_VALUE' | 'PERCENTAGE' | 'BALANCE_TO_RETAIN' required

The type of the amount.

amountValuestring required

The value of the amount.

timeInterval'INTRADAY' | 'DAILY' | 'WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'HALF_YEARLY' | 'YEARLY' required

The time interval.

effectiveFromstring

The start date of the settlement rule is formatted as YYYY-MM-DDTHH:MM:SSZ.

effectiveTostring

The end date of the settlement rule is formatted as YYYY-MM-DDTHH:MM:SSZ.

intradayIntervalHoursinteger required

The intraday interval hours.

intradayIntervalMinutesinteger

The intraday interval minutes.

descriptionstring

The description used for payouts created due to this rule.

The maximum length is 18 characters and allowed characters are alphanumeric, space, hyphen (-), period (.), ampersand (&), and forward slash (/).

Example request

{
  "accountId": "pa:8DbPteGnytmMbKXdnWTReeRB6cYWKXZ84JgLTBC7fKL4:5zKcENpV",
  "payeeAccountDetails": {
    "name": "Customer Inc.",
    "ultimateCreditorName": "Customer Inc.",
    "accountNumber": "12345678",
    "bic": "HBUKGB7F261",
    "iban": "GB29NWBK60161331926819"
  },
  "effectiveFrom": "2024-01-01T12:34:56Z",
  "effectiveTo": "2024-12-01T12:34:56Z",
  "intradayIntervalHours": 2,
  "intradayIntervalMinutes": 10,
  "description": "Auto Payout"
}

Response

Successful response

settlementRuleIdstring uuid

The id of the settlement rule.

Example response

{
  "settlementRuleId": "123e4567-e89b-12d3-a456-426614174000"
}