View a Virtual Account
Path parameters
The unique identifier of the wallet.
The unique identifier of the virtual account.
Responses
200
200
Max length: 128 characters (see data formats for details)
The unique identifier of the object.
Max. length: 255 characters
Custom data that you can add to this object.
The date and time at which the object was created.
The unique identifier of the wallet.
Allowed values: COLLECTION
, USER_OWNED
The type of the virtual account:
COLLECTION
- Owned by Mangopay and usable by platforms and/or users for the purpose of collecting and reconciling incoming funds paid by users.USER_OWNED
- Owned by the wallet owner, enabling them to accept and store funds and make payments.
For more information, see virtual account guide.
Returned values: The two-letter ISO 3166-1 country code (LU, FR, GB, etc.) of an available country (depends on contract and activation settings).
The country of the IBAN. The country must correspond to the currency of the wallet. See the virtual account guide for details.
The status of the Virtual Account:
PENDING
– The account creation request is being processed and full account details may not yet be returned. Any funds sent to the account are returned (if account details exist).PENDING
can transition toACTIVE
orFAILED
.ACTIVE
– The account is active and can receive funds (see note about delayed UK CoP recognition forGB
accounts).ACTIVE
can transition toBLOCKED
orCLOSED
.BLOCKED
– The account is blocked and is not active. Any funds sent to the account are returned. This temporary status may be used during processes relating to user verification or fraud screening.BLOCKED
can transition toACTIVE
orCLOSED
.CLOSED
– The account has been deactivated and is closed. Any funds sent to the account are returned. This is a final state.FAILED
– The account creation request failed or was rejected. This final state is rare. Any funds sent to the account are returned (if account details exist).
See the virtual account guide for more details.
Whether or not the Virtual Account is active.
The owner of the virtual account.
The account owner is assigned automatically depending on the VirtualAccountPurpose
:
COLLECTION
– Owned by Mangopay SA or Mangopay UK Ltd., mentioning the platform’s trading name in the format “MGPPlatformTradingName
”USER_OWNED
– Owned by the owner of the associated wallet:FirstName
LastName
for Natural Users;Name
for Legal Users
The account details in local format.
Best practice: Retrieve both the fields and values of these objects dynamically to present to the user. The LocalAccountDetails.Account
object has different properties depending on the virtual account Country
.
List of the account details in international format.
Best practice: Retrieve both the fields and values of these objects dynamically to present to the user. The InternationalAccountDetails.Account
object has different properties depending on the virtual account Country
.
Information about the account’s payment capabilities.
The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.
The explanation of the result code.
Functional errors (ResultCode
) are possible on a 200 response. Read more →