List Recipients for a User

// GET has no body parameters

[
    {
        "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"
    },
    {
        "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": "bankacc_m_01JCN1X2EHWG0JNJNPNQ21CW5G",
        "CreationDate": 1723035193,
        "DisplayName": null,
        "PayoutMethodType": "LocalBankTransfer",
        "RecipientType": "Individual",
        "Currency": "EUR",
        "Country": "FR",
        "UserId": "user_m_01JV6ZGXBE0VZSF4TEN9JK343Z",
        "Status": "ACTIVE",
        "RecipientScope": "PAYOUT"
    }
]

GET

v2.01

{ClientId}

users

{UserId}

recipients

// GET has no body parameters

[
    {
        "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"
    },
    {
        "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": "bankacc_m_01JCN1X2EHWG0JNJNPNQ21CW5G",
        "CreationDate": 1723035193,
        "DisplayName": null,
        "PayoutMethodType": "LocalBankTransfer",
        "RecipientType": "Individual",
        "Currency": "EUR",
        "Country": "FR",
        "UserId": "user_m_01JV6ZGXBE0VZSF4TEN9JK343Z",
        "Status": "ACTIVE",
        "RecipientScope": "PAYOUT"
    }
]

Note – Endpoint returns filtered list by defaultBy default, this endpoint returns only recipients with the RecipientScope value of PAYOUT. Specify ALL to retrieve both PAYIN and PAYOUT recipients, or PAYIN to retrieve only pay-in recipients.By default, results are sorted by CreationDate in descending order.

Path parameters

UserId

string

required

The unique identifier of the user.

Query parameters

page

integer

Start value: 1Default value: 1Indicates the index of the page for the pagination.

per_page

integer

Min. value: 1; max. value: 100Default value: 10Indicates the number of items returned for each page of the pagination.

Sort

string

Possible values: CreationDate:ASC, CreationDate:DESCDefault value: CreationDate:DESCIndicates the direction in which to sort the list.

RecipientScope

string

Possible values: ALL, PAYOUT, PAYINDefault value: PAYOUTBy default, this endpoint returns only recipients with the RecipientScope value of PAYOUT.Specify ALL to retrieve both PAYIN and PAYOUT recipients, or PAYIN to retrieve only pay-in recipients.Read more about recipient scopes →

Responses

200

Recipients

array (objects)

The list of recipients created for the user.

Show child attributes

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, LocalBankTransferThe payout method of the recipient:

LocalBankTransfer – The account can only receive the corresponding local Currency for the Country via the domestic payment rail (e.g. EUR via a SEPA local scheme to a SEPA country, GBP via FPS to a GB account, USD via ACH to a US account, etc). Payouts in non-local currencies return an error.
InternationalBankTransfer – The account can receive both non-local currencies via SWIFT and also local currency via domestic rails.

RecipientType

string

Possible values: Individual, BusinessThe 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, ZARThe 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, DEACTIVATEDThe 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, PAYOUTDefault value: PAYOUTThe 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.

[
    {
        "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"
    },
    {
        "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": "bankacc_m_01JCN1X2EHWG0JNJNPNQ21CW5G",
        "CreationDate": 1723035193,
        "DisplayName": null,
        "PayoutMethodType": "LocalBankTransfer",
        "RecipientType": "Individual",
        "Currency": "EUR",
        "Country": "FR",
        "UserId": "user_m_01JV6ZGXBE0VZSF4TEN9JK343Z",
        "Status": "ACTIVE",
        "RecipientScope": "PAYOUT"
    }
]

// GET has no body parameters

View a Recipient The Bank Account object

⌘I

Documentation Index

​Path parameters

​Query parameters

​Responses

Path parameters

Query parameters

Responses