Sign in

v51

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-3196247792.5 KB
Managed payout schedules

Get a specific managed payout schedule on your balance platform

Returns the specified managed payout schedule configured on your balance platform.

get/balancePlatforms/{balancePlatformId}/payoutSchedules/{id}

Path parameters

balancePlatformIdstring required

The unique identifier of the balance platform.

idstring required

The unique identifier of the payout configuration for your balance platform.

Response

OK - The request has succeeded.

automaticApplicationboolean

Specifies whether this payout schedule is automatically applied to new balance accounts.

balancePlatformIdstring required

The balance platform to which the payout schedule applies.

countryCodestring

The two-letter ISO 3166-1 alpha-2 code of the country to which the payout schedule applies.

createdAtstring date-time required

The date when the payout schedule was created.

currencystring

The three-character ISO code of the currency used for the payout schedule.

defaultDescriptionstring

The default description for payouts initiated by this payout schedule.

defaultFrequencystring
defaultFrequencyValueinteger

The default value for date of the month or day of the week when payouts are initiated. Allowed only if defaultFrequency is monthly or weekly.

Possible values if defaultFrequency is monthly: [1 - 31].

  • If your specified date happens on a weekend, the payout is initiated on the next business day.
  • If your specified date (29, 30, or 31) does not exist in a month, the payout is initiated on the last day of that month.

Possible values if defaultFrequency is weekly: [1 - 5].

defaultReferencestring

Your internal default reference for the payout schedule.When the payout schedule is applied to a balance account, this reference is also used for that payout schedule.

defaultReferenceForBeneficiarystring

The default reference for beneficiary for payouts initiated by this payout schedule.

enabledboolean

Specifies whether the payout schedule is enabled immediately after it is created.

idstring

The unique identifier of the payout schedule for your balance platform.

maxPayoutAmountinteger

The maximum amount that can be paid out from balance accounts that use this payout schedule.

Default value: 0, which means that there is no maximum limit.

minPayoutAmountinteger

The minimum amount that can be paid out from balance accounts that use this payout schedule.

Default value: 0.

payoutScheduleDescriptionstring required

The type of payout schedule. This type indicates how fast funds are paid out to your user.

Possible values:

  • Standard: The funds arrive in your user's transfer instrument two days after the funds are settled.
  • Accelerated: The funds arrive to your user's transfer instrument the day after the funds are settled.
retainedAmountinteger

The amount of funds that must remain available in a balance account after an execution of the payout schedule. If the funds in the balance account are less than the retained amount, the execution is not initiated.

Default value: 0

updatedAtstring date-time

The date when the payout schedule was updated.

userSettlementDelayinteger required

The default settlement delay for this payout schedule.

userSettlementTimeZonestring required

The timezone of the userSettlementTime.