List Recipients for a User

GET

/v2.01/:ClientId/users/:UserId/recipients

GET

/v2.01/:ClientId/users/:UserId/recipients

$ curl https://api.sandbox.mangopay.com/v2.01/{ClientId}/users/{UserId}/recipients \
>      -H "Authorization: Bearer <token>"

200Retrieved

1 [
2   {
3     "Id": "bankacc_m_01JCN1X2EHWG0JNJNPNQ21CW5G",
4     "CreationDate": 1723035193,
5     "DisplayName": null,
6     "PayoutMethodType": "LocalBankTransfer",
7     "RecipientType": "Individual",
8     "Currency": "EUR",
9     "Country": "FR",
10     "UserId": "user_m_01JV6ZGXBE0VZSF4TEN9JK343Z",
11     "Status": "ACTIVE",
12     "RecipientScope": "PAYOUT"
13   },
14   {
15     "Id": "rec_01JV70P7J10PRZP0JQQ9CQZFN8",
16     "CreationDate": 1746622392,
17     "DisplayName": "Alex Smith EUR account",
18     "PayoutMethodType": "InternationalBankTransfer",
19     "RecipientType": "Business",
20     "Currency": "EUR",
21     "Country": "FR",
22     "UserId": "user_m_01JV6ZGXBE0VZSF4TEN9JK343Z",
23     "Status": "ACTIVE",
24     "RecipientScope": "PAYOUT"
25   },
26   {
27     "Id": "rec_01JV6ZZG6W0RKG6ZGA3MEY60BZ",
28     "CreationDate": 1746699783,
29     "DisplayName": "Alex Smith USD account",
30     "PayoutMethodType": "LocalBankTransfer",
31     "RecipientType": "Individual",
32     "Currency": "USD",
33     "Country": "US",
34     "UserId": "user_m_01JV6ZGXBE0VZSF4TEN9JK343Z",
35     "Status": "CANCELED",
36     "RecipientScope": "PAYOUT"
37   }
38 ]

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.

List recipients created for a UserId

<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

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

If your platform is using a proxy to take SCA-triggering action on behalf of users, you also need to integrate mTLS authentication and use the api-mtls base URL.

Bearer authentication of the form `Bearer <token>`, where token is your auth token. If your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.

Path parameters

ClientIdstringRequired

Platform's API account identifier, associated with the API key.

UserIdstringRequired

The unique identifier of the user.

Query parameters

pageintegerOptional

Start value: 1

Default value: 1

Indicates the index of the page for the pagination.

per_pageintegerOptional

Min. value: 1; max. value: 100

Default value: 10

Indicates the number of items returned for each page of the pagination.

SortstringOptional

Possible values: CreationDate:ASC, CreationDate:DESC

Default value: CreationDate:DESC

Indicates the direction in which to sort the list.

RecipientScopestringOptional

Possible values: ALL, PAYOUT, PAYIN

Default value: PAYOUT

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.

Read more about recipient scopes in the guide.

**Possible values:** `ALL`, `PAYOUT`, `PAYIN` **Default value:** `PAYOUT` 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. Read more about [recipient scopes in the guide](/guides/sca/recipients#recipient-scopes).

Response

Success