A Recipient represents the beneficiary and the beneficiary account (typically a bank account) of a payout.
The new set of Recipient endpoints replaces the legacy Bank Account endpoints, including bank account types.
Each recipient can be used for one combination of a payout method and currency, which together determine the account details required.
The Recipients feature also provides endpoints for you to:
Dynamically retrieve the schema of a Recipient
Validate a user’s data in advance of registering the account
Recipient registration for payouts also systematically requires SCA, thereby enabling the payout request benefit from an SCA exemption as a trusted beneficiary.
Possible values:PENDING, CANCELED, ACTIVE, DEACTIVATED
The status of the recipient:
PENDING – For PAYOUT scope recipients, the user must complete SCA before the recipient can become ACTIVE. For PAYIN scope recipients, the recipient creation is in progress.
CANCELED – SCA was not successful and the recipient creation request was canceled. To retry, create another recipient to retrieve another PendingUserAction.RedirectUrl. The CANCELED status does not apply if RecipientScope is PAYIN.
ACTIVE – Recipient creation was successful (including SCA if RecipientScope is PAYOUT) and the recipient is ready to be used for payouts .
DEACTIVATED – The recipient has been permanently deactivated and can no longer be used.
PAYOUT – Usable for payouts and in pay-in use cases. A PAYOUT recipient can only be created by a user with the UserCategoryOWNER and requires SCA. You need to use the returned PendingUserAction.RedirectUrl value, adding your encoded returnUrl as 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. A PAYIN recipient can be created by a user with the UserCategoryPAYER or OWNER, and does not require SCA.
Both PAYIN and PAYOUT scopes can be created for either InternationalBankTransfer or LocalBankTransfer, and for either IndividualRecipient or BusinessRecipient, and for any Currency.
The URL to which to redirect the user to perform strong customer authentication (SCA) via a Mangopay-hosted webpage. This value is a variable and should not be hardcoded.
The SCA session link expires 10 minutes after it’s generated.
Caution: Before redirecting the user on this URL, you must add the query parameter ReturnUrl with the percent-encoded URL to which you want the SCA session to return the user after authentication (whether successful or not).
