--- title: "Create a Virtual Account" method: POST path: "/v2.01/{ClientId}/wallets/{WalletId}/virtual-accounts" tags: ["virtualAccounts"] --- # Create a Virtual Account `POST /v2.01/{ClientId}/wallets/{WalletId}/virtual-accounts` Set up a virtual IBAN or local account attached to a wallet **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. ## Path parameters - `ClientId` string, required - `WalletId` string, required ## Headers - `Authorization` string, required ## Request body - CreateAVirtualAccountRequest - `Country` string, required — **Allowed values:** The two-letter ISO 3166-1 country code (LU, FR, GB, etc.) of an available country (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 virtual account guide for details. - `VirtualAccountPurpose` string, 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](/guides/vop) contract amendment. For more information, see the [virtual account](/guides/payment-methods/banking/virtual-iban) guide. - `Tag` string — Max. length: 255 characters Custom data that you can add to this object. ## Response `200` Success - union - VirtualAccountAU — Australian Virtual Account with `Country` `AU`. `LocalAccountDetails.Account` uses the AU-specific format (`BSBCode`, `AccountNumber`). `InternationalAccountDetails` is always `null` because `Capabilities.InternationalPayinAvailable` is always `false`. - `Id` string — Max length: 128 characters (see [data formats](/api-reference/overview/data-formats) for details) The unique identifier of the object. - `Tag` string, nullable — Max. length: 255 characters Custom data that you can add to this object. - `CreationDate` integer — Unix timestamp (UTC) of the date and time the object was created. - `WalletId` string — The unique identifier of the wallet. - `VirtualAccountPurpose` string — **Returned 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](/guides/vop) contract amendment. For more information, see the [virtual account](/guides/payment-methods/banking/virtual-iban) guide. - `Status` string — **Returned values:** `PENDING`, `ACTIVE`, `BLOCKED`, `CLOSED`, `FAILED` 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 to `ACTIVE` or `FAILED`. - `ACTIVE` – The account is active and can receive funds (see note about delayed [UK CoP recognition](#set-up-the-account) for `GB` accounts). `ACTIVE` can transition to `BLOCKED` or `CLOSED`. - `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 to `ACTIVE` or `CLOSED`. - `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](/guides/payment-methods/banking/virtual-iban#status) guide for more details. - `Active` boolean — Whether or not the Virtual Account is active. - `AccountOwner` string — 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 "MGP `PlatformTradingName`" - `USER_OWNED` – Owned by the owner of the associated wallet: `FirstName` `LastName` for Natural Users; `Name` for Legal Users - `Capabilities` VirtualAccountCapabilities — Information about the account's payment capabilities. - `LocalPayinAvailable` boolean — Whether or not local bank wires can be made to this account. - `InternationalPayinAvailable` boolean — Whether or not international bank wires can be made to this account. Returned `false` if `Country` is `US`, `CA`, or `AU`. - `Currencies` string[] — **Returned values:** One or more currency codes in ISO 4217 format (EUR, GBP, etc.) List of currencies supported by the account. - `ResultCode` string — The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes. - `ResultMessage` string — The explanation of the result code. - `Country` string — **Returned values:** `AU` The two-letter ISO 3166-1 country code of the Virtual Account. - `LocalAccountDetails` VirtualAccountLocalDetailsAU — Local account details for `AU` Virtual Accounts. - `Address` VirtualAccountAddress — The address associated with the account. - `StreetName` string, nullable — The building number and street name of the address. - `PostCode` string, nullable — The postal code of the address. - `TownName` string, nullable — The town or city of the address. - `CountrySubDivision` string, nullable — The region, state, or county of the address. - `Country` string, nullable — Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats)) The country of the address. - `Account` VirtualAccountAccountAU — Details of the account in local AU format. Returned when `Country` is `AU`. - `BSBCode` string — The 6-digit bank state branch (BSB) code of the AU local account. - `AccountNumber` string — The 10-digit account number of the AU local account. - `BankName` string, nullable — The name of the bank. - `InternationalAccountDetails` unknown - VirtualAccountCA — Canadian Virtual Account with `Country` `CA`. `LocalAccountDetails.Account` uses the CA-specific format (`BranchCode`, `InstitutionNumber`, `AccountNumber`). `InternationalAccountDetails` is always `null` because `Capabilities.InternationalPayinAvailable` is always `false`. - `Id` string — Max length: 128 characters (see [data formats](/api-reference/overview/data-formats) for details) The unique identifier of the object. - `Tag` string, nullable — Max. length: 255 characters Custom data that you can add to this object. - `CreationDate` integer — Unix timestamp (UTC) of the date and time the object was created. - `WalletId` string — The unique identifier of the wallet. - `VirtualAccountPurpose` string — **Returned 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](/guides/vop) contract amendment. For more information, see the [virtual account](/guides/payment-methods/banking/virtual-iban) guide. - `Status` string — **Returned values:** `PENDING`, `ACTIVE`, `BLOCKED`, `CLOSED`, `FAILED` 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 to `ACTIVE` or `FAILED`. - `ACTIVE` – The account is active and can receive funds (see note about delayed [UK CoP recognition](#set-up-the-account) for `GB` accounts). `ACTIVE` can transition to `BLOCKED` or `CLOSED`. - `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 to `ACTIVE` or `CLOSED`. - `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](/guides/payment-methods/banking/virtual-iban#status) guide for more details. - `Active` boolean — Whether or not the Virtual Account is active. - `AccountOwner` string — 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 "MGP `PlatformTradingName`" - `USER_OWNED` – Owned by the owner of the associated wallet: `FirstName` `LastName` for Natural Users; `Name` for Legal Users - `Capabilities` VirtualAccountCapabilities — Information about the account's payment capabilities. - `LocalPayinAvailable` boolean — Whether or not local bank wires can be made to this account. - `InternationalPayinAvailable` boolean — Whether or not international bank wires can be made to this account. Returned `false` if `Country` is `US`, `CA`, or `AU`. - `Currencies` string[] — **Returned values:** One or more currency codes in ISO 4217 format (EUR, GBP, etc.) List of currencies supported by the account. - `ResultCode` string — The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes. - `ResultMessage` string — The explanation of the result code. - `Country` string — **Returned values:** `CA` The two-letter ISO 3166-1 country code of the Virtual Account. - `LocalAccountDetails` VirtualAccountLocalDetailsCA — Local account details for `CA` Virtual Accounts. - `Address` VirtualAccountAddress — The address associated with the account. - `StreetName` string, nullable — The building number and street name of the address. - `PostCode` string, nullable — The postal code of the address. - `TownName` string, nullable — The town or city of the address. - `CountrySubDivision` string, nullable — The region, state, or county of the address. - `Country` string, nullable — Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats)) The country of the address. - `Account` VirtualAccountAccountCA — Details of the account in local CA format. Returned when `Country` is `CA`. - `BranchCode` string, nullable — The 5-digit branch code or transit number of the CA account. - `InstitutionNumber` string, nullable — The 3-digit institution number of the CA account. - `AccountNumber` string, nullable — The account number of the account. - `BankName` string, nullable — The name of the bank. - `InternationalAccountDetails` unknown - VirtualAccountDE — German Virtual Account with `Country` `DE`. `LocalAccountDetails.Account` uses the IBAN format. `InternationalAccountDetails` is populated if `Capabilities.InternationalPayinAvailable` is `true`. - `Id` string — Max length: 128 characters (see [data formats](/api-reference/overview/data-formats) for details) The unique identifier of the object. - `Tag` string, nullable — Max. length: 255 characters Custom data that you can add to this object. - `CreationDate` integer — Unix timestamp (UTC) of the date and time the object was created. - `WalletId` string — The unique identifier of the wallet. - `VirtualAccountPurpose` string — **Returned 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](/guides/vop) contract amendment. For more information, see the [virtual account](/guides/payment-methods/banking/virtual-iban) guide. - `Status` string — **Returned values:** `PENDING`, `ACTIVE`, `BLOCKED`, `CLOSED`, `FAILED` 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 to `ACTIVE` or `FAILED`. - `ACTIVE` – The account is active and can receive funds (see note about delayed [UK CoP recognition](#set-up-the-account) for `GB` accounts). `ACTIVE` can transition to `BLOCKED` or `CLOSED`. - `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 to `ACTIVE` or `CLOSED`. - `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](/guides/payment-methods/banking/virtual-iban#status) guide for more details. - `Active` boolean — Whether or not the Virtual Account is active. - `AccountOwner` string — 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 "MGP `PlatformTradingName`" - `USER_OWNED` – Owned by the owner of the associated wallet: `FirstName` `LastName` for Natural Users; `Name` for Legal Users - `Capabilities` VirtualAccountCapabilities — Information about the account's payment capabilities. - `LocalPayinAvailable` boolean — Whether or not local bank wires can be made to this account. - `InternationalPayinAvailable` boolean — Whether or not international bank wires can be made to this account. Returned `false` if `Country` is `US`, `CA`, or `AU`. - `Currencies` string[] — **Returned values:** One or more currency codes in ISO 4217 format (EUR, GBP, etc.) List of currencies supported by the account. - `ResultCode` string — The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes. - `ResultMessage` string — The explanation of the result code. - `Country` string — **Returned values:** `DE` The two-letter ISO 3166-1 country code of the Virtual Account. - `LocalAccountDetails` VirtualAccountLocalDetailsIBAN — Local account details for `DE`, `ES`, `FR`, `LU` Virtual Accounts (IBAN format). - `Address` VirtualAccountAddress — The address associated with the account. - `StreetName` string, nullable — The building number and street name of the address. - `PostCode` string, nullable — The postal code of the address. - `TownName` string, nullable — The town or city of the address. - `CountrySubDivision` string, nullable — The region, state, or county of the address. - `Country` string, nullable — Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats)) The country of the address. - `Account` VirtualAccountAccountIBAN — Details of the account in local IBAN format. Returned when `Country` is `DE`, `ES`, `FR`, or `LU`. - `Iban` string — The international bank account number (IBAN) of the account. - `Bic` string — The bank identifier code (BIC) of the account. - `BankName` string, nullable — The name of the bank. - `InternationalAccountDetails` VirtualAccountInternationalDetailsItem[], nullable — List of the account details in international format, populated if `Capabilities.InternationalPayinAvailable` is `true`. **Best practice:** Retrieve both the fields and values of these child objects dynamically to present to the user. The `InternationalAccountDetails.Account` object may be `null` depending on the virtual account `Country`. - `Address` VirtualAccountAddress — The address associated with the account. - `StreetName` string, nullable — The building number and street name of the address. - `PostCode` string, nullable — The postal code of the address. - `TownName` string, nullable — The town or city of the address. - `CountrySubDivision` string, nullable — The region, state, or county of the address. - `Country` string, nullable — Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats)) The country of the address. - `Account` VirtualAccountInternationalAccount — Details of the account in international (IBAN) format. Returned `null` if `Country` is `US`, `CA`, or `AU` as `Capabilities.InternationalPayinAvailable` is `false` for these countries. - `Iban` string — The international bank account number (IBAN) of the account. - `Bic` string — The bank identifier code (BIC) of the account. - `BankName` string, nullable — The name of the bank. - VirtualAccountDK — Danish Virtual Account with `Country` `DK`. `LocalAccountDetails.Account` uses the DK-specific format (`BankCode`, `AccountNumber`). `InternationalAccountDetails` is populated if `Capabilities.InternationalPayinAvailable` is `true`. - `Id` string — Max length: 128 characters (see [data formats](/api-reference/overview/data-formats) for details) The unique identifier of the object. - `Tag` string, nullable — Max. length: 255 characters Custom data that you can add to this object. - `CreationDate` integer — Unix timestamp (UTC) of the date and time the object was created. - `WalletId` string — The unique identifier of the wallet. - `VirtualAccountPurpose` string — **Returned 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](/guides/vop) contract amendment. For more information, see the [virtual account](/guides/payment-methods/banking/virtual-iban) guide. - `Status` string — **Returned values:** `PENDING`, `ACTIVE`, `BLOCKED`, `CLOSED`, `FAILED` 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 to `ACTIVE` or `FAILED`. - `ACTIVE` – The account is active and can receive funds (see note about delayed [UK CoP recognition](#set-up-the-account) for `GB` accounts). `ACTIVE` can transition to `BLOCKED` or `CLOSED`. - `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 to `ACTIVE` or `CLOSED`. - `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](/guides/payment-methods/banking/virtual-iban#status) guide for more details. - `Active` boolean — Whether or not the Virtual Account is active. - `AccountOwner` string — 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 "MGP `PlatformTradingName`" - `USER_OWNED` – Owned by the owner of the associated wallet: `FirstName` `LastName` for Natural Users; `Name` for Legal Users - `Capabilities` VirtualAccountCapabilities — Information about the account's payment capabilities. - `LocalPayinAvailable` boolean — Whether or not local bank wires can be made to this account. - `InternationalPayinAvailable` boolean — Whether or not international bank wires can be made to this account. Returned `false` if `Country` is `US`, `CA`, or `AU`. - `Currencies` string[] — **Returned values:** One or more currency codes in ISO 4217 format (EUR, GBP, etc.) List of currencies supported by the account. - `ResultCode` string — The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes. - `ResultMessage` string — The explanation of the result code. - `Country` string — **Returned values:** `DK` The two-letter ISO 3166-1 country code of the Virtual Account. - `LocalAccountDetails` VirtualAccountLocalDetailsDK — Local account details for `DK` Virtual Accounts. - `Address` VirtualAccountAddress — The address associated with the account. - `StreetName` string, nullable — The building number and street name of the address. - `PostCode` string, nullable — The postal code of the address. - `TownName` string, nullable — The town or city of the address. - `CountrySubDivision` string, nullable — The region, state, or county of the address. - `Country` string, nullable — Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats)) The country of the address. - `Account` VirtualAccountAccountDK — Details of the account in local DK format. Returned when `Country` is `DK`. - `BankCode` string — The 4-digit bank code of the DK local account. - `AccountNumber` string — The 10-digit account number of the DK local account. - `BankName` string, nullable — The name of the bank. - `InternationalAccountDetails` VirtualAccountInternationalDetailsItem[], nullable — List of the account details in international format, populated if `Capabilities.InternationalPayinAvailable` is `true`. **Best practice:** Retrieve both the fields and values of these child objects dynamically to present to the user. The `InternationalAccountDetails.Account` object may be `null` depending on the virtual account `Country`. - `Address` VirtualAccountAddress — The address associated with the account. - `StreetName` string, nullable — The building number and street name of the address. - `PostCode` string, nullable — The postal code of the address. - `TownName` string, nullable — The town or city of the address. - `CountrySubDivision` string, nullable — The region, state, or county of the address. - `Country` string, nullable — Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats)) The country of the address. - `Account` VirtualAccountInternationalAccount — Details of the account in international (IBAN) format. Returned `null` if `Country` is `US`, `CA`, or `AU` as `Capabilities.InternationalPayinAvailable` is `false` for these countries. - `Iban` string — The international bank account number (IBAN) of the account. - `Bic` string — The bank identifier code (BIC) of the account. - `BankName` string, nullable — The name of the bank. - VirtualAccountES — Spanish Virtual Account with `Country` `ES`. `LocalAccountDetails.Account` uses the IBAN format. `InternationalAccountDetails` is populated if `Capabilities.InternationalPayinAvailable` is `true`. - `Id` string — Max length: 128 characters (see [data formats](/api-reference/overview/data-formats) for details) The unique identifier of the object. - `Tag` string, nullable — Max. length: 255 characters Custom data that you can add to this object. - `CreationDate` integer — Unix timestamp (UTC) of the date and time the object was created. - `WalletId` string — The unique identifier of the wallet. - `VirtualAccountPurpose` string — **Returned 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](/guides/vop) contract amendment. For more information, see the [virtual account](/guides/payment-methods/banking/virtual-iban) guide. - `Status` string — **Returned values:** `PENDING`, `ACTIVE`, `BLOCKED`, `CLOSED`, `FAILED` 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 to `ACTIVE` or `FAILED`. - `ACTIVE` – The account is active and can receive funds (see note about delayed [UK CoP recognition](#set-up-the-account) for `GB` accounts). `ACTIVE` can transition to `BLOCKED` or `CLOSED`. - `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 to `ACTIVE` or `CLOSED`. - `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](/guides/payment-methods/banking/virtual-iban#status) guide for more details. - `Active` boolean — Whether or not the Virtual Account is active. - `AccountOwner` string — 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 "MGP `PlatformTradingName`" - `USER_OWNED` – Owned by the owner of the associated wallet: `FirstName` `LastName` for Natural Users; `Name` for Legal Users - `Capabilities` VirtualAccountCapabilities — Information about the account's payment capabilities. - `LocalPayinAvailable` boolean — Whether or not local bank wires can be made to this account. - `InternationalPayinAvailable` boolean — Whether or not international bank wires can be made to this account. Returned `false` if `Country` is `US`, `CA`, or `AU`. - `Currencies` string[] — **Returned values:** One or more currency codes in ISO 4217 format (EUR, GBP, etc.) List of currencies supported by the account. - `ResultCode` string — The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes. - `ResultMessage` string — The explanation of the result code. - `Country` string — **Returned values:** `ES` The two-letter ISO 3166-1 country code of the Virtual Account. - `LocalAccountDetails` VirtualAccountLocalDetailsIBAN — Local account details for `DE`, `ES`, `FR`, `LU` Virtual Accounts (IBAN format). - `Address` VirtualAccountAddress — The address associated with the account. - `StreetName` string, nullable — The building number and street name of the address. - `PostCode` string, nullable — The postal code of the address. - `TownName` string, nullable — The town or city of the address. - `CountrySubDivision` string, nullable — The region, state, or county of the address. - `Country` string, nullable — Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats)) The country of the address. - `Account` VirtualAccountAccountIBAN — Details of the account in local IBAN format. Returned when `Country` is `DE`, `ES`, `FR`, or `LU`. - `Iban` string — The international bank account number (IBAN) of the account. - `Bic` string — The bank identifier code (BIC) of the account. - `BankName` string, nullable — The name of the bank. - `InternationalAccountDetails` VirtualAccountInternationalDetailsItem[], nullable — List of the account details in international format, populated if `Capabilities.InternationalPayinAvailable` is `true`. **Best practice:** Retrieve both the fields and values of these child objects dynamically to present to the user. The `InternationalAccountDetails.Account` object may be `null` depending on the virtual account `Country`. - `Address` VirtualAccountAddress — The address associated with the account. - `StreetName` string, nullable — The building number and street name of the address. - `PostCode` string, nullable — The postal code of the address. - `TownName` string, nullable — The town or city of the address. - `CountrySubDivision` string, nullable — The region, state, or county of the address. - `Country` string, nullable — Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats)) The country of the address. - `Account` VirtualAccountInternationalAccount — Details of the account in international (IBAN) format. Returned `null` if `Country` is `US`, `CA`, or `AU` as `Capabilities.InternationalPayinAvailable` is `false` for these countries. - `Iban` string — The international bank account number (IBAN) of the account. - `Bic` string — The bank identifier code (BIC) of the account. - `BankName` string, nullable — The name of the bank. - VirtualAccountFR — French Virtual Account with `Country` `FR`. `LocalAccountDetails.Account` uses the IBAN format. `InternationalAccountDetails` is populated if `Capabilities.InternationalPayinAvailable` is `true`. - `Id` string — Max length: 128 characters (see [data formats](/api-reference/overview/data-formats) for details) The unique identifier of the object. - `Tag` string, nullable — Max. length: 255 characters Custom data that you can add to this object. - `CreationDate` integer — Unix timestamp (UTC) of the date and time the object was created. - `WalletId` string — The unique identifier of the wallet. - `VirtualAccountPurpose` string — **Returned 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](/guides/vop) contract amendment. For more information, see the [virtual account](/guides/payment-methods/banking/virtual-iban) guide. - `Status` string — **Returned values:** `PENDING`, `ACTIVE`, `BLOCKED`, `CLOSED`, `FAILED` 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 to `ACTIVE` or `FAILED`. - `ACTIVE` – The account is active and can receive funds (see note about delayed [UK CoP recognition](#set-up-the-account) for `GB` accounts). `ACTIVE` can transition to `BLOCKED` or `CLOSED`. - `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 to `ACTIVE` or `CLOSED`. - `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](/guides/payment-methods/banking/virtual-iban#status) guide for more details. - `Active` boolean — Whether or not the Virtual Account is active. - `AccountOwner` string — 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 "MGP `PlatformTradingName`" - `USER_OWNED` – Owned by the owner of the associated wallet: `FirstName` `LastName` for Natural Users; `Name` for Legal Users - `Capabilities` VirtualAccountCapabilities — Information about the account's payment capabilities. - `LocalPayinAvailable` boolean — Whether or not local bank wires can be made to this account. - `InternationalPayinAvailable` boolean — Whether or not international bank wires can be made to this account. Returned `false` if `Country` is `US`, `CA`, or `AU`. - `Currencies` string[] — **Returned values:** One or more currency codes in ISO 4217 format (EUR, GBP, etc.) List of currencies supported by the account. - `ResultCode` string — The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes. - `ResultMessage` string — The explanation of the result code. - `Country` string — **Returned values:** `FR` The two-letter ISO 3166-1 country code of the Virtual Account. - `LocalAccountDetails` VirtualAccountLocalDetailsIBAN — Local account details for `DE`, `ES`, `FR`, `LU` Virtual Accounts (IBAN format). - `Address` VirtualAccountAddress — The address associated with the account. - `StreetName` string, nullable — The building number and street name of the address. - `PostCode` string, nullable — The postal code of the address. - `TownName` string, nullable — The town or city of the address. - `CountrySubDivision` string, nullable — The region, state, or county of the address. - `Country` string, nullable — Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats)) The country of the address. - `Account` VirtualAccountAccountIBAN — Details of the account in local IBAN format. Returned when `Country` is `DE`, `ES`, `FR`, or `LU`. - `Iban` string — The international bank account number (IBAN) of the account. - `Bic` string — The bank identifier code (BIC) of the account. - `BankName` string, nullable — The name of the bank. - `InternationalAccountDetails` VirtualAccountInternationalDetailsItem[], nullable — List of the account details in international format, populated if `Capabilities.InternationalPayinAvailable` is `true`. **Best practice:** Retrieve both the fields and values of these child objects dynamically to present to the user. The `InternationalAccountDetails.Account` object may be `null` depending on the virtual account `Country`. - `Address` VirtualAccountAddress — The address associated with the account. - `StreetName` string, nullable — The building number and street name of the address. - `PostCode` string, nullable — The postal code of the address. - `TownName` string, nullable — The town or city of the address. - `CountrySubDivision` string, nullable — The region, state, or county of the address. - `Country` string, nullable — Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats)) The country of the address. - `Account` VirtualAccountInternationalAccount — Details of the account in international (IBAN) format. Returned `null` if `Country` is `US`, `CA`, or `AU` as `Capabilities.InternationalPayinAvailable` is `false` for these countries. - `Iban` string — The international bank account number (IBAN) of the account. - `Bic` string — The bank identifier code (BIC) of the account. - `BankName` string, nullable — The name of the bank. - VirtualAccountGB — United Kingdom (UK) Virtual Account with `Country` `GB`. `LocalAccountDetails.Account` uses the GB-specific format (`AccountNumber`, `SortCode`). `InternationalAccountDetails` is populated if `Capabilities.InternationalPayinAvailable` is `true`. - `Id` string — Max length: 128 characters (see [data formats](/api-reference/overview/data-formats) for details) The unique identifier of the object. - `Tag` string, nullable — Max. length: 255 characters Custom data that you can add to this object. - `CreationDate` integer — Unix timestamp (UTC) of the date and time the object was created. - `WalletId` string — The unique identifier of the wallet. - `VirtualAccountPurpose` string — **Returned 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](/guides/vop) contract amendment. For more information, see the [virtual account](/guides/payment-methods/banking/virtual-iban) guide. - `Status` string — **Returned values:** `PENDING`, `ACTIVE`, `BLOCKED`, `CLOSED`, `FAILED` 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 to `ACTIVE` or `FAILED`. - `ACTIVE` – The account is active and can receive funds (see note about delayed [UK CoP recognition](#set-up-the-account) for `GB` accounts). `ACTIVE` can transition to `BLOCKED` or `CLOSED`. - `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 to `ACTIVE` or `CLOSED`. - `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](/guides/payment-methods/banking/virtual-iban#status) guide for more details. - `Active` boolean — Whether or not the Virtual Account is active. - `AccountOwner` string — 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 "MGP `PlatformTradingName`" - `USER_OWNED` – Owned by the owner of the associated wallet: `FirstName` `LastName` for Natural Users; `Name` for Legal Users - `Capabilities` VirtualAccountCapabilities — Information about the account's payment capabilities. - `LocalPayinAvailable` boolean — Whether or not local bank wires can be made to this account. - `InternationalPayinAvailable` boolean — Whether or not international bank wires can be made to this account. Returned `false` if `Country` is `US`, `CA`, or `AU`. - `Currencies` string[] — **Returned values:** One or more currency codes in ISO 4217 format (EUR, GBP, etc.) List of currencies supported by the account. - `ResultCode` string — The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes. - `ResultMessage` string — The explanation of the result code. - `Country` string — **Returned values:** `GB` The two-letter ISO 3166-1 country code of the Virtual Account. - `LocalAccountDetails` VirtualAccountLocalDetailsGB — Local account details for `GB` Virtual Accounts. - `Address` VirtualAccountAddress — The address associated with the account. - `StreetName` string, nullable — The building number and street name of the address. - `PostCode` string, nullable — The postal code of the address. - `TownName` string, nullable — The town or city of the address. - `CountrySubDivision` string, nullable — The region, state, or county of the address. - `Country` string, nullable — Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats)) The country of the address. - `Account` VirtualAccountAccountGB — Details of the account in local GB format. Returned when `Country` is `GB`. - `AccountNumber` string — The account number of the account. - `SortCode` string — The sort code of the account. - `BankName` string, nullable — The name of the bank. - `InternationalAccountDetails` VirtualAccountInternationalDetailsItem[], nullable — List of the account details in international format, populated if `Capabilities.InternationalPayinAvailable` is `true`. **Best practice:** Retrieve both the fields and values of these child objects dynamically to present to the user. The `InternationalAccountDetails.Account` object may be `null` depending on the virtual account `Country`. - `Address` VirtualAccountAddress — The address associated with the account. - `StreetName` string, nullable — The building number and street name of the address. - `PostCode` string, nullable — The postal code of the address. - `TownName` string, nullable — The town or city of the address. - `CountrySubDivision` string, nullable — The region, state, or county of the address. - `Country` string, nullable — Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats)) The country of the address. - `Account` VirtualAccountInternationalAccount — Details of the account in international (IBAN) format. Returned `null` if `Country` is `US`, `CA`, or `AU` as `Capabilities.InternationalPayinAvailable` is `false` for these countries. - `Iban` string — The international bank account number (IBAN) of the account. - `Bic` string — The bank identifier code (BIC) of the account. - `BankName` string, nullable — The name of the bank. - VirtualAccountLI — Liechtenstein Virtual Account with `Country` `LI`. `LocalAccountDetails.Account` uses the LI-specific format (`BCNumber`, `AccountNumber`). `InternationalAccountDetails` is populated if `Capabilities.InternationalPayinAvailable` is `true`. For `LI`, `InternationalAccountDetails.Account` uses the same format as `LocalAccountDetails.Account`. - `Id` string — Max length: 128 characters (see [data formats](/api-reference/overview/data-formats) for details) The unique identifier of the object. - `Tag` string, nullable — Max. length: 255 characters Custom data that you can add to this object. - `CreationDate` integer — Unix timestamp (UTC) of the date and time the object was created. - `WalletId` string — The unique identifier of the wallet. - `VirtualAccountPurpose` string — **Returned 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](/guides/vop) contract amendment. For more information, see the [virtual account](/guides/payment-methods/banking/virtual-iban) guide. - `Status` string — **Returned values:** `PENDING`, `ACTIVE`, `BLOCKED`, `CLOSED`, `FAILED` 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 to `ACTIVE` or `FAILED`. - `ACTIVE` – The account is active and can receive funds (see note about delayed [UK CoP recognition](#set-up-the-account) for `GB` accounts). `ACTIVE` can transition to `BLOCKED` or `CLOSED`. - `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 to `ACTIVE` or `CLOSED`. - `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](/guides/payment-methods/banking/virtual-iban#status) guide for more details. - `Active` boolean — Whether or not the Virtual Account is active. - `AccountOwner` string — 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 "MGP `PlatformTradingName`" - `USER_OWNED` – Owned by the owner of the associated wallet: `FirstName` `LastName` for Natural Users; `Name` for Legal Users - `Capabilities` VirtualAccountCapabilities — Information about the account's payment capabilities. - `LocalPayinAvailable` boolean — Whether or not local bank wires can be made to this account. - `InternationalPayinAvailable` boolean — Whether or not international bank wires can be made to this account. Returned `false` if `Country` is `US`, `CA`, or `AU`. - `Currencies` string[] — **Returned values:** One or more currency codes in ISO 4217 format (EUR, GBP, etc.) List of currencies supported by the account. - `ResultCode` string — The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes. - `ResultMessage` string — The explanation of the result code. - `Country` string — **Returned values:** `LI` The two-letter ISO 3166-1 country code of the Virtual Account. - `LocalAccountDetails` VirtualAccountLocalDetailsLI — Local account details for `LI` Virtual Accounts. - `Address` VirtualAccountAddress — The address associated with the account. - `StreetName` string, nullable — The building number and street name of the address. - `PostCode` string, nullable — The postal code of the address. - `TownName` string, nullable — The town or city of the address. - `CountrySubDivision` string, nullable — The region, state, or county of the address. - `Country` string, nullable — Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats)) The country of the address. - `Account` VirtualAccountAccountLI — Details of the account in local LI format. Returned when `Country` is `LI`. - `BCNumber` string — The 5-digit bank clearing number of the LI local account. - `AccountNumber` string — The 12-digit account number of the LI local account. - `BankName` string, nullable — The name of the bank. - `InternationalAccountDetails` VirtualAccountInternationalDetailsItemLI[], nullable — List of the account details in international format, populated if `Capabilities.InternationalPayinAvailable` is `true`. **Best practice:** Retrieve both the fields and values of these child objects dynamically to present to the user. For `LI`, `InternationalAccountDetails.Account` uses the same format as `LocalAccountDetails.Account`. - `Address` VirtualAccountAddress — The address associated with the account. - `StreetName` string, nullable — The building number and street name of the address. - `PostCode` string, nullable — The postal code of the address. - `TownName` string, nullable — The town or city of the address. - `CountrySubDivision` string, nullable — The region, state, or county of the address. - `Country` string, nullable — Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats)) The country of the address. - `Account` VirtualAccountAccountLI — Details of the account in local LI format. Returned when `Country` is `LI`. - `BCNumber` string — The 5-digit bank clearing number of the LI local account. - `AccountNumber` string — The 12-digit account number of the LI local account. - `BankName` string, nullable — The name of the bank. - VirtualAccountLU — Luxembourg Virtual Account with `Country` `LU`. `LocalAccountDetails.Account` uses the IBAN format. `InternationalAccountDetails` is populated if `Capabilities.InternationalPayinAvailable` is `true`. - `Id` string — Max length: 128 characters (see [data formats](/api-reference/overview/data-formats) for details) The unique identifier of the object. - `Tag` string, nullable — Max. length: 255 characters Custom data that you can add to this object. - `CreationDate` integer — Unix timestamp (UTC) of the date and time the object was created. - `WalletId` string — The unique identifier of the wallet. - `VirtualAccountPurpose` string — **Returned 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](/guides/vop) contract amendment. For more information, see the [virtual account](/guides/payment-methods/banking/virtual-iban) guide. - `Status` string — **Returned values:** `PENDING`, `ACTIVE`, `BLOCKED`, `CLOSED`, `FAILED` 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 to `ACTIVE` or `FAILED`. - `ACTIVE` – The account is active and can receive funds (see note about delayed [UK CoP recognition](#set-up-the-account) for `GB` accounts). `ACTIVE` can transition to `BLOCKED` or `CLOSED`. - `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 to `ACTIVE` or `CLOSED`. - `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](/guides/payment-methods/banking/virtual-iban#status) guide for more details. - `Active` boolean — Whether or not the Virtual Account is active. - `AccountOwner` string — 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 "MGP `PlatformTradingName`" - `USER_OWNED` – Owned by the owner of the associated wallet: `FirstName` `LastName` for Natural Users; `Name` for Legal Users - `Capabilities` VirtualAccountCapabilities — Information about the account's payment capabilities. - `LocalPayinAvailable` boolean — Whether or not local bank wires can be made to this account. - `InternationalPayinAvailable` boolean — Whether or not international bank wires can be made to this account. Returned `false` if `Country` is `US`, `CA`, or `AU`. - `Currencies` string[] — **Returned values:** One or more currency codes in ISO 4217 format (EUR, GBP, etc.) List of currencies supported by the account. - `ResultCode` string — The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes. - `ResultMessage` string — The explanation of the result code. - `Country` string — **Returned values:** `LU` The two-letter ISO 3166-1 country code of the Virtual Account. - `LocalAccountDetails` VirtualAccountLocalDetailsIBAN — Local account details for `DE`, `ES`, `FR`, `LU` Virtual Accounts (IBAN format). - `Address` VirtualAccountAddress — The address associated with the account. - `StreetName` string, nullable — The building number and street name of the address. - `PostCode` string, nullable — The postal code of the address. - `TownName` string, nullable — The town or city of the address. - `CountrySubDivision` string, nullable — The region, state, or county of the address. - `Country` string, nullable — Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats)) The country of the address. - `Account` VirtualAccountAccountIBAN — Details of the account in local IBAN format. Returned when `Country` is `DE`, `ES`, `FR`, or `LU`. - `Iban` string — The international bank account number (IBAN) of the account. - `Bic` string — The bank identifier code (BIC) of the account. - `BankName` string, nullable — The name of the bank. - `InternationalAccountDetails` VirtualAccountInternationalDetailsItem[], nullable — List of the account details in international format, populated if `Capabilities.InternationalPayinAvailable` is `true`. **Best practice:** Retrieve both the fields and values of these child objects dynamically to present to the user. The `InternationalAccountDetails.Account` object may be `null` depending on the virtual account `Country`. - `Address` VirtualAccountAddress — The address associated with the account. - `StreetName` string, nullable — The building number and street name of the address. - `PostCode` string, nullable — The postal code of the address. - `TownName` string, nullable — The town or city of the address. - `CountrySubDivision` string, nullable — The region, state, or county of the address. - `Country` string, nullable — Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats)) The country of the address. - `Account` VirtualAccountInternationalAccount — Details of the account in international (IBAN) format. Returned `null` if `Country` is `US`, `CA`, or `AU` as `Capabilities.InternationalPayinAvailable` is `false` for these countries. - `Iban` string — The international bank account number (IBAN) of the account. - `Bic` string — The bank identifier code (BIC) of the account. - `BankName` string, nullable — The name of the bank. - VirtualAccountUS — United States Virtual Account with `Country` `US`. `LocalAccountDetails.Account` uses the US-specific format (`AccountNumber`, `AchNumber`, `FedWireNumber`, `AccountType`). `InternationalAccountDetails` is always `null` because `Capabilities.InternationalPayinAvailable` is always `false`. - `Id` string — Max length: 128 characters (see [data formats](/api-reference/overview/data-formats) for details) The unique identifier of the object. - `Tag` string, nullable — Max. length: 255 characters Custom data that you can add to this object. - `CreationDate` integer — Unix timestamp (UTC) of the date and time the object was created. - `WalletId` string — The unique identifier of the wallet. - `VirtualAccountPurpose` string — **Returned 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](/guides/vop) contract amendment. For more information, see the [virtual account](/guides/payment-methods/banking/virtual-iban) guide. - `Status` string — **Returned values:** `PENDING`, `ACTIVE`, `BLOCKED`, `CLOSED`, `FAILED` 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 to `ACTIVE` or `FAILED`. - `ACTIVE` – The account is active and can receive funds (see note about delayed [UK CoP recognition](#set-up-the-account) for `GB` accounts). `ACTIVE` can transition to `BLOCKED` or `CLOSED`. - `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 to `ACTIVE` or `CLOSED`. - `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](/guides/payment-methods/banking/virtual-iban#status) guide for more details. - `Active` boolean — Whether or not the Virtual Account is active. - `AccountOwner` string — 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 "MGP `PlatformTradingName`" - `USER_OWNED` – Owned by the owner of the associated wallet: `FirstName` `LastName` for Natural Users; `Name` for Legal Users - `Capabilities` VirtualAccountCapabilities — Information about the account's payment capabilities. - `LocalPayinAvailable` boolean — Whether or not local bank wires can be made to this account. - `InternationalPayinAvailable` boolean — Whether or not international bank wires can be made to this account. Returned `false` if `Country` is `US`, `CA`, or `AU`. - `Currencies` string[] — **Returned values:** One or more currency codes in ISO 4217 format (EUR, GBP, etc.) List of currencies supported by the account. - `ResultCode` string — The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes. - `ResultMessage` string — The explanation of the result code. - `Country` string — **Returned values:** `US` The two-letter ISO 3166-1 country code of the Virtual Account. - `LocalAccountDetails` VirtualAccountLocalDetailsUS — Local account details for `US` Virtual Accounts. - `Address` VirtualAccountAddress — The address associated with the account. - `StreetName` string, nullable — The building number and street name of the address. - `PostCode` string, nullable — The postal code of the address. - `TownName` string, nullable — The town or city of the address. - `CountrySubDivision` string, nullable — The region, state, or county of the address. - `Country` string, nullable — Format: Two-letter country code ([ISO 3166-1 alpha-2 format](/api-reference/overview/data-formats)) The country of the address. - `Account` VirtualAccountAccountUS — Details of the account in local US format. Returned when `Country` is `US`. - `AccountNumber` string, nullable — The account number of the account. - `AchNumber` string, nullable — The 9-digit ACH routing number of the US account. - `FedWireNumber` string, nullable — The 9-digit Fedwire (ABA) number of the US account. - `AccountType` string — The account type of the US account, which is always `CHECKING`. - `BankName` string, nullable — The name of the bank. - `InternationalAccountDetails` unknown ## Other responses - `400` — Bad Request - `403` — Forbidden --- [API](https://skmtc.dev/mangopay/apis/api-reference.md) · [All operations](https://skmtc.dev/mangopay/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/mangopay/api-reference/revisions/fafbd0c69654/schema)