GET
/
v2.01
/
{ClientId}
/
wallets
/
{WalletId}
// GET has no body parameters

{
    "Description": "Description of the user's wallet",
    "Owners": [
        "user_m_01J18HZSACR1EMYNY1TBS8KTJD"
    ],
    "Id": "wlt_m_01J18J1SQGG6KXNM3F8GD674TP",
    "Balance": {
        "Currency": "EUR",
        "Amount": 99800
    },
    "Currency": "EUR",
    "FundsType": "DEFAULT",
    "Tag": "Created using Mangopay API Postman collection",
    "CreationDate": 1719348029
}

Note – SCA triggered by this endpoint

This endpoint requires the user to complete SCA to authenticate the access to their wallet, unless SCA for wallet access was successfully completed in the last 180 days (read more about SCA on wallet access).

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.

​
Path parameters

​
WalletId
string
required

The unique identifier of the wallet.

​
Query parameters

​
ScaContext
string

Possible values: USER_PRESENT, USER_NOT_PRESENT

Default value: null

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

  • USER_PRESENT – The user is initiating the wallet access request and is actively present. The platform must redirect the user for SCA using the PendingUserAction.RedirectUrl returned, unless a successful SCA session for wallet access occurred in the last 180 days.
  • USER_NOT_PRESENT – No user is present: the access is automated by the platform as part of their declared and authorized workflow. On these requests, SCA redirection is not initially required, but in future Mangopay may be required to override the request.

Both values may technically result in the need for SCA redirection, because an exemption may be applied by Mangopay or (in future) Mangopay may be required to override a given request.

Note: ScaContext is a temporary mechanism to introduce SCA on existing endpoints and workflows. New integrations should consider the parameter required and send USER_PRESENT by default. Read more about SCA on wallet access →

​
Responses

{
    "Description": "Description of the user's wallet",
    "Owners": [
        "user_m_01J18HZSACR1EMYNY1TBS8KTJD"
    ],
    "Id": "wlt_m_01J18J1SQGG6KXNM3F8GD674TP",
    "Balance": {
        "Currency": "EUR",
        "Amount": 99800
    },
    "Currency": "EUR",
    "FundsType": "DEFAULT",
    "Tag": "Created using Mangopay API Postman collection",
    "CreationDate": 1719348029
}

// GET has no body parameters

Was this page helpful?