Finances API Version 1.16.0

New Features

The following feature has been added for this release:

Support for split payouts for sellers in mainland China

Sellers in mainland China can now configure split payouts between two separate payment instruments, such as between a bank account and Payoneer. Three existing methods in the Finances API have been updated to support the implementation of split payouts for sellers in Mainland China: getPayout, getPayouts, and getTransactions.

getPayout Schema Updates

The following response fields have been added to the getPayout method:

amount.convertedToValue: Returns the monetary value after conversion is performed, in the currency specified by the convertedToCurrency field.

amount.convertedToCurrency: Returns the code representing the currency of the amount in the convertedToValue field.

payoutInstrument.payoutPercentage: Returns the current payout percentage allocated to a payout instrument with the payouts.

payoutReference: Returns the unique payout reference identifier in split-payout cases.

getPayouts Schema Updatess

The following response fields have been added to the getPayouts method:

amount.convertedToValue: Returns the monetary value after conversion is performed, in the currency specified by the convertedToCurrency field.

amount.convertedToCurrency: Returns the code representing the currency of the amount in the convertedToValue field.

payouts.payoutInstrument.payoutPercentage: Returns the current payout percentage allocated to a payout instrument with the payouts.

payouts.payoutReference: Returns the unique payout reference identifier in split-payout cases.

The following response field has been modified based on the introduction of split payouts:

payouts.transactionCount: Returns the number of monetary transactions that have occurred with the corresponding payout. For a split payout scenario, each of the two sibling payouts would be considered its own transaction.

In addition, the payoutReference filter can be applied to split-payout cases to allow users to control the payouts that are returned in the response.

getTransactions Schema Updates

The following type and response fields have been added to the getTransactions method:

payoutDetails: This type provides details for a split-payout case.

payoutDetails.payoutReference: Returns the unique identifier reference.

payoutdetails.payoutIds: Returns the list of true(actual) payout ids associated with a split payout.

transaction.payoutid: Returns the unique identifier associated with a monetary transaction.

In addition, the payoutReference filter parameter can be used to allow users to control the transactions that are returned in the response for split-payout cases.