v2

latestOpenAPI 3.1.02026-07-262279731.3 MB

virtualAccounts

Create a Virtual Account

Set up a virtual IBAN or local account attached to a wallet <Note icon="fa-regular fa-circle-info"> Note – One account purpose per wallet

A wallet can only have either COLLECTION or USER_OWNED virtual accounts attached, but not both.

It is, however, possible to attach multiple virtual accounts of the same VirtualAccountPurpose to a single wallet. </Note>

post/v2.01/{ClientId}/wallets/{WalletId}/virtual-accounts

Path parameters

ClientIdstring required

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

WalletIdstring required

Headers

Authorizationstring required

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.

Request body

Countrystring required

Allowed values: The two-letter <a href="/api-reference/overview/data-formats">ISO 3166-1</a> country code (LU, FR, GB, etc.) of an <a href="/guides/payment-methods/banking/virtual-iban">available country</a> (depends on contract and activation settings): AU, CA, DK, DE, ES, FR, GB, LI, LU, US

The country of the Virtual Account. The country must correspond to the currency of the wallet. See the <a href="/guides/payment-methods/banking/virtual-iban">virtual account</a> guide for details.

VirtualAccountPurposestring required

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. Offering User-Owned Accounts requires your platform to sign the VOP contract amendment.

For more information, see the virtual account guide.

Tagstring

Max. length: 255 characters

Custom data that you can add to this object.

Response

Success