title | description |
---|---|
Quickstart |
Learn, integrate, and stay tuned with Mangopay documentation |
import UserStatusResponse from '/snippets/response-parameters/UserStatusResponse.mdx'; import UserCategoryResponse from '/snippets/response-parameters/UserCategoryResponse.mdx'; import TermsAndConditionsAcceptedDateResponse from '/snippets/response-parameters/TermsAndConditionsAcceptedDateResponse.mdx'; import TermsAndConditionsAcceptedResponse from '/snippets/response-parameters/TermsAndConditionsAcceptedResponse.mdx'; import KYCLevelResponse from '/snippets/response-parameters/KYCLevelResponse.mdx'; import Email2Response from '/snippets/response-parameters/Email2Response.mdx'; import PersonTypeResponse from '/snippets/response-parameters/PersonTypeResponse.mdx'; import CreationDateResponse from '/snippets/response-parameters/CreationDateResponse.mdx'; import Tag2Response from '/snippets/response-parameters/Tag2Response.mdx'; import IdResponse from '/snippets/response-parameters/IdResponse.mdx'; import CapacityResponse from '/snippets/response-parameters/CapacityResponse.mdx'; import ProofOfAddressResponse from '/snippets/response-parameters/ProofOfAddressResponse.mdx'; import ProofOfIdentityResponse from '/snippets/response-parameters/ProofOfIdentityResponse.mdx'; import IncomeRangeResponse from '/snippets/response-parameters/IncomeRangeResponse.mdx'; import OccupationResponse from '/snippets/response-parameters/OccupationResponse.mdx'; import CountryOfResidenceResponse from '/snippets/response-parameters/CountryOfResidenceResponse.mdx'; import NationalityResponse from '/snippets/response-parameters/NationalityResponse.mdx'; import BirthdayResponse from '/snippets/response-parameters/BirthdayResponse.mdx'; import LastName1Response from '/snippets/response-parameters/LastName1Response.mdx'; import FirstName1Response from '/snippets/response-parameters/FirstName1Response.mdx'; import Address3Response from '/snippets/response-parameters/Address3Response.mdx'; import UserCategory from '/snippets/body-parameters/UserCategory.mdx'; import TermsAndConditionsAccepted from '/snippets/body-parameters/TermsAndConditionsAccepted.mdx'; import Email2 from '/snippets/body-parameters/Email2.mdx'; import Tag3 from '/snippets/body-parameters/Tag3.mdx'; import IncomeRange from '/snippets/body-parameters/IncomeRange.mdx'; import Occupation from '/snippets/body-parameters/Occupation.mdx'; import CountryOfResidence from '/snippets/body-parameters/CountryOfResidence.mdx'; import Nationality from '/snippets/body-parameters/Nationality.mdx'; import Birthday from '/snippets/body-parameters/Birthday.mdx';
import LastName1 from '/snippets/body-parameters/LastName1.mdx'; import FirstName1 from '/snippets/body-parameters/FirstName1.mdx'; import Address3 from '/snippets/body-parameters/Address3.mdx'; import CreationDate1Response from '/snippets/response-parameters/CreationDate1Response.mdx'; import Tag7Response from '/snippets/response-parameters/Tag7Response.mdx'; import FundsTypeResponse from '/snippets/response-parameters/FundsTypeResponse.mdx'; import Currency23Response from '/snippets/response-parameters/Currency23Response.mdx'; import BalanceResponse from '/snippets/response-parameters/BalanceResponse.mdx'; import OwnersResponse from '/snippets/response-parameters/OwnersResponse.mdx'; import Description1Response from '/snippets/response-parameters/Description1Response.mdx'; import Tag6 from '/snippets/body-parameters/Tag6.mdx'; import Currency21 from '/snippets/body-parameters/Currency21.mdx'; import Owners from '/snippets/body-parameters/Owners.mdx'; import Description1 from '/snippets/body-parameters/Description1.mdx';
import Status1Response from '/snippets/response-parameters/Status1Response.mdx'; import Currency2Response from '/snippets/response-parameters/Currency2Response.mdx'; import ResultMessageResponse from '/snippets/response-parameters/ResultMessageResponse.mdx'; import ResultCodeResponse from '/snippets/response-parameters/ResultCodeResponse.mdx'; import CardRegistrationURLResponse from '/snippets/response-parameters/CardRegistrationURLResponse.mdx'; import CardTypeResponse from '/snippets/response-parameters/CardTypeResponse.mdx'; import CardIdResponse from '/snippets/response-parameters/CardIdResponse.mdx'; import RegistrationDataResponse from '/snippets/response-parameters/RegistrationDataResponse.mdx'; import PreregistrationDataResponse from '/snippets/response-parameters/PreregistrationDataResponse.mdx'; import AccessKeyResponse from '/snippets/response-parameters/AccessKeyResponse.mdx'; import Tag1Response from '/snippets/response-parameters/Tag1Response.mdx'; import Id1Response from '/snippets/response-parameters/Id1Response.mdx'; import Currency2 from '/snippets/body-parameters/Currency2.mdx'; import CardType from '/snippets/body-parameters/CardType.mdx'; import UserId from '/snippets/body-parameters/UserId.mdx'; import Tag1 from '/snippets/body-parameters/Tag1.mdx';
import cardCvx from '/snippets/body-parameters/cardCvx.mdx'; import cardExpirationDate from '/snippets/body-parameters/cardExpirationDate.mdx'; import cardNumber from '/snippets/body-parameters/cardNumber.mdx'; import data from '/snippets/body-parameters/data.mdx'; import accessKeyRef from '/snippets/body-parameters/accessKeyRef.mdx';
import CardType1Response from '/snippets/response-parameters/CardType1Response.mdx'; import UserIdResponse from '/snippets/response-parameters/UserIdResponse.mdx'; import RegistrationData from '/snippets/body-parameters/RegistrationData.mdx'; import CardRegistrationId from '/snippets/path-parameters/CardRegistrationId.mdx';
import CardInfoResponse from '/snippets/response-parameters/CardInfoResponse.mdx'; import PreferredCardNetworkResponse from '/snippets/response-parameters/PreferredCardNetworkResponse.mdx'; import RecurringPayinRegistrationIdResponse from '/snippets/response-parameters/RecurringPayinRegistrationIdResponse.mdx'; import Applied3DSVersionResponse from '/snippets/response-parameters/Applied3DSVersionResponse.mdx'; import Requested3DSVersionResponse from '/snippets/response-parameters/Requested3DSVersionResponse.mdx'; import Shipping2Response from '/snippets/response-parameters/Shipping2Response.mdx'; import Billing1Response from '/snippets/response-parameters/Billing1Response.mdx'; import IpAddressResponse from '/snippets/response-parameters/IpAddressResponse.mdx'; import BrowserInfoResponse from '/snippets/response-parameters/BrowserInfoResponse.mdx'; import StatementDescriptorResponse from '/snippets/response-parameters/StatementDescriptorResponse.mdx'; import SecurityInfoResponse from '/snippets/response-parameters/SecurityInfoResponse.mdx'; import Culture6Response from '/snippets/response-parameters/Culture6Response.mdx'; import SecureModeNeededResponse from '/snippets/response-parameters/SecureModeNeededResponse.mdx'; import SecureModeRedirectURLResponse from '/snippets/response-parameters/SecureModeRedirectURLResponse.mdx'; import SecureModeReturnURLResponse from '/snippets/response-parameters/SecureModeReturnURLResponse.mdx'; import CardId1Response from '/snippets/response-parameters/CardId1Response.mdx'; import SecureModeResponse from '/snippets/response-parameters/SecureModeResponse.mdx'; import ExecutionTypeResponse from '/snippets/response-parameters/ExecutionTypeResponse.mdx'; import PaymentType2Response from '/snippets/response-parameters/PaymentType2Response.mdx'; import DebitedWalletId1Response from '/snippets/response-parameters/DebitedWalletId1Response.mdx'; import CreditedWalletIdResponse from '/snippets/response-parameters/CreditedWalletIdResponse.mdx'; import NatureResponse from '/snippets/response-parameters/NatureResponse.mdx'; import TypeResponse from '/snippets/response-parameters/TypeResponse.mdx'; import ExecutionDateResponse from '/snippets/response-parameters/ExecutionDateResponse.mdx'; import Status2Response from '/snippets/response-parameters/Status2Response.mdx'; import Fees12Response from '/snippets/response-parameters/Fees12Response.mdx'; import CreditedFunds9Response from '/snippets/response-parameters/CreditedFunds9Response.mdx'; import DebitedFunds11Response from '/snippets/response-parameters/DebitedFunds11Response.mdx'; import CreditedUserIdResponse from '/snippets/response-parameters/CreditedUserIdResponse.mdx'; import AuthorIdResponse from '/snippets/response-parameters/AuthorIdResponse.mdx'; import TagResponse from '/snippets/response-parameters/TagResponse.mdx'; import ProfilingAttemptReference from '/snippets/body-parameters/ProfilingAttemptReference.mdx'; import PreferredCardNetwork from '/snippets/body-parameters/PreferredCardNetwork.mdx'; import Shipping2 from '/snippets/body-parameters/Shipping2.mdx'; import Billing2 from '/snippets/body-parameters/Billing2.mdx'; import IpAddress from '/snippets/body-parameters/IpAddress.mdx'; import BrowserInfo from '/snippets/body-parameters/BrowserInfo.mdx'; import StatementDescriptor from '/snippets/body-parameters/StatementDescriptor.mdx'; import Culture3 from '/snippets/body-parameters/Culture3.mdx'; import SecureModeReturnURL from '/snippets/body-parameters/SecureModeReturnURL.mdx'; import CardId from '/snippets/body-parameters/CardId.mdx'; import SecureMode from '/snippets/body-parameters/SecureMode.mdx'; import CreditedWalletId from '/snippets/body-parameters/CreditedWalletId.mdx'; import Fees9 from '/snippets/body-parameters/Fees9.mdx'; import DebitedFunds9 from '/snippets/body-parameters/DebitedFunds9.mdx'; import CreditedUserId from '/snippets/body-parameters/CreditedUserId.mdx'; import AuthorId from '/snippets/body-parameters/AuthorId.mdx'; import Tag from '/snippets/body-parameters/Tag.mdx';
Looking to unlock your platform’s full potential through Mangopay’s rich features? Explore our docs! We provide you with all the knowledge and tools you need to successfully tailor your payment experience with the Mangopay API.
Try out processing a card payment with Mangopay.
Natural users categorized as Payers only need to provide the most basic information at their creation: - First and last name - Email - If they've accepted the terms and conditions - User category as Payer{
"Address": {
"AddressLine1": "54588 John Ports",
"AddressLine2": "Walter Village",
"City": "Paris",
"Region": "Ile-de-France",
"PostalCode": "75001",
"Country": "FR"
},
"FirstName": "Emil",
"LastName": "Klein",
"Tag":"Created using MANGOPAY API Collection Postman",
"Email":"[email protected]",
"TermsAndConditionsAccepted":true,
"UserCategory":"PAYER"
}
#### Body parameters
<Address3 />
<FirstName1 />
<LastName1 />
<Birthday />
<Nationality />
<CountryOfResidence />
<Occupation />
<IncomeRange />
<Tag3 />
<Email2 />
<TermsAndConditionsAccepted />
<UserCategory />
#### Response
<Address3Response />
<FirstName1Response />
<LastName1Response />
<BirthdayResponse />
<NationalityResponse />
<CountryOfResidenceResponse />
<OccupationResponse />
<IncomeRangeResponse />
<ProofOfIdentityResponse />
<ProofOfAddressResponse />
<CapacityResponse />
<IdResponse />
<Tag2Response />
<CreationDateResponse />
<PersonTypeResponse />
<Email2Response />
<KYCLevelResponse />
<TermsAndConditionsAcceptedResponse />
<TermsAndConditionsAcceptedDateResponse />
<UserCategoryResponse />
{
"Address": {
"AddressLine1": "54588 John Ports",
"AddressLine2": "Walter Village",
"City": "Paris",
"Region": "Ile-de-France",
"PostalCode": "75001",
"Country": "FR"
},
"FirstName": "Emil",
"LastName": "Klein",
"Birthday": null,
"Nationality": null,
"CountryOfResidence": null,
"Occupation": null,
"IncomeRange": null,
"ProofOfIdentity": null,
"ProofOfAddress": null,
"Capacity": "NORMAL",
"PhoneNumber": null,
"PhoneNumberCountry": null,
"OTPCodeSent": false,
"Id": "user_m_01HWAR82HD4D8CQ67J02YMKM82",
"Tag": "Created using Mangopay API Postman Collection",
"CreationDate": 1714052925,
"PersonType": "NATURAL",
"Email": "[email protected]",
"KYCLevel": "LIGHT",
"TermsAndConditionsAccepted": true,
"TermsAndConditionsAcceptedDate": 1714052925,
"UserCategory": "PAYER",
"UserStatus": "ACTIVE"
}
Create a wallet for your user to add funds into. While Mangopay authorizes you to create as many wallets as required, we recommend you create one wallet per user and currency.
{
"Owners": ["user_m_01HWAR82HD4D8CQ67J02YMKM82"],
"Description": "E-Money wallet",
"Currency": "EUR",
"Tag": "Created using Mangopay API Postman Collection"
}
{
"Description": "E-Money wallet",
"Owners": [
"user_m_01HWAR82HD4D8CQ67J02YMKM82"
],
"Balance": {
"Currency": "EUR",
"Amount": 0
},
"Currency": "EUR",
"FundsType": "DEFAULT",
"Id": "wlt_m_01HWAR863HPA3FAVEXA9J6JSYD",
"Tag": "Created using Mangopay API Postman Collection",
"CreationDate": 1714052929
}
You also need to define the currency and type of the card at this stage.
{
"UserId": "user_m_01HWAR82HD4D8CQ67J02YMKM82",
"Currency": "EUR",
"CardType": "CB_VISA_MASTERCARD"
}
{
"Id": "cardreg_m_01HWAR88VG9K1PVN6EH07ZHTHT",
"Tag": null,
"CreationDate": 1714052932,
"UserId": "user_m_01HWAR82HD4D8CQ67J02YMKM82",
"AccessKey": "1X0m87dmM2LiwFgxPLBJ",
"PreregistrationData": "S2mSVl8PLRVHgaMNATInMmVYAECTzrAc5dfWTT8a8IIJiWHX6X35gAS9zfOm2DJa2ddFLVXdicolcUIkv_kKEA",
"RegistrationData": null,
"CardId": null,
"CardType": "CB_VISA_MASTERCARD",
"CardRegistrationURL": "https://homologation-webpayment.payline.com/webpayment/getToken",
"ResultCode": null,
"ResultMessage": null,
"Currency": "EUR",
"Status": "CREATED"
}
From this response, you will need to save the following values for the next step:
-AccessKey
-PreregistrationData
-CardRegistrationURL
Make a request to the CardRegistrationURL
using the previously saved AccessKey
and PreregistrationData
, along with the end user’s card details.
- Use
AccessKey
data for theaccessKeyRef
parameter - Use
PreregistrationData
data for thedata
parameter
You also need the end user’s card details, entered on the payment page:TW please add the old table here
{
"accessKeyRef":“1X0m87dmM2LiwFgxPLBJ”,
"data":"Qi7oou23Q8d9B3xUpjdMufovK5Cn8mhCtZU6ugQCVb5mXDI2fx0ZVjcnYafUC4U-2ddFLVXdicolcUIkv_kKEA",
"cardNumber":"4972485830400072",
"cardExpirationDate":"0230",
"cardCvx":"123"
}
data=R7hxMYui4h4rBkaNwbiH1C52oyBEPsNQqJWhStf8lRp-qFm87Xjc6eMmalQEBwCL8iAjp5-yMYx2KX5HaewKbrR7SzblGS3JYA-uOAwvnl9GWCA1bf83AsB4aEx48yIyNx0xgKTVnyDj15oG8jR88g
{
"RegistrationData":"data=MUhJV3Pbg1o0ed3o7NNzhTvLnLINzl2C3kJ-jrUvumkNkAmXFAobbBbjtr2ApgdN4oyFyrjhOYh4mRfSMAG97UwoZ_Q54ht04Mp1_JJysuk44VTizvbz9Vsx6XcB6KD70ftIYwFxOdfmDQ5GtM_cIg"
}
<Id1Response />
<Tag1Response />
<CreationDateResponse />
<UserIdResponse />
<AccessKeyResponse />
<PreregistrationDataResponse />
<RegistrationDataResponse />
<CardIdResponse />
<CardType1Response />
<CardRegistrationURLResponse />
<ResultCodeResponse />
<ResultMessageResponse />
<Currency2Response />
<Status1Response />
{
"Id": "cardreg_m_01HWAR88VG9K1PVN6EH07ZHTHT",
"Tag": null,
"CreationDate": 1714052932,
"UserId": "user_m_01HWAR82HD4D8CQ67J02YMKM82",
"AccessKey": "1X0m87dmM2LiwFgxPLBJ",
"PreregistrationData": "S2mSVl8PLRVHgaMNATInMmVYAECTzrAc5dfWTT8a8IIJiWHX6X35gAS9zfOm2DJa2ddFLVXdicolcUIkv_kKEA",
"RegistrationData": "data=R7hxMYui4h4rBkaNwbiH1C52oyBEPsNQqJWhStf8lRp-qFm87Xjc6eMmalQEBwCL8iAjp5-yMYx2KX5HaewKbrR7SzblGS3JYA-uOAwvnl9GWCA1bf83AsB4aEx48yIyNx0xgKTVnyDj15oG8jR88g",
"CardId": "card_m_01HWAR8MKKS3MHN5W7KGRKT40Q",
"CardType": "CB_VISA_MASTERCARD",
"CardRegistrationURL": "https://homologation-webpayment.payline.com/webpayment/getToken",
"ResultCode": "000000",
"ResultMessage": "Success",
"Currency": "EUR",
"Status": "VALIDATED"
}
Don't forget to click on the link provided by SecureModeRedirectURL
parameter in the response
{
"AuthorId": "user_m_01HWAR82HD4D8CQ67J02YMKM82",
"CreditedUserId": "user_m_01HWAR82HD4D8CQ67J02YMKM82",
"CreditedWalletId": "wlt_m_01HWAR863HPA3FAVEXA9J6JSYD",
"DebitedFunds": {
"Currency": "EUR",
"Amount": 10000
},
"Fees": {
"Currency": "EUR",
"Amount": 1000
},
"SecureModeReturnURL": "https://mangopay.com/docs/please-ignore",
"CardId": "card_m_01HWAR8MKKS3MHN5W7KGRKT40Q",
"StatementDescriptor": "Mangopay",
"Billing": {
"FirstName": "Emil",
"LastName": "Klein",
"Address": {
"AddressLine1": "54588 John Ports",
"AddressLine2": "Walter Village",
"City": "Paris",
"Region": "Ile-de-France",
"PostalCode": "75001",
"Country": "FR"
}
},
"Shipping": {
"FirstName": "Emil",
"LastName": "Klein",
"Address": {
"AddressLine1": "54588 John Ports",
"AddressLine2": "Walter Village",
"City": "Paris",
"Region": "Ile-de-France",
"PostalCode": "75001",
"Country": "FR"
}
},
"Tag": "Created using Mangopay API Postman Collection",
"Culture": "EN",
"IpAddress": "bd11:9b7a:7b40:d5ba:5687:6952:81fb:9b04",
"BrowserInfo": {
"AcceptHeader": "text/html, application/xhtml+xml, application/xml;q=0.9, /;q=0.8",
"JavaEnabled": true,
"Language": "en",
"ColorDepth": 4,
"ScreenHeight": 1800,
"ScreenWidth": 400,
"TimeZoneOffset": 60,
"UserAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 13_6_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E148",
"JavascriptEnabled": true
}
}
{
"Id": "payin_m_01HWAR8SGASQJWBG9C55ZX9THJ",
"Tag": "Created using Mangopay API Postman Collection",
"CreationDate": 1714052950,
"AuthorId": "user_m_01HWAR82HD4D8CQ67J02YMKM82",
"CreditedUserId": "user_m_01HWAR82HD4D8CQ67J02YMKM82",
"DebitedFunds": {
"Currency": "EUR",
"Amount": 10000
},
"CreditedFunds": {
"Currency": "EUR",
"Amount": 9000
},
"Fees": {
"Currency": "EUR",
"Amount": 1000
},
"Status": "SUCCEEDED",
"ResultCode": "000000",
"ResultMessage": "Success",
"ExecutionDate": 1714052964,
"Type": "PAYIN",
"Nature": "REGULAR",
"CreditedWalletId": "wlt_m_01HWAR863HPA3FAVEXA9J6JSYD",
"DebitedWalletId": null,
"PaymentType": "CARD",
"ExecutionType": "DIRECT",
"SecureMode": "DEFAULT",
"CardId": "card_m_01HWAR8MKKS3MHN5W7KGRKT40Q",
"SecureModeReturnURL": "https://mangopay.com/docs/please-ignore?transactionId=payin_m_01HWAR8SGASQJWBG9C55ZX9THJ",
"SecureModeRedirectURL": null,
"SecureModeNeeded": true,
"Culture": "EN",
"SecurityInfo": {
"AVSResult": "NO_CHECK"
},
"StatementDescriptor": "Mangopay",
"BrowserInfo": {
"AcceptHeader": "text/html, application/xhtml+xml, application/xml;q=0.9, /;q=0.8",
"JavaEnabled": true,
"Language": "en",
"ColorDepth": 4,
"ScreenHeight": 1800,
"ScreenWidth": 400,
"TimeZoneOffset": 60,
"UserAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 13_6_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E148",
"JavascriptEnabled": true
},
"IpAddress": "bd11:9b7a:7b40:d5ba:5687:6952:81fb:9b04",
"Billing": {
"FirstName": "Alex",
"LastName": "Smith",
"Address": {
"AddressLine1": "6 rue de la Cité",
"AddressLine2": "Appartement 3",
"City": "Paris",
"Region": "Ile-de-France",
"PostalCode": "75001",
"Country": "FR"
}
},
"Shipping": {
"FirstName": "Alex",
"LastName": "Smith",
"Address": {
"AddressLine1": "6 rue de la Cité",
"AddressLine2": "Appartement 3",
"City": "Paris",
"Region": "Ile-de-France",
"PostalCode": "75001",
"Country": "FR"
}
},
"Requested3DSVersion": null,
"Applied3DSVersion": "V2_1",
"RecurringPayinRegistrationId": null,
"PreferredCardNetwork": null,
"PaymentCategory": "ECommerce",
"CardInfo": {
"BIN": "497010",
"IssuingBank": "LA BANQUE POSTALE",
"IssuerCountryCode": "MA",
"Type": "CREDIT",
"Brand": "VISA",
"SubType": null
}
}
Learn about everything you need to work with our API.
When it comes to payments compliance, your community is our responsibility. Mangopay's wallets hold the funds processed on behalf of platforms and their users. The payments your users expect. The flexibility your business needs. Mangopay provides foreign exchange (forex, FX) services within the Mangopay environment to enable platforms to convert funds between wallets of different currencies.Build your platform faster with the tools made available by Mangopay.
Sign up to the Hub to get access to the Mangopay Dashboard. Find everything you need to know about how the Mangopay API works. Mangopay provides a webhook feature to submit notifications to other applications whenever a specific event occurs. Ensuring safe and secure payments in an ever-changing regulatory environment is key to our journey together.Explore the server-side SDKs to integrate Mangopay in your preferred language.
3.17.0 - Mar 8, 2024 2.37.0 - Apr 2, 2024 1.42.1 - Feb 8, 2024 3.29.0 - Apr 2, 2024 3.32.0 - Feb 12, 2024 3.22.0 - Feb 8, 2024