Call Create a new beneficiary API to save and manage beneficiaries that you can use for creating payouts using
Refer to the dynamic schema API for precise field requirements specific to the intended payout scenario. If you specify a parameter that is either not required or not on the full schema, it will be ignored and removed from the response. Please find below further considerations on some of the required parameters:
beneficiary.address: required address parameters such as
postcodewill vary according to the specified address country. Please refer to dynamic schema API or call Get the API schema API to obtain the corresponding parameter requirements. The
street_addressmust not be a P.O. box address.
beneficiary.bank_details: required beneficiary bank account details parameters will vary according to the specified payout scenario. Please refer to dynamic schema API or call Get the API schema API to obtain the corresponding parameter requirements.
beneficiary.entity_type: Specify whether the beneficiary is an individual (
PERSONAL) or a business (
beneficiary.last_name: The beneficiary’s name according to the
SWIFTto create an international SWIFT payout; or
LOCALto create a payout via the local clearing system, which is faster and more cost-effective. See Payout network for supported payment methods by countries/regions and currencies.
beneficiary.additional_info.personal_email(Optional): Specify this parameter if you want the beneficiary to receive an email notification upon payout being dispatched. Please contact your Account Manager to enable this feature beforehand.
If you are registered as a platform account, you can call this endpoint on behalf of your connected accounts by specifying the open ID in the