List Recipients for a User

List recipients created for a UserId

Note – Endpoint returns filtered list by default

By default, this endpoint returns only recipients with the RecipientScope value of PAYOUT. To retrieve PAYIN recipients, you need to specify the value in the RecipientScope query parameter.

Path parameters

UserId · string · required

The unique identifier of the user.

Query parameters

RecipientScope · string

Possible values: PAYIN

By default, this endpoint returns only recipients with the RecipientScope value of PAYOUT unless PAYIN is specified as the query parameter value. It is also not possible to combine the query values.

Read more about recipient scopes in the guide.

Responses

200

Recipients · array (objects)

The list of recipients created for the user.

Show child attributes

Id · string

Max length: 128 characters (see data formats for details)

The unique identifier of the object.

CreationDate · Unix timestamp

The date and time at which the object was created.

DisplayName · string

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.

PayoutMethodType · string

Possible values: 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.

RecipientType · string

Possible values: 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.

Currency · string

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.

Country · string

Format: Two-letter country code (ISO 3166-1 alpha-2 format)

The destination country of the payout method.

UserId · string

The unique identifier of the user.

Status · string

Possible values: 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.

RecipientScope · string

Possible values: 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.

Both PAYIN and PAYOUT scopes can be created for either InternationalBankTransfer or LocalBankTransfer, and for either IndividualRecipient or BusinessRecipient, and for any Currency.

200 Including legacy migrated bank account

[
    {
        "Id": "bankacc_m_01JCN1X2EHWG0JNJNPNQ21CW5G",
        "CreationDate": 1723035193,
        "DisplayName": null,
        "PayoutMethodType": "LocalBankTransfer",
        "RecipientType": "Individual",
        "Currency": "EUR",
        "Country": "FR",
        "UserId": "user_m_01JV6ZGXBE0VZSF4TEN9JK343Z",
        "Status": "ACTIVE",
        "RecipientScope": "PAYOUT"
    },
    {
        "Id": "rec_01JV70P7J10PRZP0JQQ9CQZFN8",
        "CreationDate": 1746622392,
        "DisplayName": "Alex Smith EUR account",
        "PayoutMethodType": "InternationalBankTransfer",
        "RecipientType": "Business",
        "Currency": "EUR",
        "Country": "FR",
        "UserId": "user_m_01JV6ZGXBE0VZSF4TEN9JK343Z",
        "Status": "ACTIVE",
        "RecipientScope": "PAYOUT"
    },
    {
        "Id": "rec_01JV6ZZG6W0RKG6ZGA3MEY60BZ",
        "CreationDate": 1746699783,
        "DisplayName": "Alex Smith USD account",
        "PayoutMethodType": "LocalBankTransfer",
        "RecipientType": "Individual",
        "Currency": "USD",
        "Country": "US",
        "UserId": "user_m_01JV6ZGXBE0VZSF4TEN9JK343Z",
        "Status": "CANCELED",
        "RecipientScope": "PAYOUT"
    }
]

REST

// GET has no body parameters