View a Wallet

GET

/v2.01/:ClientId/wallets/:WalletId

Retrieve a wallet by its Id.

Caution - ScaContext default value changing

On this endpoint, the default value for ScaContext is changing to USER_PRESENT on Dec 15, 2025 (Dec 1 in Sandbox).

From this date, if the PendingUserAction.RedirectUrl value is returned, then you need to redirect the user to perform SCA.

With approval from Mangopay, your platform may be able to use the USER_NOT_PRESENT value provided you also have a legal proxy in place with the user and the user’s consent to access wallet balances and transactions on their behalf (read more about proxy management).

Note – SCA triggered by this endpoint

This endpoint requires the user to perform SCA to authenticate the access to their wallet, unless SCA for wallet access was successfully completed in the last 180 days (or unless your platform is using a proxy and user consent).

When SCA is required, this endpoint returns a 401 - Unauthorized response.

To let the user complete the SCA session on the Mangopay-hosted webpage, your platform needs to retrieve the RedirectUrl from the WWW-Authenticate response header, add an encoded returnUrl query parameter, and redirect the user. Read more about how to redirect them in the SCA session guide.

In Sandbox, you can bypass SCA by including the word accept in the Email value of the Natural User or the LegalRepresentative.Email value of the Legal User – for example accept@example.com or john.doe+accept@example.com.

Retrieve a wallet by its `Id`. <Warning icon="fa-regular fa-triangle-exclamation"> **Caution - ScaContext default value changing** On this endpoint, the default value for `ScaContext` is changing to `USER_PRESENT` on **Dec 15, 2025** (Dec 1 in Sandbox). From this date, if the `PendingUserAction.RedirectUrl` value is returned, then you need to redirect the user to perform SCA. With approval from Mangopay, your platform may be able to use the `USER_NOT_PRESENT` value provided you also have a legal proxy in place with the user and the user's consent to access wallet balances and transactions on their behalf (read more about [proxy management](/guides/sca/proxy-management)). </Warning> <Note icon="fa-regular fa-circle-info"> **Note – SCA triggered by this endpoint** This endpoint requires the user to [perform SCA to authenticate](/guides/sca/wallets) the access to their wallet, unless SCA for wallet access was successfully completed in the **last 180 days** (or unless your platform is using a [proxy and user consent](/guides/sca/proxy-management)). When SCA is required, this endpoint returns a **401 - Unauthorized** response. To let the user complete the SCA session on the Mangopay-hosted webpage, your platform needs to retrieve the `RedirectUrl` from the `WWW-Authenticate` response header, add an encoded `returnUrl` query parameter, and redirect the user. Read more about how to redirect them in the [SCA session](/guides/sca/session) guide. In Sandbox, you can bypass SCA by including the word `accept` in the `Email` value of the [Natural User](/api-reference/users/natural-user-object-sca) or the `LegalRepresentative.Email` value of the [Legal User](/api-reference/users/legal-user-object-sca) – for example `accept@example.com` or `john.doe+accept@example.com`. </Note>

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.

WalletIdstringRequired

The unique identifier of the wallet.

Query parameters

ScaContextstringOptional

Possible values: USER_PRESENT, USER_NOT_PRESENT

The SCA context of the request, which is required if the user’s UserCategory is OWNER:

USER_PRESENT – The user is taking the SCA-triggering action of accessing their wallet. The platform must redirect the user using the PendingUserAction.RedirectUrl returned so that the user can complete the SCA session (unless exempted because a successful SCA session for wallet access occurred in the last 180 days, so no redirection link was returned).
USER_NOT_PRESENT – The platform is taking the action under proxy from the user and the user has previously given consent to Mangopay (via the SCA hosted experience) to allow the action. If the user has not given (or has revoked) their consent, then USER_NOT_PRESENT returns a 403 error.

Read more about managing proxy and user consent →

Note: For existing platforms, the parameter is technically optional if the User is an OWNER, and the default value will become USER_PRESENT from Dec 15, 2025 (Dec 1 in Sandbox)

**Possible values:** `USER_PRESENT`, `USER_NOT_PRESENT` The SCA context of the request, which is **required** if the user's `UserCategory` is `OWNER`: - `USER_PRESENT` – The user is taking the SCA-triggering action of accessing their wallet. The platform must [redirect the user](/guides/sca/session) using the `PendingUserAction.RedirectUrl` returned so that the user can complete the SCA session (unless exempted because a successful SCA session for wallet access occurred in the last 180 days, so no redirection link was returned). - `USER_NOT_PRESENT` – The platform is taking the action under proxy from the user and the user has previously given consent to Mangopay (via the SCA hosted experience) to allow the action. If the user has not given (or has revoked) their consent, then `USER_NOT_PRESENT` returns a 403 error. Read more about [managing proxy and user consent](/guides/sca/proxy-management) **→** **Note:** For existing platforms, the parameter is technically optional if the User is an `OWNER`, and the default value will become `USER_PRESENT` from **Dec 15, 2025** (Dec 1 in Sandbox)

Response

Success

Descriptionstring

Max. length: 255 characters

The description of the wallet. It can be a name, the type, or anything else that can help you clearly identify the wallet on the platform (and for your end users).

Ownerslist of strings

The unique identifier of the user owning the wallet.

Note: Only one owner can be defined; this array accepts only one string.

Idstring

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

The unique identifier of the object.

Balanceobject

The current balance of the wallet.

Currencystring

Allowed values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).

The currency of the wallet.

FundsTypestring

Returned values: DEFAULT, FEES, CREDIT

The type of funds in the wallet:

DEFAULT – Regular funds for user-owned wallets. Wallets with this FundsType cannot have a negative balance.
FEES – Fees Wallet, for fees collected by the platform, specific to the Client Wallet object.
CREDIT – Repudiation Wallet, for funds for the platform’s dispute management, specific to the Client Wallet object.

Note: The Fees Wallet and Repudiation Wallet are created automatically by Mangopay for each currency.

Tagstring

Max. length: 255 characters

Custom data that you can add to this object.

CreationDateinteger

Unix timestamp (UTC) of the date and time the wallet was created.

Errors

401

Unauthorized Error

1	{
2	"Description": "Description of the user's wallet",
3	"Owners": [
4	"user_m_01J18HZSACR1EMYNY1TBS8KTJD"
5	],
6	"Id": "wlt_m_01J18J1SQGG6KXNM3F8GD674TP",
7	"Balance": {
8	"Currency": "EUR",
9	"Amount": 99800
10	},
11	"Currency": "EUR",
12	"FundsType": "DEFAULT",
13	"Tag": "Created using Mangopay API Postman collection",
14	"CreationDate": 1719348029
15	}

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