View the schema for a Recipient

Fetch the data requirements for a given currency, payout method type, and recipient type

GET /v2.01/{ClientId}/recipients/schema

REST

// GET has no body parameters

EUR, US, international, individual

{
    "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

PayoutMethodType · string · required

Allowed values: LocalBankTransfer, InternationalBankTransfer

The payout method.

Currency · string · required

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.

Country · string · required

Format: Two-letter country code (ISO 3166-1 alpha-2 format)

The destination country of the payout method.

RecipientType · string · required

Possible values: Individual, Business

The recipient type:

• Individual – An account held by a natural person
• Business – An account held by a legal entity

Responses

200

DisplayName · object

The schema of the DisplayName property.

Show properties

Required · boolean

Whether the field is required or not.

MaxLength · integer

The maximum length of the string.

Pattern · string

The regex describing the accepted value of the string.

Label · string

A label that platforms can use when displaying or requesting the field to the end user.

EndUserDisplay · string

Possible values: Show, Hide

Recommendation on whether to show or hide the field (and Label) to the end user.

Currency · object

The schema of the Currency property.

Show properties

AllowedValues · array (string)

The allowed values of the string.

Required · boolean

Whether the field is required or not.

MaxLength · integer

The maximum length of the string.

MinLength · integer

The minimum length of the string.

Pattern · string

The regex describing the accepted value of the string.

Label · string

A label that platforms can use when displaying or requesting the field to the end user.

EndUserDisplay · string

Possible values: Show, Hide

Recommendation on whether to show or hide the field (and Label) to the end user.

Country · object

The schema of the Country property.

Show properties

AllowedValues · array (string)

The allowed values of the string.

Required · boolean

Whether the field is required or not.

MaxLength · integer

The maximum length of the string.

MinLength · integer

The minimum length of the string.

Pattern · string

The regex describing the accepted value of the string.

Label · string

A label that platforms can use when displaying or requesting the field to the end user.

EndUserDisplay · string

Possible values: Show, Hide

Recommendation on whether to show or hide the field (and Label) to the end user.

RecipientType · object

The schema of the RecipientType property.

Show properties

AllowedValues · array (string)

The allowed values of the string.

Required · boolean

Whether the field is required or not.

Pattern · string

The regex describing the accepted value of the string.

Label · string

A label that platforms can use when displaying or requesting the field to the end user.

EndUserDisplay · string

Possible values: Show, Hide

Recommendation on whether to show or hide the field (and Label) to the end user.

PayoutMethodType · object

The schema of the PayoutMethodType property.

Show properties

AllowedValues · array (string)

The allowed values of the string.

Required · boolean

Whether the field is required or not.

Pattern · string

The regex describing the accepted value of the string.

Label · string

A label that platforms can use when displaying or requesting the field to the end user.

EndUserDisplay · string

Possible values: Show, Hide

Recommendation on whether to show or hide the field (and Label) to the end user.

Individual

IndividualRecipient · object

The schema of the IndividualRecipient property.

Show properties

FirstName · object

The schema of the FirstName property.

Show properties

Required · boolean

Whether the field is required or not.

MaxLength · integer

The maximum length of the string.

Pattern · string

The regex describing the accepted value of the string.

Label · string

A label that platforms can use when displaying or requesting the field to the end user.

EndUserDisplay · string

Possible values: Show, Hide

Recommendation on whether to show or hide the field (and Label) to the end user.

LastName · object

The schema of the LastName property.

Show properties

Required · boolean

Whether the field is required or not.

MaxLength · integer

The maximum length of the string.

Pattern · string

The regex describing the accepted value of the string.

Label · string

A label that platforms can use when displaying or requesting the field to the end user.

EndUserDisplay · string

Possible values: Show, Hide

Recommendation on whether to show or hide the field (and Label) to the end user.

Address · object

The schema of the Address object.

Show properties

AddressLine1 · object

The schema of the AddressLine1 property.

Show child attributes

Required · boolean

Whether the field is required or not.

MaxLength · integer

The maximum length of the string.

Pattern · string

The regex describing the accepted value of the string.

Label · string

A label that platforms can use when displaying or requesting the field to the end user.

EndUserDisplay · string

Possible values: Show, Hide

Recommendation on whether to show or hide the field (and Label) to the end user.

AddressLine2 · object

The schema of the AddressLine2 property.

Show child attributes

Required · boolean

Whether the field is required or not.

MaxLength · integer

The maximum length of the string.

Pattern · string

The regex describing the accepted value of the string.

Label · string

A label that platforms can use when displaying or requesting the field to the end user.

EndUserDisplay · string

Possible values: Show, Hide

Recommendation on whether to show or hide the field (and Label) to the end user.

City · object

The schema of the City property.

Show child attributes

Required · boolean

Whether the field is required or not.

MaxLength · integer

The maximum length of the string.

Pattern · string

The regex describing the accepted value of the string.

Label · string

A label that platforms can use when displaying or requesting the field to the end user.

EndUserDisplay · string

Possible values: Show, Hide

Recommendation on whether to show or hide the field (and Label) to the end user.

Country · object

The schema of the Country property.

Show child attributes

Required · boolean

Whether the field is required or not.

MaxLength · integer

The maximum length of the string.

Pattern · string

The regex describing the accepted value of the string.

Label · string

A label that platforms can use when displaying or requesting the field to the end user.

EndUserDisplay · string

Possible values: Show, Hide

Recommendation on whether to show or hide the field (and Label) to the end user.

Region · object

The schema of the Region property.

Show child attributes

Required · boolean

Whether the field is required or not.

MaxLength · integer

The maximum length of the string.

Pattern · string

The regex describing the accepted value of the string.

Label · string

A label that platforms can use when displaying or requesting the field to the end user.

EndUserDisplay · string

Possible values: Show, Hide

Recommendation on whether to show or hide the field (and Label) to the end user.

PostalCode · object

The schema of the PostalCode property.

Show child attributes

Required · boolean

Whether the field is required or not.

MaxLength · integer

The maximum length of the string.

Pattern · string

The regex describing the accepted value of the string.

Label · string

A label that platforms can use when displaying or requesting the field to the end user.

EndUserDisplay · string

Possible values: Show, Hide

Recommendation on whether to show or hide the field (and Label) to the end user.

Business

BusinessRecipient · object

The schema of the BusinessRecipient property.

Show properties

BusinessName · object

The schema of the BusinessName property.

Show properties

Required · boolean

Whether the field is required or not.

MaxLength · integer

The maximum length of the string.

Pattern · string

The regex describing the accepted value of the string.

Label · string

A label that platforms can use when displaying or requesting the field to the end user.

EndUserDisplay · string

Possible values: Show, Hide

Recommendation on whether to show or hide the field (and Label) to the end user.

Address · object

The schema of the Address object.

Show properties

AddressLine1 · object

The schema of the AddressLine1 property.

Show child attributes

Required · boolean

Whether the field is required or not.

MaxLength · integer

The maximum length of the string.

Pattern · string

The regex describing the accepted value of the string.

Label · string

A label that platforms can use when displaying or requesting the field to the end user.

EndUserDisplay · string

Possible values: Show, Hide

Recommendation on whether to show or hide the field (and Label) to the end user.

AddressLine2 · object

The schema of the AddressLine2 property.

Show child attributes

Required · boolean

Whether the field is required or not.

MaxLength · integer

The maximum length of the string.

Pattern · string

The regex describing the accepted value of the string.

Label · string

A label that platforms can use when displaying or requesting the field to the end user.

EndUserDisplay · string

Possible values: Show, Hide

Recommendation on whether to show or hide the field (and Label) to the end user.

City · object

The schema of the City property.

Show child attributes

Required · boolean

Whether the field is required or not.

MaxLength · integer

The maximum length of the string.

Pattern · string

The regex describing the accepted value of the string.

Label · string

A label that platforms can use when displaying or requesting the field to the end user.

EndUserDisplay · string

Possible values: Show, Hide

Recommendation on whether to show or hide the field (and Label) to the end user.

Country · object

The schema of the Country property.

Show child attributes

Required · boolean

Whether the field is required or not.

MaxLength · integer

The maximum length of the string.

Pattern · string

The regex describing the accepted value of the string.

Label · string

A label that platforms can use when displaying or requesting the field to the end user.

EndUserDisplay · string

Possible values: Show, Hide

Recommendation on whether to show or hide the field (and Label) to the end user.

Region · object

The schema of the Region property.

Show child attributes

Required · boolean

Whether the field is required or not.

MaxLength · integer

The maximum length of the string.

Pattern · string

The regex describing the accepted value of the string.

Label · string

A label that platforms can use when displaying or requesting the field to the end user.

EndUserDisplay · string

Possible values: Show, Hide

Recommendation on whether to show or hide the field (and Label) to the end user.

PostalCode · object

The schema of the PostalCode property.

Show child attributes

Required · boolean

Whether the field is required or not.

MaxLength · integer

The maximum length of the string.

Pattern · string

The regex describing the accepted value of the string.

Label · string

A label that platforms can use when displaying or requesting the field to the end user.

EndUserDisplay · string

Possible values: Show, Hide

Recommendation on whether to show or hide the field (and Label) to the end user.

InternationalBankTransfer

InternationalBankTransfer · type

The schema of the InternationalBankTransfer property.

Hide properties

AccountNumber · object

The schema of the AccountNumber property.

Show properties

Required · boolean

Whether the field is required or not.

MaxLength · integer

The maximum length of the string.

MinLength · integer

The minimum length of the string.

Pattern · string

The regex describing the accepted value of the string.

Label · string

A label that platforms can use when displaying or requesting the field to the end user.

EndUserDisplay · string

Possible values: Show, Hide

Recommendation on whether to show or hide the field (and Label) to the end user.

BIC · object

The schema of the BIC property (returned if required).

Show properties

Required · boolean

Whether the field is required or not.

Pattern · string

The regex describing the accepted value of the string.

Label · string

A label that platforms can use when displaying or requesting the field to the end user.

EndUserDisplay · string

Possible values: Show, Hide

Recommendation on whether to show or hide the field (and Label) to the end user.

LocalBankTransfer

LocalBankTransfer · object

The schema of the LocalBankTransfer property. One of:

CAD

CAD · object

The schema of the CAD property.

Hide properties

AccountNumber · object

The schema of the AccountNumber property.

Show properties

Required · boolean

Whether the field is required or not.

MaxLength · integer

The maximum length of the string.

MinLength · integer

The minimum length of the string.

Pattern · string

The regex describing the accepted value of the string.

Label · string

A label that platforms can use when displaying or requesting the field to the end user.

EndUserDisplay · string

Possible values: Show, Hide

Recommendation on whether to show or hide the field (and Label) to the end user.

InstitutionNumber · object

The schema of the InstitutionNumber property.

Show properties

Required · boolean

Whether the field is required or not.

MaxLength · integer

The maximum length of the string.

MinLength · integer

The minimum length of the string.

Pattern · string

The regex describing the accepted value of the string.

Label · string

A label that platforms can use when displaying or requesting the field to the end user.

EndUserDisplay · string

Possible values: Show, Hide

Recommendation on whether to show or hide the field (and Label) to the end user.

BranchCode · object

The schema of the BranchCode property.

Show properties

Required · boolean

Whether the field is required or not.

MaxLength · integer

The maximum length of the string.

MinLength · integer

The minimum length of the string.

Pattern · string

The regex describing the accepted value of the string.

Label · string

A label that platforms can use when displaying or requesting the field to the end user.

EndUserDisplay · string

Possible values: Show, Hide

Recommendation on whether to show or hide the field (and Label) to the end user.

BankName · object

The schema of the BankName property.

Show properties

Required · boolean

Whether the field is required or not.

MaxLength · integer

The maximum length of the string.

MinLength · integer

The minimum length of the string.

CHF

CHF · object

The schema of the CHF property.

Hide properties

IBAN · object

The schema of the IBAN property.

Show properties

Required · boolean

Whether the field is required or not.

MaxLength · integer

The maximum length of the string.

Pattern · string

The regex describing the accepted value of the string.

Label · string

A label that platforms can use when displaying or requesting the field to the end user.

EndUserDisplay · string

Possible values: Show, Hide

Recommendation on whether to show or hide the field (and Label) to the end user.

CZK

CZK · object

The schema of the CZK property.

Hide properties

IBAN · object

The schema of the IBAN property.

Show properties

Required · boolean

Whether the field is required or not.

MaxLength · integer

The maximum length of the string.

Pattern · string

The regex describing the accepted value of the string.

Label · string

A label that platforms can use when displaying or requesting the field to the end user.

EndUserDisplay · string

Possible values: Show, Hide

Recommendation on whether to show or hide the field (and Label) to the end user.

DKK

DKK · object

The schema of the DKK property.

Hide properties

IBAN · object

The schema of the IBAN property.

Show properties

Required · boolean

Whether the field is required or not.

MaxLength · integer

The maximum length of the string.

Pattern · string

The regex describing the accepted value of the string.

Label · string

A label that platforms can use when displaying or requesting the field to the end user.

EndUserDisplay · string

Possible values: Show, Hide

Recommendation on whether to show or hide the field (and Label) to the end user.

EUR

EUR · object

The schema of the EUR property.

Hide properties

IBAN · object

The schema of the IBAN property.

Show properties

Required · boolean

Whether the field is required or not.

MaxLength · integer

The maximum length of the string.

Pattern · string

The regex describing the accepted value of the string.

Label · string

A label that platforms can use when displaying or requesting the field to the end user.

EndUserDisplay · string

Possible values: Show, Hide

Recommendation on whether to show or hide the field (and Label) to the end user.

GBP

GBP · object

Hide properties

AccountNumber · object

The schema of the AccountNumber property.

Show properties

Required · boolean

Whether the field is required or not.

MaxLength · integer

The maximum length of the string.

MinLength · integer

The minimum length of the string.

Pattern · string

The regex describing the accepted value of the string.

Label · string

A label that platforms can use when displaying or requesting the field to the end user.

EndUserDisplay · string

Possible values: Show, Hide

Recommendation on whether to show or hide the field (and Label) to the end user.

SortCode · object

The schema of the SortCode property.

Show properties

Required · boolean

Whether the field is required or not.

MaxLength · integer

The maximum length of the string.

MinLength · integer

The minimum length of the string.

Pattern · string

The regex describing the accepted value of the string.

Label · string

A label that platforms can use when displaying or requesting the field to the end user.

EndUserDisplay · string

Possible values: Show, Hide

Recommendation on whether to show or hide the field (and Label) to the end user.

HUF

HUF · object

The schema of the HUF property.

Hide properties

IBAN · object

The schema of the IBAN property.

Show properties

Required · boolean

Whether the field is required or not.

MaxLength · integer

The maximum length of the string.

Pattern · string

The regex describing the accepted value of the string.

Label · string

A label that platforms can use when displaying or requesting the field to the end user.

EndUserDisplay · string

Possible values: Show, Hide

Recommendation on whether to show or hide the field (and Label) to the end user.

NOK

NOK · object

The schema of the NOK property.

Hide properties

IBAN · object

The schema of the IBAN property.

Show properties

Required · boolean

Whether the field is required or not.

MaxLength · integer

The maximum length of the string.

Pattern · string

The regex describing the accepted value of the string.

Label · string

A label that platforms can use when displaying or requesting the field to the end user.

EndUserDisplay · string

Possible values: Show, Hide

Recommendation on whether to show or hide the field (and Label) to the end user.

PLN

PLN · object

The schema of the PLN property.

Hide properties

IBAN · object

The schema of the IBAN property.

Show properties

Required · boolean

Whether the field is required or not.

MaxLength · integer

The maximum length of the string.

Pattern · string

The regex describing the accepted value of the string.

Label · string

A label that platforms can use when displaying or requesting the field to the end user.

EndUserDisplay · string

Possible values: Show, Hide

Recommendation on whether to show or hide the field (and Label) to the end user.

RON

RON · object

The schema of the RON property.

Hide properties

IBAN · object

The schema of the IBAN property.

Show properties

Required · boolean

Whether the field is required or not.

MaxLength · integer

The maximum length of the string.

Pattern · string

The regex describing the accepted value of the string.

Label · string

A label that platforms can use when displaying or requesting the field to the end user.

EndUserDisplay · string

Possible values: Show, Hide

Recommendation on whether to show or hide the field (and Label) to the end user.

SEK

SEK · object

The schema of the SEK property.

Hide properties

IBAN · object

The schema of the IBAN property.

Show properties

Required · boolean

Whether the field is required or not.

MaxLength · integer

The maximum length of the string.

Pattern · string

The regex describing the accepted value of the string.

Label · string

A label that platforms can use when displaying or requesting the field to the end user.

EndUserDisplay · string

Possible values: Show, Hide

Recommendation on whether to show or hide the field (and Label) to the end user.

USD

USD · object

The schema of the USD property.

Hide properties

AccountNumber · object

The schema of the AccountNumber property.

Show properties

Required · boolean

Whether the field is required or not.

MaxLength · integer

The maximum length of the string.

MinLength · integer

The minimum length of the string.

Pattern · string

The regex describing the accepted value of the string.

Label · string

A label that platforms can use when displaying or requesting the field to the end user.

EndUserDisplay · string

Possible values: Show, Hide

Recommendation on whether to show or hide the field (and Label) to the end user.

ABA · object

The schema of the ABA property.

Show properties

Required · boolean

Whether the field is required or not.

MaxLength · integer

The maximum length of the string.

MinLength · integer

The minimum length of the string.

Pattern · string

The regex describing the accepted value of the string.

Label · string

A label that platforms can use when displaying or requesting the field to the end user.

EndUserDisplay · string

Possible values: Show, Hide

Recommendation on whether to show or hide the field (and Label) to the end user.

FFC · object

The schema of the FFC property.

Show properties

Required · boolean

Whether the field is required or not.

MaxLength · integer

The maximum length of the string.

MinLength · integer

The minimum length of the string.

Pattern · string

The regex describing the accepted value of the string.

Label · string

A label that platforms can use when displaying or requesting the field to the end user.

EndUserDisplay · string

Possible values: Show, Hide

Recommendation on whether to show or hide the field (and Label) to the end user.

400 - Domestic rail not available for Currency-Country combination

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 →

{
    "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

See the country restrictions article for details.

{
    "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"
    }
}

EUR, US, international, individual

{
    "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"
        }
    }
}

REST

// GET has no body parameters