Overview
User management
- Users
- User regulatory status
- User e-money
User verification
- IDV sessions
- 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
- Bizum
- 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 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
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)
The destination country of the payout method.
Possible values: Individual, Business
The recipient type:
Individual– An account held by a natural personBusiness– An account held by a legal entity
Responses
200
200
The schema of the DisplayName property.
Show properties
Show properties
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.
Show properties
Show properties
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.
Show properties
Show properties
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.
Show properties
Show properties
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.
Show properties
Show properties
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.
Show properties
Show properties
The schema of the FirstName property.
Show properties
Show properties
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.
Show properties
Show properties
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.
Show properties
Show properties
The schema of the AddressLine1 property.
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
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 IndividualRecipient property.
Show properties
Show properties
The schema of the FirstName property.
Show properties
Show properties
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.
Show properties
Show properties
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.
Show properties
Show properties
The schema of the AddressLine1 property.
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
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.
Show properties
Show properties
The schema of the BusinessName property.
Show properties
Show properties
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.
Show properties
Show properties
The schema of the AddressLine1 property.
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
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.
Hide properties
Hide properties
The schema of the AccountNumber property.
Show properties
Show properties
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).
Show properties
Show properties
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 InternationalBankTransfer property.
Hide properties
Hide properties
The schema of the AccountNumber property.
Show properties
Show properties
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).
Show properties
Show properties
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.
Hide properties
Hide properties
The schema of the AccountNumber property.
Show properties
Show properties
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.
Show properties
Show properties
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.
Show properties
Show properties
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 CAD property.
Hide properties
Hide properties
The schema of the AccountNumber property.
Show properties
Show properties
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.
Show properties
Show properties
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.
Show properties
Show properties
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 CHF property.
Hide properties
Hide properties
The schema of the IBAN property.
Show properties
Show properties
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.
Hide properties
Hide properties
The schema of the IBAN property.
Show properties
Show properties
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.
Hide properties
Hide properties
The schema of the IBAN property.
Show properties
Show properties
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.
Hide properties
Hide properties
The schema of the IBAN property.
Show properties
Show properties
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.
Hide properties
Hide properties
The schema of the AccountNumber property.
Show properties
Show properties
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.
Show properties
Show properties
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.
Hide properties
Hide properties
The schema of the IBAN property.
Show properties
Show properties
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 NOK property.
Hide properties
Hide properties
The schema of the IBAN property.
Show properties
Show properties
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.
Hide properties
Hide properties
The schema of the IBAN property.
Show properties
Show properties
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.
Hide properties
Hide properties
The schema of the IBAN property.
Show properties
Show properties
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.
Hide properties
Hide properties
The schema of the IBAN property.
Show properties
Show properties
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.
Hide properties
Hide properties
The schema of the AccountNumber property.
Show properties
Show properties
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.
Show properties
Show properties
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.
Show properties
Show properties
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.
400 - PayoutMethod doesn't match Currency-Country combination
400 - PayoutMethod doesn't match Currency-Country combination
{
"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 - Currency-Country combination doesn't match PayoutMethod
400 - Currency-Country combination doesn't match PayoutMethod
{
"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"
}
}
{
"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?
// 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"
}
}
}