Overview
User management
- Users
- User regulatory status
- User e-money
User verification
- User data format
- KYC documents
- UBO declarations
Wallets
- User wallets
- Client wallets
Cards
- Card registrations
- Cards
- Metadata
- Card validations
Card pay-ins
- Direct card pay-ins
- Recurring card pay-ins
- Preauthorizations
- Deposit preauthorizations
- Web card pay-ins
Banking pay-ins
- Bank wires
- Pay by bank
- Virtual IBAN
- Direct debits
- Web direct debits
APM pay-ins
- Apple Pay
- Bancontact
- BLIK
- Giropay
- Google Pay
- iDEAL
- Klarna
- MB WAY
- Multibanco
- Payconiq
- PayPal
- Satispay
- Swish
- TWINT
Transfers
- Transfers
Refunds
- Refunds
Disputes
- Disputes
- Dispute documents
- Repudiations
- Dispute settlement
Payouts
FX conversions
- Conversion rates
- Quotes
- Conversions
Transactions
- Transactions
Helpers
- API responses
- Country authorizations
- Webhooks
- Events
- Reports
Platform account
- Client
- Dashboard permissions
View a Recipient
Fetch a recipient based on its ID
// GET has no body parameters
{
"Id": "rec_01JRADYFJYPFM10XPQ8VFWW947",
"Status": "ACTIVE",
"CreationDate": 1744106896,
"DisplayName": "Alex Smith EUR international payout account",
"PayoutMethodType": "InternationalBankTransfer",
"RecipientType": "Business",
"Currency": "EUR",
"UserId": "user_m_01JRADX7YD0060N5VAA0XPMM54",
"Tag": "Created using the Mangopay API Postman collection",
"RecipientScope": "PAYOUT",
"BusinessRecipient": {
"BusinessName": "Alex Smith Consulting",
"Address": {
"AddressLine1": "3 rue de la Cité",
"AddressLine2": "Appartement 7",
"City": "Paris",
"Region": "Ile de France",
"PostalCode": "75001",
"Country": "FR"
}
},
"InternationalBankTransfer": {
"IBAN": "FR7630004000031234567890143",
"BIC": "BNPAFRPPXXX"
}
}
Path parameters
The unique identifier of the Recipient.
Responses
The unique identifier of the object.
Possible values: PENDING, CANCELED, ACTIVE, DEACTIVATED
The status of the recipient:
PENDING– ForPAYOUTscope recipients, the user must complete SCA before the recipient can becomeACTIVE. ForPAYINscope 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 anotherPendingUserAction.RedirectUrl. TheCANCELEDstatus does not apply ifRecipientScopeisPAYIN.ACTIVE– Recipient creation was successful (including SCA ifRecipientScopeisPAYOUT) and the recipient is ready to be used for payouts .DEACTIVATED– The recipient has been permanently deactivated and can no longer be used.
The date and time at which the object was created.
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.
The unique identifier of the user.
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.
Both PAYIN and PAYOUT scopes can be created for either InternationalBankTransfer or LocalBankTransfer, and for either IndividualRecipient or BusinessRecipient, and for any Currency.
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.
Length: 1–255; cannot contain: ()&,.:_/ (Pattern: ^(?!.*[()&,.:_/]).{1,255}$)
The first name of the individual account holder.
Length: 1–255; cannot contain: ()&,.:_/ (Pattern: ^(?!.*[()&,.:_/]).{1,255}$)
The last name of the individual account holder.
Information about the address.
Length: 1–255; cannot contain: ()/ (Pattern: ^(?!.*[()/]).{1,255}$)
The first line of the address.
Length: 1–255; cannot contain: ()/ (Pattern: ^(?!.*[()/]).{1,255}$)
The second line of the address. Parameter only returned if sent.
Length: 1-80; cannot contain: &,.:_' (pattern: ^(?!.*[&,.:_']).{1,80}$)
The city of the address.
Length: 1–10; cannot contain: &,.:_'-/ (pattern: ^(?!.*[&,.:_'-/]).{1,50}$)
The region of the address. Parameter only returned if sent.
Length: 1–10; cannot contain: ()&,.:_'/ (pattern: ^(?!.*[()&,.:_'/]).{1,10}$)
The postal code of the address.
Format: Two-letter country code (ISO 3166-1 alpha-2 format)
The country of the address.
The account holder if the RecipientType is Individual.
Length: 1–255; cannot contain: ()&,.:_/ (Pattern: ^(?!.*[()&,.:_/]).{1,255}$)
The first name of the individual account holder.
Length: 1–255; cannot contain: ()&,.:_/ (Pattern: ^(?!.*[()&,.:_/]).{1,255}$)
The last name of the individual account holder.
Information about the address.
Length: 1–255; cannot contain: ()/ (Pattern: ^(?!.*[()/]).{1,255}$)
The first line of the address.
Length: 1–255; cannot contain: ()/ (Pattern: ^(?!.*[()/]).{1,255}$)
The second line of the address. Parameter only returned if sent.
Length: 1-80; cannot contain: &,.:_' (pattern: ^(?!.*[&,.:_']).{1,80}$)
The city of the address.
Length: 1–10; cannot contain: &,.:_'-/ (pattern: ^(?!.*[&,.:_'-/]).{1,50}$)
The region of the address. Parameter only returned if sent.
Length: 1–10; cannot contain: ()&,.:_'/ (pattern: ^(?!.*[()&,.:_'/]).{1,10}$)
The postal code of the address.
Format: Two-letter country code (ISO 3166-1 alpha-2 format)
The country of the address.
The account holder if the RecipientType is Business.
Length: 1–255; cannot contain: (),.:/ (Pattern: ^(?!.*[(),.:/]).{1,255}$)
The name of the business account holder.
Information about the address.
Length: 1–255; cannot contain: ()/ (Pattern: ^(?!.*[()/]).{1,255}$)
The first line of the address.
Length: 1–255; cannot contain: ()/ (Pattern: ^(?!.*[()/]).{1,255}$)
The second line of the address. Parameter only returned if sent.
Length: 1-80; cannot contain: &,.:_' (pattern: ^(?!.*[&,.:_']).{1,80}$)
The city of the address.
Length: 1–10; cannot contain: &,.:_'-/ (pattern: ^(?!.*[&,.:_'-/]).{1,50}$)
The region of the address. Parameter only returned if sent.
Length: 1–10; cannot contain: ()&,.:_'/ (pattern: ^(?!.*[()&,.:_'/]).{1,10}$)
The postal code of the address.
Format: Two-letter country code (ISO 3166-1 alpha-2 format)
The country of the address.
The account details if PayoutMethodType is LocalBankTransfer, depending on the Currency. One of:
Format: 3 digits (pattern: ^\\d{3}$)
The institution number of the Canadian account.
Length: 1–50
The bank name of the Canadian account.
Format: 5 digits (pattern: ^\\d{5}$)
The branch code of the Canadian account.
Format: 7–35 digits (pattern: ^\\d{7,35}$)
The account number of the Canadian account.
Format: 8–11 alphanumeric characters (pattern: ^[0-9a-zA-Z]{8}([0-9a-zA-Z]{3})?$)
The BIC of the Hong Kong account.
Format: 3 alphanumeric characters (pattern: ^[0-9a-zA-Z]{3}$)
The branch code of the Hong Kong account.
Format: 1–50 alphanumeric characters (pattern: ^[0-9a-zA-Z]{1,50}$)
The account number of the Hong Kong account.
Object containing the link needed for SCA redirection if triggered by the API call (otherwise returned null).
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).
For more details, see How to redirect a user for an SCA session.
{
"Id": "rec_01JRADYFJYPFM10XPQ8VFWW947",
"Status": "ACTIVE",
"CreationDate": 1744106896,
"DisplayName": "Alex Smith EUR international payout account",
"PayoutMethodType": "InternationalBankTransfer",
"RecipientType": "Business",
"Currency": "EUR",
"UserId": "user_m_01JRADX7YD0060N5VAA0XPMM54",
"Tag": "Created using the Mangopay API Postman collection",
"RecipientScope": "PAYOUT",
"BusinessRecipient": {
"BusinessName": "Alex Smith Consulting",
"Address": {
"AddressLine1": "3 rue de la Cité",
"AddressLine2": "Appartement 7",
"City": "Paris",
"Region": "Ile de France",
"PostalCode": "75001",
"Country": "FR"
}
},
"InternationalBankTransfer": {
"IBAN": "FR7630004000031234567890143",
"BIC": "BNPAFRPPXXX"
}
}
// GET has no body parameters
Was this page helpful?
// GET has no body parameters
{
"Id": "rec_01JRADYFJYPFM10XPQ8VFWW947",
"Status": "ACTIVE",
"CreationDate": 1744106896,
"DisplayName": "Alex Smith EUR international payout account",
"PayoutMethodType": "InternationalBankTransfer",
"RecipientType": "Business",
"Currency": "EUR",
"UserId": "user_m_01JRADX7YD0060N5VAA0XPMM54",
"Tag": "Created using the Mangopay API Postman collection",
"RecipientScope": "PAYOUT",
"BusinessRecipient": {
"BusinessName": "Alex Smith Consulting",
"Address": {
"AddressLine1": "3 rue de la Cité",
"AddressLine2": "Appartement 7",
"City": "Paris",
"Region": "Ile de France",
"PostalCode": "75001",
"Country": "FR"
}
},
"InternationalBankTransfer": {
"IBAN": "FR7630004000031234567890143",
"BIC": "BNPAFRPPXXX"
}
}