virtualAccounts

Create a Virtual Account

Changed on

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

Request

  • Base URL
    https://api.sandbox.mangopay.com
  • URL
    https://api.sandbox.mangopay.com/v2.01/{ClientId}/wallets/{WalletId}/virtual-accounts
  • Auth
    HTTP bearer

Path parameters

ClientIdstring required

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

WalletIdstring required

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, such as unique identifiers in your system. To store multiple values, you can serialize them into a single string, for example a JSON object: "{\"id_1\":AB123,\"id_2\":DE456}".

Response

Success

OR
OR
OR
OR
OR
OR
OR
OR
OR

Changes

  • f44a59c76515Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • 8e731ec4a85bRevision changes
    • info

      api operation id create_virtual_account removed and replaced with virtualAccounts_create_virtual_account