Deactivate a Virtual Account

PUT

/v2.01/:ClientId/wallets/:WalletId/virtual-accounts/:VirtualAccountId

PUT

/v2.01/:ClientId/wallets/:WalletId/virtual-accounts/:VirtualAccountId

$ curl -X PUT https://api.sandbox.mangopay.com/v2.01/ClientId/wallets/WalletId/virtual-accounts/VirtualAccountId \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "body": {
>     "Active": false
>   }
> }'

200Updated

1 {
2   "Id": "wltbank_m_01J7NCAT73Q15SVSM9S6Z36GRZ",
3   "Tag": "Created using Mangopay API Postman Collection",
4   "CreationDate": 1726220691,
5   "WalletId": "wlt_m_01J7NC9YKP3NB1PADF4SHZY712",
6   "VirtualAccountPurpose": "COLLECTION",
7   "Country": "GB",
8   "Status": "CLOSED",
9   "Active": false,
10   "AccountOwner": "MGP PlatformTradingName",
11   "LocalAccountDetails": {
12     "Address": {
13       "StreetName": "68 King William Street",
14       "PostCode": "EC4N 7HR",
15       "TownName": "London",
16       "CountrySubDivision": null,
17       "Country": "GB"
18     },
19     "Account": {
20       "SortCode": "608382",
21       "AccountNumber": "22276063"
22     },
23     "BankName": "Banking Circle S.A. UK Branch"
24   },
25   "InternationalAccountDetails": [
26     {
27       "Address": {
28         "StreetName": "68 King William Street",
29         "PostCode": "EC4N 7HR",
30         "TownName": "London",
31         "CountrySubDivision": null,
32         "Country": "GB"
33       },
34       "Account": {
35         "Iban": "GB92SAPY60838222276063",
36         "Bic": "SAPYGB2L"
37       },
38       "BankName": "Banking Circle S.A. UK Branch"
39     }
40   ],
41   "Capabilities": {
42     "LocalPayinAvailable": true,
43     "InternationalPayinAvailable": true,
44     "Currencies": [
45       "GBP"
46     ]
47   },
48   "ResultCode": "000000",
49   "ResultMessage": "Success"
50 }

Caution - Deactivating a Virtual Account is irreversible

Once the Virtual Account object is deactivated, it is closed and cannot be reopened.

Any funds wired to this IBAN or local account details won’t be credited to the corresponding wallet and will be returned to the sender.

If such cases arise, contact Mangopay via the Dashboard.

Close an account permanently to prevent it being used

This call serves only to deactivate a virtual account if it is no longer needed. Once deactivated, the account Status is CLOSED.

<Warning icon="fa-regular fa-triangle-exclamation"> **Caution - Deactivating a Virtual Account is irreversible** Once the Virtual Account object is deactivated, it is closed and cannot be reopened. Any funds wired to this IBAN or local account details won’t be credited to the corresponding wallet and will be returned to the sender. If such cases arise, contact Mangopay <a href="https://hub.mangopay.com/" target="_blank">via the Dashboard</a>. </Warning> Close an account permanently to prevent it being used This call serves only to deactivate a virtual account if it is no longer needed. Once deactivated, the account `Status` is `CLOSED`.

Authentication

AuthorizationBearer

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.

Bearer authentication of the form `Bearer <token>`, where token is your auth token. If your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.

Path parameters

ClientIdstringRequired

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

WalletIdstringRequired

The unique identifier of the wallet.

VirtualAccountIdstringRequired

The unique identifier of the Virtual Account or legacy Banking Alias (the legacy BankingAliasId value can be used on this endpoint).

Request

This endpoint expects an object.

ActivebooleanOptional

Whether or not the Virtual Account is active.

Caution: Setting this value to false permanently closes the account and is irreversible.

Response

Success

AUobject

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.

CAobject

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.

DEobject

German Virtual Account with Country DE.

LocalAccountDetails.Account uses the IBAN format.

InternationalAccountDetails is populated if Capabilities.InternationalPayinAvailable is true.

DKobject

Danish Virtual Account with Country DK.

LocalAccountDetails.Account uses the DK-specific format (BankCode, AccountNumber).

InternationalAccountDetails is populated if Capabilities.InternationalPayinAvailable is true.

ESobject

Spanish Virtual Account with Country ES.

LocalAccountDetails.Account uses the IBAN format.

InternationalAccountDetails is populated if Capabilities.InternationalPayinAvailable is true.

FRobject

French Virtual Account with Country FR.

LocalAccountDetails.Account uses the IBAN format.

InternationalAccountDetails is populated if Capabilities.InternationalPayinAvailable is true.

GBobject

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.

LIobject

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.

LUobject

Luxembourg Virtual Account with Country LU.

LocalAccountDetails.Account uses the IBAN format.

InternationalAccountDetails is populated if Capabilities.InternationalPayinAvailable is true.

USobject

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.