Create a Recipient
Register a bank account for local or international payouts
Caution – Fetch schema and validate data before creation
Before using this endpoint to register a Recipient for a user, for the given currency, payout method, and recipient type combination, always:
- Fetch the schema dynamically using GET View the schema for a Recipient
- Check that the user’s data is valid using POST Validate data for a Recipient
Note – SCA triggered by this endpoint
Registering a bank account as a Recipient always requires the user to authenticate using SCA on a Mangopay-hosted webpage (read more about SCA on recipients).
To let the user complete the SCA session, your platform needs to retrieve the returned PendingUserAction.RedirectUrl, add an encoded returnUrl query parameter, and redirect the user. Read more about how to redirect them in the SCA session guide.
Path parameters
The unique identifier of the user.
Body parameters
Length: 1–50; cannot contain: &,'/ (pattern:^(?!.*[&,'/]).{1,50}$)
A user-friendly name to identify the account. This value cannot be changed once the recipient is created.
Possible values: InternationalBankTransfer, LocalBankTransfer
The payout method of the recipient:
InternationalBankTransfer– A bank wire transfer sent via SWIFT, requiring theInternationalBankTransferproperty.LocalBankTransfer– A bank wire transfer sent via local routes, requiring theLocalBankTransferproperty.
Possible values: Individual, Business
The recipient type:
Individual– An account held by a natural person, requiring theIndividualRecipientproperty.Business– An account held by a legal entity, requiring theBusinessRecipientproperty.
Possible values: AUD, CAD, EUR, GBP, HKD, SGD, USD
The currency of the recipient.
Possible values: PAYIN, PAYOUT
Default value: PAYOUT
The scope of the recipient:
PAYOUT– Usable for payouts and in pay-in use cases. APAYOUTrecipient can only be created by a user with theUserCategoryOWNERand requires SCA. You need to use the returnedPendingUserAction.RedirectUrlvalue, adding your encodedreturnUrlas a query parameter, to redirect the user to the hosted SCA session so they can complete the necessary steps.PAYIN- Usable for pay-in use cases only, such as direct debit and refunds using payouts. APAYINrecipient can be created by a user with theUserCategoryPAYERorOWNER, and does not require SCA.
Max. length: 255 (pattern: ^.{0,255}$)
Custom data that you can add to this object. This value cannot be changed once the recipient is created.
The account holder if the RecipientType is Individual.
Only one of IndividualRecipient or BusinessRecipient is required.
The account holder if the RecipientType is Individual.
Only one of IndividualRecipient or BusinessRecipient is required.
The account holder if the RecipientType is Business.
Only one of IndividualRecipient or BusinessRecipient is required.
The account details if PayoutMethodType is InternationalBankTransfer.
Only one of InternationalBankTransfer or LocalBankTransfer is required.
The account details if PayoutMethodType is InternationalBankTransfer.
Only one of InternationalBankTransfer or LocalBankTransfer is required.
The account details if PayoutMethodType is LocalBankTransfer.
Only one of InternationalBankTransfer or LocalBankTransfer is required.
The LocalBankTransfer depends on the Currency. One of:
Responses
Was this page helpful?