You're reading version 2024-06-01, which is not the latest. The latest is 2026-04-01: see this page in 2026-04-01.

PayoutDetails

activeboolean

Indicates if the payout is active.

amountMonetaryAmount

Amount to be paid out.

lifelongPayoutboolean

Indicates if the payout has a defined end.

periodPayoutPeriod

Period for the payout, can be a range of ages or dates.

Example

{
  "active": false,
  "amount": {
    "amount": 10.32,
    "currency": "EUR"
  },
  "lifelongPayout": false,
  "period": {
    "type": "AGE_RANGE"
  }
}

{  "active": false,  "amount": {    "amount": 10.32,    "currency": "EUR"  },  "lifelongPayout": false,  "period": {    "type": "AGE_RANGE"  }}