Register a bank account for local or international payouts
PendingUserAction.RedirectUrl
, add an encoded returnUrl
query parameter, and redirect the user. Read more about how to redirect them in the SCA session guide.Status
as PENDING
regardless of whether SCA is required (because RecipientScope
is OWNER
) or not. In all cases, your integration should rely on the RECIPIENT_ACTIVE
webhook to know when the recipient is ACTIVE
.
&,'/
(pattern:^(?!.*[&,'/]).{1,50}$
)A user-friendly name to identify the account. This value cannot be changed once the recipient is created.InternationalBankTransfer
, LocalBankTransfer
The payout method of the recipient:InternationalBankTransfer
– A bank wire transfer sent via SWIFT, requiring the InternationalBankTransfer
property.LocalBankTransfer
– A bank wire transfer sent via local routes, requiring the LocalBankTransfer
property.Individual
, Business
The recipient type:Individual
– An account held by a natural person, requiring the IndividualRecipient
property.Business
– An account held by a legal entity, requiring the BusinessRecipient
property.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.PAYIN
, PAYOUT
Default value: PAYOUT
The scope of the recipient:PAYOUT
– Usable for payouts and in pay-in use cases. A PAYOUT
recipient can only be created by a user with the UserCategory
OWNER
and requires SCA. You need to use the returned PendingUserAction.RedirectUrl
value, adding your encoded returnUrl
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. A PAYIN
recipient can be created by a user with the UserCategory
PAYER
or OWNER
, and does not require SCA.^.{0,255}$
)Custom data that you can add to this object. This value cannot be changed once the recipient is created.RecipientType
is Individual
.Only one of IndividualRecipient
or BusinessRecipient
is required.PayoutMethodType
is InternationalBankTransfer
.Only one of InternationalBankTransfer
or LocalBankTransfer
is required.The InternationalBankTransfer
depends on the Currency
and Country
.201
PENDING
, CANCELED
, ACTIVE
, DEACTIVATED
The status of the recipient:PENDING
– For PAYOUT
scope recipients, the user must complete SCA before the recipient can become ACTIVE
. For PAYIN
scope recipients, the recipient creation is in progress.CANCELED
– SCA was not successfully completed and the recipient creation request was canceled. To retry, create another recipient to retrieve another PendingUserAction.RedirectUrl
. The CANCELED
status does not apply if RecipientScope
is PAYIN
.ACTIVE
– Recipient creation was successful (including SCA if RecipientScope
is PAYOUT
) and the recipient is ready to be used for payouts .DEACTIVATED
– The recipient has been permanently deactivated and can no longer be used.&,'/
(pattern:^(?!.*[&,'/]).{1,50}$
)A user-friendly name to identify the account. This value cannot be changed once the recipient is created.InternationalBankTransfer
, LocalBankTransfer
The payout method of the recipient.InternationalBankTransfer
– A bank wire transfer sent via SWIFT, requiring the InternationalBankTransfer
property.LocalBankTransfer
– A bank wire transfer sent via local routes, requiring the LocalBankTransfer
property.Individual
, Business
The recipient type:Individual
– An account held by a natural person, requiring the IndividualRecipient
property.Business
– An account held by a legal entity, requiring the BusinessRecipient
property.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.PAYIN
, PAYOUT
Default value: PAYOUT
The scope of the recipient:PAYOUT
– Usable for payouts and in pay-in use cases. A PAYOUT
recipient can only be created by a user with the UserCategory
OWNER
and requires SCA. You need to use the returned PendingUserAction.RedirectUrl
value, adding your encoded returnUrl
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. A PAYIN
recipient can be created by a user with the UserCategory
PAYER
or OWNER
, and does not require SCA.PAYIN
and PAYOUT
scopes can be created for either InternationalBankTransfer
or LocalBankTransfer
, and for either IndividualRecipient
or BusinessRecipient
, and for any Currency
.^.{0,255}$
)Custom data that you can add to this object. This value cannot be changed once the recipient is created.PAYIN
, PAYOUT
Default value: PAYOUT
The scope of the recipient:PAYOUT
– Usable for payouts and in pay-in use cases. A PAYOUT
recipient can only be created by a user with the UserCategory
OWNER
and requires SCA. You need to use the returned PendingUserAction.RedirectUrl
value, adding your encoded returnUrl
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. A PAYIN
recipient can be created by a user with the UserCategory
PAYER
or OWNER
, and does not require SCA.PAYIN
and PAYOUT
scopes can be created for either InternationalBankTransfer
or LocalBankTransfer
, and for either IndividualRecipient
or BusinessRecipient
, and for any Currency
.^.{0,255}$
)Custom data that you can add to this object. This value cannot be changed once the recipient is created.RecipientType
is Individual
.PayoutMethodType
is InternationalBankTransfer
.null
).400
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 valid PayoutMethodType
, RecipientType
, or Currency
.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 the Currency
and Country
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:
LocalBankTransfer
, the IBAN country is not part of SEPA and the local currency is not EUR.InternationalBankTransfer
, the IBAN country is not GB or is not part of SEPA and local currency is not EUR.INVALID_ACCOUNT_NUMBER_AND_SORT_CODE_COMBINATION
– GB sort code and account number combination is not valid.