> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mangopay.com/llms.txt
> Use this file to discover all available pages before exploring further.
# View the schema for a Recipient
> Fetch the data requirements for a given currency, payout method type, and recipient type
### Query parameters
**Allowed values:** `LocalBankTransfer`, `InternationalBankTransfer`
The payout method.
**Allowed values:** The three-letter ISO 4217 code of a supported currency: `AED`, `AUD`, `CAD`, `CHF`, `CNH`, `CZK`, `DKK`, `EUR`, `GBP`, `HKD`, `HUF`, `ILS`, `JPY`, `MXN`, `NOK`, `NZD`, `PLN`, `RON`, `SAR`, `SEK`, `SGD`, `TRY`, `USD`, `ZAR`
The currency of the recipient.
Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats))
The destination country of the payout method.
**Possible values:** `Individual`, `Business`
The recipient type:
* `Individual` – An account held by a natural person
* `Business` – An account held by a legal entity
### Responses
The schema of the `DisplayName` property.
Whether the field is required or not.
The maximum length of the string.
The regex describing the accepted value of the string.
A label that platforms can use when displaying or requesting the field to the end user.
**Possible values:** `Show`, `Hide`
Recommendation on whether to show or hide the field (and `Label`) to the end user.
The schema of the `Currency` property.
The allowed values of the string.
Whether the field is required or not.
The maximum length of the string.
The minimum length of the string.
The regex describing the accepted value of the string.
A label that platforms can use when displaying or requesting the field to the end user.
**Possible values:** `Show`, `Hide`
Recommendation on whether to show or hide the field (and `Label`) to the end user.
The schema of the `Country` property.
The allowed values of the string.
Whether the field is required or not.
The maximum length of the string.
The minimum length of the string.
The regex describing the accepted value of the string.
A label that platforms can use when displaying or requesting the field to the end user.
**Possible values:** `Show`, `Hide`
Recommendation on whether to show or hide the field (and `Label`) to the end user.
The schema of the `RecipientType` property.
The allowed values of the string.
Whether the field is required or not.
The regex describing the accepted value of the string.
A label that platforms can use when displaying or requesting the field to the end user.
**Possible values:** `Show`, `Hide`
Recommendation on whether to show or hide the field (and `Label`) to the end user.
The schema of the `PayoutMethodType` property.
The allowed values of the string.
Whether the field is required or not.
The regex describing the accepted value of the string.
A label that platforms can use when displaying or requesting the field to the end user.
**Possible values:** `Show`, `Hide`
Recommendation on whether to show or hide the field (and `Label`) to the end user.
The schema of the `IndividualRecipient` property.
The schema of the `FirstName` property.
Whether the field is required or not.
The maximum length of the string.
The regex describing the accepted value of the string.
A label that platforms can use when displaying or requesting the field to the end user.
**Possible values:** `Show`, `Hide`
Recommendation on whether to show or hide the field (and `Label`) to the end user.
The schema of the `LastName` property.
Whether the field is required or not.
The maximum length of the string.
The regex describing the accepted value of the string.
A label that platforms can use when displaying or requesting the field to the end user.
**Possible values:** `Show`, `Hide`
Recommendation on whether to show or hide the field (and `Label`) to the end user.
The schema of the `Address` object.
The schema of the `AddressLine1` property.
Whether the field is required or not.
The maximum length of the string.
The regex describing the accepted value of the string.
A label that platforms can use when displaying or requesting the field to the end user.
**Possible values:** `Show`, `Hide`
Recommendation on whether to show or hide the field (and `Label`) to the end user.
The schema of the `AddressLine2` property.
Whether the field is required or not.
The maximum length of the string.
The regex describing the accepted value of the string.
A label that platforms can use when displaying or requesting the field to the end user.
**Possible values:** `Show`, `Hide`
Recommendation on whether to show or hide the field (and `Label`) to the end user.
The schema of the `City` property.
Whether the field is required or not.
The maximum length of the string.
The regex describing the accepted value of the string.
A label that platforms can use when displaying or requesting the field to the end user.
**Possible values:** `Show`, `Hide`
Recommendation on whether to show or hide the field (and `Label`) to the end user.
The schema of the `Country` property.
Whether the field is required or not.
The maximum length of the string.
The regex describing the accepted value of the string.
A label that platforms can use when displaying or requesting the field to the end user.
**Possible values:** `Show`, `Hide`
Recommendation on whether to show or hide the field (and `Label`) to the end user.
The schema of the `Region` property.
Whether the field is required or not.
The maximum length of the string.
The regex describing the accepted value of the string.
A label that platforms can use when displaying or requesting the field to the end user.
**Possible values:** `Show`, `Hide`
Recommendation on whether to show or hide the field (and `Label`) to the end user.
The schema of the `PostalCode` property.
Whether the field is required or not.
The maximum length of the string.
The regex describing the accepted value of the string.
A label that platforms can use when displaying or requesting the field to the end user.
**Possible values:** `Show`, `Hide`
Recommendation on whether to show or hide the field (and `Label`) to the end user.
The schema of the `BusinessRecipient` property.
The schema of the `BusinessName` property.
Whether the field is required or not.
The maximum length of the string.
The regex describing the accepted value of the string.
A label that platforms can use when displaying or requesting the field to the end user.
**Possible values:** `Show`, `Hide`
Recommendation on whether to show or hide the field (and `Label`) to the end user.
The schema of the `Address` object.
The schema of the `AddressLine1` property.
Whether the field is required or not.
The maximum length of the string.
The regex describing the accepted value of the string.
A label that platforms can use when displaying or requesting the field to the end user.
**Possible values:** `Show`, `Hide`
Recommendation on whether to show or hide the field (and `Label`) to the end user.
The schema of the `AddressLine2` property.
Whether the field is required or not.
The maximum length of the string.
The regex describing the accepted value of the string.
A label that platforms can use when displaying or requesting the field to the end user.
**Possible values:** `Show`, `Hide`
Recommendation on whether to show or hide the field (and `Label`) to the end user.
The schema of the `City` property.
Whether the field is required or not.
The maximum length of the string.
The regex describing the accepted value of the string.
A label that platforms can use when displaying or requesting the field to the end user.
**Possible values:** `Show`, `Hide`
Recommendation on whether to show or hide the field (and `Label`) to the end user.
The schema of the `Country` property.
Whether the field is required or not.
The maximum length of the string.
The regex describing the accepted value of the string.
A label that platforms can use when displaying or requesting the field to the end user.
**Possible values:** `Show`, `Hide`
Recommendation on whether to show or hide the field (and `Label`) to the end user.
The schema of the `Region` property.
Whether the field is required or not.
The maximum length of the string.
The regex describing the accepted value of the string.
A label that platforms can use when displaying or requesting the field to the end user.
**Possible values:** `Show`, `Hide`
Recommendation on whether to show or hide the field (and `Label`) to the end user.
The schema of the `PostalCode` property.
Whether the field is required or not.
The maximum length of the string.
The regex describing the accepted value of the string.
A label that platforms can use when displaying or requesting the field to the end user.
**Possible values:** `Show`, `Hide`
Recommendation on whether to show or hide the field (and `Label`) to the end user.
The schema of the `InternationalBankTransfer` property.
The schema of the `AccountNumber` property.
Whether the field is required or not.
The maximum length of the string.
The minimum length of the string.
The regex describing the accepted value of the string.
A label that platforms can use when displaying or requesting the field to the end user.
**Possible values:** `Show`, `Hide`
Recommendation on whether to show or hide the field (and `Label`) to the end user.
The schema of the `BIC` property (returned if required).
Whether the field is required or not.
The regex describing the accepted value of the string.
A label that platforms can use when displaying or requesting the field to the end user.
**Possible values:** `Show`, `Hide`
Recommendation on whether to show or hide the field (and `Label`) to the end user.
The schema of the `LocalBankTransfer` property. One of:
The schema of the `CAD` property.
The schema of the `AccountNumber` property.
Whether the field is required or not.
The maximum length of the string.
The minimum length of the string.
The regex describing the accepted value of the string.
A label that platforms can use when displaying or requesting the field to the end user.
**Possible values:** `Show`, `Hide`
Recommendation on whether to show or hide the field (and `Label`) to the end user.
The schema of the `InstitutionNumber` property.
Whether the field is required or not.
The maximum length of the string.
The minimum length of the string.
The regex describing the accepted value of the string.
A label that platforms can use when displaying or requesting the field to the end user.
**Possible values:** `Show`, `Hide`
Recommendation on whether to show or hide the field (and `Label`) to the end user.
The schema of the `BranchCode` property.
Whether the field is required or not.
The maximum length of the string.
The minimum length of the string.
The regex describing the accepted value of the string.
A label that platforms can use when displaying or requesting the field to the end user.
**Possible values:** `Show`, `Hide`
Recommendation on whether to show or hide the field (and `Label`) to the end user.
The schema of the `BankName` property.
Whether the field is required or not.
The maximum length of the string.
The minimum length of the string.
The schema of the `CHF` property.
The schema of the `IBAN` property.
Whether the field is required or not.
The maximum length of the string.
The regex describing the accepted value of the string.
A label that platforms can use when displaying or requesting the field to the end user.
**Possible values:** `Show`, `Hide`
Recommendation on whether to show or hide the field (and `Label`) to the end user.
The schema of the `CZK` property.
The schema of the `IBAN` property.
Whether the field is required or not.
The maximum length of the string.
The regex describing the accepted value of the string.
A label that platforms can use when displaying or requesting the field to the end user.
**Possible values:** `Show`, `Hide`
Recommendation on whether to show or hide the field (and `Label`) to the end user.
The schema of the `DKK` property.
The schema of the `IBAN` property.
Whether the field is required or not.
The maximum length of the string.
The regex describing the accepted value of the string.
A label that platforms can use when displaying or requesting the field to the end user.
**Possible values:** `Show`, `Hide`
Recommendation on whether to show or hide the field (and `Label`) to the end user.
The schema of the `EUR` property.
The schema of the `IBAN` property.
Whether the field is required or not.
The maximum length of the string.
The regex describing the accepted value of the string.
A label that platforms can use when displaying or requesting the field to the end user.
**Possible values:** `Show`, `Hide`
Recommendation on whether to show or hide the field (and `Label`) to the end user.
The schema of the `AccountNumber` property.
Whether the field is required or not.
The maximum length of the string.
The minimum length of the string.
The regex describing the accepted value of the string.
A label that platforms can use when displaying or requesting the field to the end user.
**Possible values:** `Show`, `Hide`
Recommendation on whether to show or hide the field (and `Label`) to the end user.
The schema of the `SortCode` property.
Whether the field is required or not.
The maximum length of the string.
The minimum length of the string.
The regex describing the accepted value of the string.
A label that platforms can use when displaying or requesting the field to the end user.
**Possible values:** `Show`, `Hide`
Recommendation on whether to show or hide the field (and `Label`) to the end user.
The schema of the `HUF` property.
The schema of the `IBAN` property.
Whether the field is required or not.
The maximum length of the string.
The regex describing the accepted value of the string.
A label that platforms can use when displaying or requesting the field to the end user.
**Possible values:** `Show`, `Hide`
Recommendation on whether to show or hide the field (and `Label`) to the end user.
{/*
The schema of the `MXN` property.
The schema of the `BIC` property.
The schema of the `Clabe` property.
*/}
The schema of the `NOK` property.
The schema of the `IBAN` property.
Whether the field is required or not.
The maximum length of the string.
The regex describing the accepted value of the string.
A label that platforms can use when displaying or requesting the field to the end user.
**Possible values:** `Show`, `Hide`
Recommendation on whether to show or hide the field (and `Label`) to the end user.
The schema of the `PLN` property.
The schema of the `IBAN` property.
Whether the field is required or not.
The maximum length of the string.
The regex describing the accepted value of the string.
A label that platforms can use when displaying or requesting the field to the end user.
**Possible values:** `Show`, `Hide`
Recommendation on whether to show or hide the field (and `Label`) to the end user.
The schema of the `RON` property.
The schema of the `IBAN` property.
Whether the field is required or not.
The maximum length of the string.
The regex describing the accepted value of the string.
A label that platforms can use when displaying or requesting the field to the end user.
**Possible values:** `Show`, `Hide`
Recommendation on whether to show or hide the field (and `Label`) to the end user.
The schema of the `SEK` property.
The schema of the `IBAN` property.
Whether the field is required or not.
The maximum length of the string.
The regex describing the accepted value of the string.
A label that platforms can use when displaying or requesting the field to the end user.
**Possible values:** `Show`, `Hide`
Recommendation on whether to show or hide the field (and `Label`) to the end user.
The schema of the `USD` property.
The schema of the `AccountNumber` property.
Whether the field is required or not.
The maximum length of the string.
The minimum length of the string.
The regex describing the accepted value of the string.
A label that platforms can use when displaying or requesting the field to the end user.
**Possible values:** `Show`, `Hide`
Recommendation on whether to show or hide the field (and `Label`) to the end user.
The schema of the `ABA` property.
Whether the field is required or not.
The maximum length of the string.
The minimum length of the string.
The regex describing the accepted value of the string.
A label that platforms can use when displaying or requesting the field to the end user.
**Possible values:** `Show`, `Hide`
Recommendation on whether to show or hide the field (and `Label`) to the end user.
The schema of the `FFC` property.
Whether the field is required or not.
The maximum length of the string.
The minimum length of the string.
The regex describing the accepted value of the string.
A label that platforms can use when displaying or requesting the field to the end user.
**Possible values:** `Show`, `Hide`
Recommendation on whether to show or hide the field (and `Label`) to the end user.
The errors below occur when the domestic rail (`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](/guides/payouts#how-mangopay-routes-funds) **→**
```json theme={null}
{
"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"
}
}
```
```json theme={null}
{
"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"
}
}
```
See the [country restrictions](/guides/users/country-restrictions) article for details.
```json theme={null}
{
"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"
}
}
```
```json EUR, US, international, individual theme={null}
{
"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"
}
}
}
```
```json CAD, CA, local, business theme={null}
{
"DisplayName": {
"Required": true,
"MaxLength": 50,
"Pattern": "^(?!.*[&,'/]).{1,50}$",
"Label": "Display Name",
"EndUserDisplay": "Show"
},
"Currency": {
"AllowedValues": [
"CAD"
],
"Required": true,
"MaxLength": 3,
"MinLength": 3,
"Pattern": "^[a-zA-Z]{3}$",
"Label": "Currency",
"EndUserDisplay": "Hide"
},
"Country": {
"AllowedValues": [
"CA"
],
"Required": true,
"MaxLength": 2,
"MinLength": 2,
"Pattern": "^[a-zA-Z]{2}$",
"Label": "Destination Country",
"EndUserDisplay": "Hide"
},
"RecipientType": {
"AllowedValues": [
"Business"
],
"Required": true,
"Pattern": "^[a-zA-Z]+$",
"Label": "Recipient Type",
"EndUserDisplay": "Hide"
},
"PayoutMethodType": {
"AllowedValues": [
"LocalBankTransfer"
],
"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"
},
"LocalBankTransfer": {
"CAD": {
"AccountNumber": {
"Required": true,
"MaxLength": 35,
"MinLength": 7,
"Pattern": "^\\d{7,35}$",
"Label": "Account Number",
"EndUserDisplay": "Show"
},
"InstitutionNumber": {
"Required": true,
"MaxLength": 3,
"MinLength": 3,
"Pattern": "^\\d{3}$",
"Label": "Institution Number",
"EndUserDisplay": "Show"
},
"BranchCode": {
"Required": true,
"MaxLength": 5,
"MinLength": 5,
"Pattern": "^\\d{5}$",
"Label": "Branch Code",
"EndUserDisplay": "Show"
},
"BankName": {
"Required": true,
"MaxLength": 50,
"Label": "Bank Name",
"EndUserDisplay": "Show"
}
}
},
"BusinessRecipient": {
"BusinessName": {
"Required": true,
"MaxLength": 255,
"Pattern": "^(?!.*[(),.:/]).{1,255}$",
"Label": "Business 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": true,
"MaxLength": 50,
"Pattern": "^(?!.*[&,.:_/]).{1,50}$",
"Label": "Region",
"EndUserDisplay": "Show"
},
"PostalCode": {
"Required": true,
"MaxLength": 10,
"Pattern": "^(?!.*[()&,.:_'/]).{1,10}$",
"Label": "Postal Code",
"EndUserDisplay": "Show"
}
}
}
}
```
```json REST theme={null}
// GET has no body parameters
```