// 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"
}
}
}
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"
}
}
}
LocalBankTransfer
, InternationalBankTransfer
The payout method.AED
, AUD
, CAD
, CHF
, CNH
, CZK
, DKK
, EUR
, GBP
, HKD
, HUF
, ILS
, JPY
, MXN
, NOK
, NZD
, PLN
, RON
, SAR
, SEK
, SGD
, TRY
, USD
, ZAR
The currency of the recipient.Individual
, Business
The recipient type:Individual
– An account held by a natural personBusiness
– An account held by a legal entity200
DisplayName
property.Show properties
Show
, Hide
Recommendation on whether to show or hide the field (and Label
) to the end user.Currency
property.Show properties
Show
, Hide
Recommendation on whether to show or hide the field (and Label
) to the end user.Country
property.Show properties
Show
, Hide
Recommendation on whether to show or hide the field (and Label
) to the end user.RecipientType
property.Show properties
Show
, Hide
Recommendation on whether to show or hide the field (and Label
) to the end user.PayoutMethodType
property.Show properties
Show
, Hide
Recommendation on whether to show or hide the field (and Label
) to the end user.IndividualRecipient
property.Show properties
FirstName
property.Show properties
Show
, Hide
Recommendation on whether to show or hide the field (and Label
) to the end user.LastName
property.Show properties
Show
, Hide
Recommendation on whether to show or hide the field (and Label
) to the end user.Address
object.Show properties
AddressLine1
property.Show child attributes
Show
, Hide
Recommendation on whether to show or hide the field (and Label
) to the end user.AddressLine2
property.Show child attributes
Show
, Hide
Recommendation on whether to show or hide the field (and Label
) to the end user.City
property.Show child attributes
Show
, Hide
Recommendation on whether to show or hide the field (and Label
) to the end user.Country
property.Show child attributes
Show
, Hide
Recommendation on whether to show or hide the field (and Label
) to the end user.Region
property.Show child attributes
Show
, Hide
Recommendation on whether to show or hide the field (and Label
) to the end user.PostalCode
property.Show child attributes
Show
, Hide
Recommendation on whether to show or hide the field (and Label
) to the end user.InternationalBankTransfer
property.Hide properties
AccountNumber
property.Show properties
Show
, Hide
Recommendation on whether to show or hide the field (and Label
) to the end user.BIC
property (returned if required).Show properties
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
{
"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
{
"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?