GET
/
v2.01
/
{ClientId}
/
recipients
/
schema
// 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

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

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