User wallets
View a Wallet
GET
Note – SCA triggered by this endpointThis 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
The unique identifier of the wallet.
Query parameters
Possible values:
USER_PRESENT, USER_NOT_PRESENTDefault value: nullThe 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 thePendingUserAction.RedirectUrlreturned, 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.
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
200
200
Max. length: 255 charactersThe 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).
stringThe unique identifier of the user owning the wallet.Note: Only one owner can be defined; this array accepts only one string.
Max length: 128 characters (see data formats for details)The unique identifier of the object.
The current balance of the wallet.
Returned 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.
Returned values:
DEFAULT, FEES, CREDITThe type of funds in the wallet:DEFAULT– Regular funds for user-owned wallets. Wallets with thisFundsTypecannot 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.
Max. length: 255 charactersCustom data that you can add to this object.
For wallets, you can use this parameter to identify the corresponding end user in your platform.
For wallets, you can use this parameter to identify the corresponding end user in your platform.
The date and time at which the wallet was created.
401 - SCA required
401 - SCA required
When SCA is required for wallet access, this endpoint returns a 401 - Unauthorized response code with the In this case, your platform needs to retrieve the URL value, encode and add a
redirectUrl in the WWW-Authenticate response header:401 response header
returnUrl query parameter, and redirect the user.Read more about SCA redirection and SCA on wallet access →