Validate data for a Recipient
Check that the user’s Recipient data is valid before creation
Path parameters
The unique identifier of the user.
Body parameters
Length: 1–50; cannot contain: &,'/
(pattern:^(?!.*[&,'/]).{1,50}$
)
A user-friendly name to identify the account. This value cannot be changed once the recipient is created.
Possible values: InternationalBankTransfer
, LocalBankTransfer
The payout method of the recipient:
InternationalBankTransfer
– A bank wire transfer sent via SWIFT, requiring theInternationalBankTransfer
property.LocalBankTransfer
– A bank wire transfer sent via local routes, requiring theLocalBankTransfer
property.
Possible values: Individual
, Business
The recipient type:
Individual
– An account held by a natural person, requiring theIndividualRecipient
property.Business
– An account held by a legal entity, requiring theBusinessRecipient
property.
Possible values: 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: PAYIN
, PAYOUT
Default value: PAYOUT
The scope of the recipient:
PAYOUT
– Usable for payouts and in pay-in use cases. APAYOUT
recipient can only be created by a user with theUserCategory
OWNER
and requires SCA. You need to use the returnedPendingUserAction.RedirectUrl
value, adding your encodedreturnUrl
as a query parameter, to redirect the user to the hosted SCA session so they can complete the necessary steps.PAYIN
- Not usable for payouts but only usable for pay-in use cases, such as direct debit and refunds using payouts. APAYIN
recipient can be created by a user with theUserCategory
PAYER
orOWNER
, and does not require SCA.
Max. length: 255 (pattern: ^.{0,255}$
)
Custom data that you can add to this object. This value cannot be changed once the recipient is created.
The account holder if the RecipientType
is Individual
.
Only one of IndividualRecipient
or BusinessRecipient
is required.
The account holder if the RecipientType
is Individual
.
Only one of IndividualRecipient
or BusinessRecipient
is required.
The account holder if the RecipientType
is Business
.
Only one of IndividualRecipient
or BusinessRecipient
is required.
The account details if PayoutMethodType
is InternationalBankTransfer
.
Only one of InternationalBankTransfer
or LocalBankTransfer
is required.
The InternationalBankTransfer
depends on the Currency
and Country
.
The account details if PayoutMethodType
is InternationalBankTransfer
.
Only one of InternationalBankTransfer
or LocalBankTransfer
is required.
The InternationalBankTransfer
depends on the Currency
and Country
.
The account details if PayoutMethodType
is LocalBankTransfer
, depending on the Currency
. One of:
Responses
200
200
No response body – 200 HTTP code indicates the request is valid against the schema
400
400
Example 400 error:
The following error values may be returned:
REQUIRED
– Value is required but not present in the request.LENGTH_MORE_THAN_MAX
– String length is greater than required length.LENGTH_LESS_THAN_MIN
– String length is less than required length.INVALID_FORMAT
– Value doe not match expected pattern.NOT_IN_ALLOWED_VALUES
– Value is not a validPayoutMethodType
,RecipientType
, orCurrency
.UNSUPPORTED_CURRENCY
– Currency is a valid ISO 4217 format but not yet supported for Recipients.UNSUPPORTED_PAYOUT_METHOD_FOR_CURRENCY
– Payout method is not supported for theCurrency
andCountry
combination.CLIENT_NOT_FOUND
–ClientId
making the request does not exist.USER_NOT_FOUND
–UserId
for which the request is made does not exist.INVALID_SORT_CODE
– Sort code for this account is not valid.INVALID_ACCOUNT_NUMBER
– Account number is not valid.INVALID_IBAN
– IBAN is not valid.INVALID_BIC
– BIC is not valid.UNSUPPORTED_IBAN
– IBAN is valid but not supported:- If
LocalBankTransfer
, the IBAN country is not part of SEPA and the local currency is not EUR. - If
InternationalBankTransfer
, the IBAN country is not GB or is not part of SEPA and local currency is not EUR.
- If
INVALID_ACCOUNT_NUMBER_AND_SORT_CODE_COMBINATION
– GB sort code and account number combination is not valid.