Overview
User management
User verification
Wallets
Cards
Card pay-ins
Banking pay-ins
APM pay-ins
Transfers
Refunds
Disputes
Payouts
FX conversions
Transactions
Echo
Helpers
Platform account
Copy
// GET has no body parameters
Copy
[
{
"Id": "wltbank_m_01J7NCAT73Q15SVSM9S6Z36GRZ",
"Tag": "Created using Mangopay API Postman Collection",
"CreationDate": 1726220691,
"WalletId": "wlt_m_01J7NC9YKP3NB1PADF4SHZY712",
"VirtualAccountPurpose": "COLLECTION",
"Country": "GB",
"Status": "ACTIVE",
"Active": true,
"AccountOwner": "MGP PlatformTradingName",
"LocalAccountDetails": {
"Address": {
"StreetName": "2, Avenue Amélie",
"PostCode": "L-1125",
"TownName": "Luxembourg",
"CountrySubDivision": null,
"Country": "Luxembourg"
},
"Account": {
"SortCode": "608382",
"AccountNumber": "21762697"
}
},
"InternationalAccountDetails": [
{
"Address": {
"StreetName": "2, Avenue Amélie",
"PostCode": "L-1125",
"TownName": "Luxembourg",
"CountrySubDivision": null,
"Country": "Luxembourg"
},
"Account": {
"Iban": "GB62SAPY60838221762697",
"Bic": "SAPYGB2L"
}
}
],
"Capabilities": {
"LocalPayinAvailable": true,
"InternationalPayinAvailable": true,
"Currencies": [
"GBP"
]
},
"ResultCode": "000000",
"ResultMessage": "Success"
}
]
Virtual IBAN
List Virtual Accounts for a Wallet
GET
/
v2.01
/
{ClientId}
/
wallets
/
{WalletId}
/
virtual-accounts
Copy
// GET has no body parameters
Copy
[
{
"Id": "wltbank_m_01J7NCAT73Q15SVSM9S6Z36GRZ",
"Tag": "Created using Mangopay API Postman Collection",
"CreationDate": 1726220691,
"WalletId": "wlt_m_01J7NC9YKP3NB1PADF4SHZY712",
"VirtualAccountPurpose": "COLLECTION",
"Country": "GB",
"Status": "ACTIVE",
"Active": true,
"AccountOwner": "MGP PlatformTradingName",
"LocalAccountDetails": {
"Address": {
"StreetName": "2, Avenue Amélie",
"PostCode": "L-1125",
"TownName": "Luxembourg",
"CountrySubDivision": null,
"Country": "Luxembourg"
},
"Account": {
"SortCode": "608382",
"AccountNumber": "21762697"
}
},
"InternationalAccountDetails": [
{
"Address": {
"StreetName": "2, Avenue Amélie",
"PostCode": "L-1125",
"TownName": "Luxembourg",
"CountrySubDivision": null,
"Country": "Luxembourg"
},
"Account": {
"Iban": "GB62SAPY60838221762697",
"Bic": "SAPYGB2L"
}
}
],
"Capabilities": {
"LocalPayinAvailable": true,
"InternationalPayinAvailable": true,
"Currencies": [
"GBP"
]
},
"ResultCode": "000000",
"ResultMessage": "Success"
}
]
Path parameters
The unique identifier of the wallet.
Query parameters
Start value:
1Default value: 1Indicates the index of the page for the pagination.Min. value:
1; max. value: 100Default value: 10Indicates the number of items returned for each page of the pagination.Possible values:
CreationDate:ASC, CreationDate:DESCDefault value: CreationDate:ASCIndicates the direction in which to sort the list.Responses
200
200
The list of virtual accounts created by the platform.
Show properties
Show properties
The Virtual Account object created by the platform
Show properties
Show properties
Max length: 128 characters (see data formats for details)The unique identifier of the object.
Max. length: 255 charactersCustom data that you can add to this object.
The date and time at which the object was created.
The unique identifier of the wallet.
Returned values:
COLLECTION, USER_OWNEDThe 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.
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).PENDINGcan transition toACTIVEorFAILED.ACTIVE– The account is active and can receive funds (see note about delayed UK CoP recognition forGBaccounts).ACTIVEcan transition toBLOCKEDorCLOSED.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.BLOCKEDcan transition toACTIVEorCLOSED.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).
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:FirstNameLastNamefor Natural Users;Namefor 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.Show child attributes
Show child attributes
The address associated with the account.
Show child attributes
Show child attributes
Max. length: 255 charactersThe building number and street name of the address.
Max. length: 50 charactersThe postal code of the address.
Max. length: 255 charactersThe town or city of the address.
Max. length: 255 charactersThe region, state, or county of the address.
Format: Two-letter country code (ISO 3166-1 alpha-2 format)The country of the address.
Details of the account in local account identifier format.The properties of this object differ depending on the Virtual Account
Country:- IBAN – Format if
CountryisDK,DE,ES,FR,LU - GB – Format if
CountryisGB - US – Format if
CountryisUS - CA – Format if
CountryisCA
Account object’s properties and values dynamically.- IBAN
- GB
- US
- CA
The name of the bank.
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.Show child attributes
Show child attributes
The address associated with the account.
Show child attributes
Show child attributes
Max. length: 255 charactersThe building number and street name of the address.
Max. length: 50 charactersThe postal code of the address.
Max. length: 255 charactersThe town or city of the address.
Max. length: 255 charactersThe region, state, or county of the address.
Format: Two-letter country code (ISO 3166-1 alpha-2 format)The country of the address.
The name of the bank.
Information about the account’s payment capabilities.
Show child attributes
Show child attributes
Whether or not local bank wires can be made to this account.
Whether or not international bank wires can be made to this account.Returned
false if Country is US or CA.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.
ResultCode) are possible on a 200 response. Read more →
Copy
[
{
"Id": "wltbank_m_01J7NCAT73Q15SVSM9S6Z36GRZ",
"Tag": "Created using Mangopay API Postman Collection",
"CreationDate": 1726220691,
"WalletId": "wlt_m_01J7NC9YKP3NB1PADF4SHZY712",
"VirtualAccountPurpose": "COLLECTION",
"Country": "GB",
"Status": "ACTIVE",
"Active": true,
"AccountOwner": "MGP PlatformTradingName",
"LocalAccountDetails": {
"Address": {
"StreetName": "2, Avenue Amélie",
"PostCode": "L-1125",
"TownName": "Luxembourg",
"CountrySubDivision": null,
"Country": "Luxembourg"
},
"Account": {
"SortCode": "608382",
"AccountNumber": "21762697"
}
},
"InternationalAccountDetails": [
{
"Address": {
"StreetName": "2, Avenue Amélie",
"PostCode": "L-1125",
"TownName": "Luxembourg",
"CountrySubDivision": null,
"Country": "Luxembourg"
},
"Account": {
"Iban": "GB62SAPY60838221762697",
"Bic": "SAPYGB2L"
}
}
],
"Capabilities": {
"LocalPayinAvailable": true,
"InternationalPayinAvailable": true,
"Currencies": [
"GBP"
]
},
"ResultCode": "000000",
"ResultMessage": "Success"
}
]
Copy
// GET has no body parameters
Was this page helpful?
⌘I