Skip to main content

This type allows the user to change the payout percentages for two active payment instruments.

Type that uses UpdatePayoutPercentage

UpdatePayoutPercentageRequest

Call that uses UpdatePayoutPercentage

Fields

Field
Type
Description
instrumentId
The unique reference identifier for a payout instrument. This value is returned in the getPayoutSettings response and is needed to change split-payout percentages through an updatePayoutPercentage request.
payoutPercentage
The user-defined payout percentage allocated to this instrument. For example, 50 indicates that 50% of the payout goes to this instrument.

The split-payout percentage must be a positive integer value from 0-100. The values of two instruments must always add up to 100%. If the values do not equal 100, the call will fail.