View a Recipient
Fetch a recipient based on its ID
Path parameters
The unique identifier of the Recipient.
Responses
200
200
Max length: 128 characters (see data formats for details)
The unique identifier of the object.
Possible values: PENDING
, CANCELED
, ACTIVE
, DEACTIVATED
The status of the recipient:
PENDING
– ForPAYOUT
scope recipients, the user must complete SCA before the recipient can becomeACTIVE
. ForPAYIN
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 anotherPendingUserAction.RedirectUrl
. TheCANCELED
status does not apply ifRecipientScope
isPAYIN
.ACTIVE
– Recipient creation was successful (including SCA ifRecipientScope
isPAYOUT
) and the recipient is ready to be used for payouts .DEACTIVATED
– The recipient has been permanently deactivated and can no longer be used.
The date and time at which the object was created.
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.
The unique identifier of the user.
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.
Both PAYIN
and PAYOUT
scopes can be created for either InternationalBankTransfer
or LocalBankTransfer
, and for either IndividualRecipient
or BusinessRecipient
, and for any Currency
.
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
.
The account details if PayoutMethodType
is InternationalBankTransfer
.
The account details if PayoutMethodType
is InternationalBankTransfer
.