// GET has no body parameters
{
"DisplayName": {
"Required": true,
"MaxLength": 50,
"Pattern": "^(?!.*[&,'/]).{1,50}$",
"Label": "Display Name",
"EndUserDisplay": "Show"
},
"Currency": {
"AllowedValues": [
"EUR"
],
"Required": true,
"MaxLength": 3,
"MinLength": 3,
"Pattern": "^[a-zA-Z]{3}$",
"Label": "Currency",
"EndUserDisplay": "Hide"
},
"Country": {
"AllowedValues": [
"US"
],
"Required": true,
"MaxLength": 2,
"MinLength": 2,
"Pattern": "^[a-zA-Z]{2}$",
"Label": "Destination Country",
"EndUserDisplay": "Hide"
},
"RecipientType": {
"AllowedValues": [
"Individual"
],
"Required": true,
"Pattern": "^[a-zA-Z]+$",
"Label": "Recipient Type",
"EndUserDisplay": "Hide"
},
"PayoutMethodType": {
"AllowedValues": [
"InternationalBankTransfer"
],
"Required": true,
"Pattern": "^[a-zA-Z]+$",
"Label": "Payout Method Type",
"EndUserDisplay": "Hide"
},
"Tag": {
"Required": false,
"MaxLength": 255,
"Pattern": "^.{0,255}$",
"Label": "Tag",
"EndUserDisplay": "Hide"
},
"RecipientScope": {
"AllowedValues": [
"PAYOUT",
"PAYIN"
],
"Required": false,
"Pattern": "^[a-zA-Z]+$",
"Label": "Recipient Scope",
"EndUserDisplay": "Hide"
},
"IndividualRecipient": {
"FirstName": {
"Required": true,
"MaxLength": 255,
"Pattern": "^(?!.*[()&,.:_/]).{1,255}$",
"Label": "First Name",
"EndUserDisplay": "Show"
},
"LastName": {
"Required": true,
"MaxLength": 255,
"Pattern": "^(?!.*[()&,.:_/]).{1,255}$",
"Label": "Last Name",
"EndUserDisplay": "Show"
},
"Address": {
"AddressLine1": {
"Required": true,
"MaxLength": 255,
"Pattern": "^(?!.*[()/]).{1,255}$",
"Label": "Address Line 1",
"EndUserDisplay": "Show"
},
"AddressLine2": {
"Required": false,
"MaxLength": 255,
"Pattern": "^(?!.*[()/]).{1,255}$",
"Label": "Address Line 2",
"EndUserDisplay": "Show"
},
"City": {
"Required": true,
"MaxLength": 80,
"Pattern": "^(?!.*[&,.:_]).{1,80}$",
"Label": "City",
"EndUserDisplay": "Show"
},
"Country": {
"Required": true,
"MaxLength": 2,
"MinLength": 2,
"Pattern": "^[a-zA-Z]+$",
"Label": "Country",
"EndUserDisplay": "Show"
},
"Region": {
"Required": false,
"MaxLength": 50,
"Pattern": "^(?!.*[&,.:_/]).{1,50}$",
"Label": "Region",
"EndUserDisplay": "Show"
},
"PostalCode": {
"Required": true,
"MaxLength": 10,
"Pattern": "^(?!.*[()&,.:_'/]).{1,10}$",
"Label": "Postal Code",
"EndUserDisplay": "Show"
}
}
},
"InternationalBankTransfer": {
"AccountNumber": {
"Required": true,
"MaxLength": 12,
"MinLength": 8,
"Pattern": "^[0-9a-zA-Z]{8,12}$",
"Label": "Account Number",
"EndUserDisplay": "Show"
},
"BIC": {
"Required": true,
"Pattern": "^[0-9a-zA-Z]{8}([0-9a-zA-Z]{3})?$",
"Label": "BIC",
"EndUserDisplay": "Show"
}
}
}
View the schema for a Recipient
Fetch the data requirements for a given currency, payout method type, and recipient type
// GET has no body parameters
{
"DisplayName": {
"Required": true,
"MaxLength": 50,
"Pattern": "^(?!.*[&,'/]).{1,50}$",
"Label": "Display Name",
"EndUserDisplay": "Show"
},
"Currency": {
"AllowedValues": [
"EUR"
],
"Required": true,
"MaxLength": 3,
"MinLength": 3,
"Pattern": "^[a-zA-Z]{3}$",
"Label": "Currency",
"EndUserDisplay": "Hide"
},
"Country": {
"AllowedValues": [
"US"
],
"Required": true,
"MaxLength": 2,
"MinLength": 2,
"Pattern": "^[a-zA-Z]{2}$",
"Label": "Destination Country",
"EndUserDisplay": "Hide"
},
"RecipientType": {
"AllowedValues": [
"Individual"
],
"Required": true,
"Pattern": "^[a-zA-Z]+$",
"Label": "Recipient Type",
"EndUserDisplay": "Hide"
},
"PayoutMethodType": {
"AllowedValues": [
"InternationalBankTransfer"
],
"Required": true,
"Pattern": "^[a-zA-Z]+$",
"Label": "Payout Method Type",
"EndUserDisplay": "Hide"
},
"Tag": {
"Required": false,
"MaxLength": 255,
"Pattern": "^.{0,255}$",
"Label": "Tag",
"EndUserDisplay": "Hide"
},
"RecipientScope": {
"AllowedValues": [
"PAYOUT",
"PAYIN"
],
"Required": false,
"Pattern": "^[a-zA-Z]+$",
"Label": "Recipient Scope",
"EndUserDisplay": "Hide"
},
"IndividualRecipient": {
"FirstName": {
"Required": true,
"MaxLength": 255,
"Pattern": "^(?!.*[()&,.:_/]).{1,255}$",
"Label": "First Name",
"EndUserDisplay": "Show"
},
"LastName": {
"Required": true,
"MaxLength": 255,
"Pattern": "^(?!.*[()&,.:_/]).{1,255}$",
"Label": "Last Name",
"EndUserDisplay": "Show"
},
"Address": {
"AddressLine1": {
"Required": true,
"MaxLength": 255,
"Pattern": "^(?!.*[()/]).{1,255}$",
"Label": "Address Line 1",
"EndUserDisplay": "Show"
},
"AddressLine2": {
"Required": false,
"MaxLength": 255,
"Pattern": "^(?!.*[()/]).{1,255}$",
"Label": "Address Line 2",
"EndUserDisplay": "Show"
},
"City": {
"Required": true,
"MaxLength": 80,
"Pattern": "^(?!.*[&,.:_]).{1,80}$",
"Label": "City",
"EndUserDisplay": "Show"
},
"Country": {
"Required": true,
"MaxLength": 2,
"MinLength": 2,
"Pattern": "^[a-zA-Z]+$",
"Label": "Country",
"EndUserDisplay": "Show"
},
"Region": {
"Required": false,
"MaxLength": 50,
"Pattern": "^(?!.*[&,.:_/]).{1,50}$",
"Label": "Region",
"EndUserDisplay": "Show"
},
"PostalCode": {
"Required": true,
"MaxLength": 10,
"Pattern": "^(?!.*[()&,.:_'/]).{1,10}$",
"Label": "Postal Code",
"EndUserDisplay": "Show"
}
}
},
"InternationalBankTransfer": {
"AccountNumber": {
"Required": true,
"MaxLength": 12,
"MinLength": 8,
"Pattern": "^[0-9a-zA-Z]{8,12}$",
"Label": "Account Number",
"EndUserDisplay": "Show"
},
"BIC": {
"Required": true,
"Pattern": "^[0-9a-zA-Z]{8}([0-9a-zA-Z]{3})?$",
"Label": "BIC",
"EndUserDisplay": "Show"
}
}
}
Query parameters
LocalBankTransfer, InternationalBankTransferThe payout method.AED, AUD, CAD, CHF, CNH, CZK, DKK, EUR, GBP, HKD, HUF, ILS, JPY, MXN, NOK, NZD, PLN, RON, SAR, SEK, SGD, TRY, USD, ZARThe currency of the recipient.Individual, BusinessThe recipient type:Individual– An account held by a natural personBusiness– An account held by a legal entity
Responses
200
200
DisplayName property.Show properties
Show properties
Show, HideRecommendation on whether to show or hide the field (and Label) to the end user.Currency property.Show properties
Show properties
Show, HideRecommendation on whether to show or hide the field (and Label) to the end user.Country property.Show properties
Show properties
Show, HideRecommendation on whether to show or hide the field (and Label) to the end user.RecipientType property.Show properties
Show properties
Show, HideRecommendation on whether to show or hide the field (and Label) to the end user.PayoutMethodType property.Show properties
Show properties
Show, HideRecommendation on whether to show or hide the field (and Label) to the end user.- Individual
- Business
IndividualRecipient property.Show properties
Show properties
FirstName property.Show properties
Show properties
Show, HideRecommendation on whether to show or hide the field (and Label) to the end user.LastName property.Show properties
Show properties
Show, HideRecommendation on whether to show or hide the field (and Label) to the end user.Address object.Show properties
Show properties
AddressLine1 property.Show child attributes
Show child attributes
Show, HideRecommendation on whether to show or hide the field (and Label) to the end user.AddressLine2 property.Show child attributes
Show child attributes
Show, HideRecommendation on whether to show or hide the field (and Label) to the end user.City property.Show child attributes
Show child attributes
Show, HideRecommendation on whether to show or hide the field (and Label) to the end user.Country property.Show child attributes
Show child attributes
Show, HideRecommendation on whether to show or hide the field (and Label) to the end user.Region property.Show child attributes
Show child attributes
Show, HideRecommendation on whether to show or hide the field (and Label) to the end user.PostalCode property.Show child attributes
Show child attributes
Show, HideRecommendation on whether to show or hide the field (and Label) to the end user.BusinessRecipient property.Show properties
Show properties
BusinessName property.Show properties
Show properties
Show, HideRecommendation on whether to show or hide the field (and Label) to the end user.Address object.Show properties
Show properties
AddressLine1 property.Show child attributes
Show child attributes
Show, HideRecommendation on whether to show or hide the field (and Label) to the end user.AddressLine2 property.Show child attributes
Show child attributes
Show, HideRecommendation on whether to show or hide the field (and Label) to the end user.City property.Show child attributes
Show child attributes
Show, HideRecommendation on whether to show or hide the field (and Label) to the end user.Country property.Show child attributes
Show child attributes
Show, HideRecommendation on whether to show or hide the field (and Label) to the end user.Region property.Show child attributes
Show child attributes
Show, HideRecommendation on whether to show or hide the field (and Label) to the end user.PostalCode property.Show child attributes
Show child attributes
Show, HideRecommendation on whether to show or hide the field (and Label) to the end user.- InternationalBankTransfer
- LocalBankTransfer
InternationalBankTransfer property.Hide properties
Hide properties
AccountNumber property.Show properties
Show properties
Show, HideRecommendation on whether to show or hide the field (and Label) to the end user.BIC property (returned if required).Show properties
Show properties
Show, HideRecommendation on whether to show or hide the field (and Label) to the end user.LocalBankTransfer property. One of:- CAD
- CHF
- CZK
- DKK
- EUR
- GBP
- HUF
- NOK
- PLN
- RON
- SEK
- USD
CAD property.Hide properties
Hide properties
AccountNumber property.Show properties
Show properties
Show, HideRecommendation on whether to show or hide the field (and Label) to the end user.InstitutionNumber property.Show properties
Show properties
Show, HideRecommendation on whether to show or hide the field (and Label) to the end user.BranchCode property.Show properties
Show properties
Show, HideRecommendation on whether to show or hide the field (and Label) to the end user.CHF property.Hide properties
Hide properties
IBAN property.Show properties
Show properties
Show, HideRecommendation on whether to show or hide the field (and Label) to the end user.CZK property.Hide properties
Hide properties
IBAN property.Show properties
Show properties
Show, HideRecommendation on whether to show or hide the field (and Label) to the end user.DKK property.Hide properties
Hide properties
IBAN property.Show properties
Show properties
Show, HideRecommendation on whether to show or hide the field (and Label) to the end user.EUR property.Hide properties
Hide properties
IBAN property.Show properties
Show properties
Show, HideRecommendation on whether to show or hide the field (and Label) to the end user.Hide properties
Hide properties
AccountNumber property.Show properties
Show properties
Show, HideRecommendation on whether to show or hide the field (and Label) to the end user.SortCode property.Show properties
Show properties
Show, HideRecommendation on whether to show or hide the field (and Label) to the end user.HUF property.Hide properties
Hide properties
IBAN property.Show properties
Show properties
Show, HideRecommendation on whether to show or hide the field (and Label) to the end user.NOK property.Hide properties
Hide properties
IBAN property.Show properties
Show properties
Show, HideRecommendation on whether to show or hide the field (and Label) to the end user.PLN property.Hide properties
Hide properties
IBAN property.Show properties
Show properties
Show, HideRecommendation on whether to show or hide the field (and Label) to the end user.RON property.Hide properties
Hide properties
IBAN property.Show properties
Show properties
Show, HideRecommendation on whether to show or hide the field (and Label) to the end user.SEK property.Hide properties
Hide properties
IBAN property.Show properties
Show properties
Show, HideRecommendation on whether to show or hide the field (and Label) to the end user.USD property.Hide properties
Hide properties
AccountNumber property.Show properties
Show properties
Show, HideRecommendation on whether to show or hide the field (and Label) to the end user.ABA property.Show properties
Show properties
Show, HideRecommendation on whether to show or hide the field (and Label) to the end user.FFC property.Show properties
Show properties
Show, HideRecommendation on whether to show or hide the field (and Label) to the end user.400 - Domestic rail not available for Currency-Country combination
400 - Domestic rail not available for Currency-Country combination
LocalBankTransfer) is not available for the Currency and Country combination.To send the given Currency to the Country, the Recipient must have the InternationalBankTransfer payout method type, which also defaults to local rails.Read more about how Mangopay routes funds →{
"Id": "50768465-d817-4caf-9488-e71b967b6692",
"Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
"Type": "param_error",
"Date": 1749822248,
"Errors": {
"PayoutMethodType": "UNSUPPORTED_CURRENCY_FOR_PAYOUT_METHOD"
}
}
{
"Id": "410e8496-64cb-4594-83c3-0d66f85f4abe",
"Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
"Type": "param_error",
"Date": 1747210826,
"Errors": {
"PayoutMethodType": "UNSUPPORTED_PAYOUT_METHOD_FOR_CURRENCY"
}
}
400 - Country not allowed
400 - Country not allowed
{
"Id": "cd4c2f11-ccb7-4227-9d64-98a165ce6180",
"Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
"Type": "param_error",
"Date": 1756383648,
"Errors": {
"Country": "UNSUPPORTED_COUNTRY",
"PayoutMethodType": "UNSUPPORTED_CURRENCY_FOR_PAYOUT_METHOD"
}
}
{
"DisplayName": {
"Required": true,
"MaxLength": 50,
"Pattern": "^(?!.*[&,'/]).{1,50}$",
"Label": "Display Name",
"EndUserDisplay": "Show"
},
"Currency": {
"AllowedValues": [
"EUR"
],
"Required": true,
"MaxLength": 3,
"MinLength": 3,
"Pattern": "^[a-zA-Z]{3}$",
"Label": "Currency",
"EndUserDisplay": "Hide"
},
"Country": {
"AllowedValues": [
"US"
],
"Required": true,
"MaxLength": 2,
"MinLength": 2,
"Pattern": "^[a-zA-Z]{2}$",
"Label": "Destination Country",
"EndUserDisplay": "Hide"
},
"RecipientType": {
"AllowedValues": [
"Individual"
],
"Required": true,
"Pattern": "^[a-zA-Z]+$",
"Label": "Recipient Type",
"EndUserDisplay": "Hide"
},
"PayoutMethodType": {
"AllowedValues": [
"InternationalBankTransfer"
],
"Required": true,
"Pattern": "^[a-zA-Z]+$",
"Label": "Payout Method Type",
"EndUserDisplay": "Hide"
},
"Tag": {
"Required": false,
"MaxLength": 255,
"Pattern": "^.{0,255}$",
"Label": "Tag",
"EndUserDisplay": "Hide"
},
"RecipientScope": {
"AllowedValues": [
"PAYOUT",
"PAYIN"
],
"Required": false,
"Pattern": "^[a-zA-Z]+$",
"Label": "Recipient Scope",
"EndUserDisplay": "Hide"
},
"IndividualRecipient": {
"FirstName": {
"Required": true,
"MaxLength": 255,
"Pattern": "^(?!.*[()&,.:_/]).{1,255}$",
"Label": "First Name",
"EndUserDisplay": "Show"
},
"LastName": {
"Required": true,
"MaxLength": 255,
"Pattern": "^(?!.*[()&,.:_/]).{1,255}$",
"Label": "Last Name",
"EndUserDisplay": "Show"
},
"Address": {
"AddressLine1": {
"Required": true,
"MaxLength": 255,
"Pattern": "^(?!.*[()/]).{1,255}$",
"Label": "Address Line 1",
"EndUserDisplay": "Show"
},
"AddressLine2": {
"Required": false,
"MaxLength": 255,
"Pattern": "^(?!.*[()/]).{1,255}$",
"Label": "Address Line 2",
"EndUserDisplay": "Show"
},
"City": {
"Required": true,
"MaxLength": 80,
"Pattern": "^(?!.*[&,.:_]).{1,80}$",
"Label": "City",
"EndUserDisplay": "Show"
},
"Country": {
"Required": true,
"MaxLength": 2,
"MinLength": 2,
"Pattern": "^[a-zA-Z]+$",
"Label": "Country",
"EndUserDisplay": "Show"
},
"Region": {
"Required": false,
"MaxLength": 50,
"Pattern": "^(?!.*[&,.:_/]).{1,50}$",
"Label": "Region",
"EndUserDisplay": "Show"
},
"PostalCode": {
"Required": true,
"MaxLength": 10,
"Pattern": "^(?!.*[()&,.:_'/]).{1,10}$",
"Label": "Postal Code",
"EndUserDisplay": "Show"
}
}
},
"InternationalBankTransfer": {
"AccountNumber": {
"Required": true,
"MaxLength": 12,
"MinLength": 8,
"Pattern": "^[0-9a-zA-Z]{8,12}$",
"Label": "Account Number",
"EndUserDisplay": "Show"
},
"BIC": {
"Required": true,
"Pattern": "^[0-9a-zA-Z]{8}([0-9a-zA-Z]{3})?$",
"Label": "BIC",
"EndUserDisplay": "Show"
}
}
}
// GET has no body parameters
Was this page helpful?