---
title: "List Recipients for a User"
method: GET
path: "/v2.01/{ClientId}/users/{UserId}/recipients"
tags: ["Recipients"]
---

# List Recipients for a User

`GET /v2.01/{ClientId}/users/{UserId}/recipients`

<Note icon="fa-regular fa-circle-info">
**Note – Endpoint returns filtered list by default**

By 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.
</Note>

List recipients created for a UserId

## Path parameters

- `ClientId` string, required
- `UserId` string, required

## Query parameters

- `page` integer
- `per_page` integer
- `Sort` string
- `RecipientScope` string

## Headers

- `Authorization` string, required

## Response `200`

Success

- RecipientListItem[]
  - `Id` string — Max length: 128 characters (see [data formats](/api-reference/overview/data-formats) for details) The unique identifier of the object.
  - `CreationDate` integer — Unix timestamp (UTC) of the date and time the object was created.
  - `DisplayName` string, nullable — 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 — **Returned values:** `InternationalBankTransfer`, `LocalBankTransfer` The payout method of the recipient: - `LocalBankTransfer` – The account can **only** receive the corresponding local `Currency` for the `Country` via the [domestic payment rail](/guides/payouts#payout-rails) (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 — **Returned 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](/api-reference/overview/data-formats)) The destination country of the payout method.
  - `UserId` string — The unique identifier of the user.
  - `Status` string — **Returned 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 — **Returned values:** `PAYIN`, `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. - `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`.

---

[API](https://skmtc.net/mangopay/apis/api-reference.md) · [All operations](https://skmtc.net/mangopay/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mangopay/api-reference/versions/795281070285/schema)