Mangopay · Example Payload
Request Examples
PaymentsMarketplace PaymentsDigital WalletsKYCKYBFund TransfersCurrency ConversionPayment CardsFintechEuropean
Request Examples is an example object payload from Mangopay, with 1 top-level field. It illustrates the shape of data this provider's APIs accept or return.
Top-level fields
examples
Example Payload
{
"examples": [
{
"path": "/users/natural",
"method": "POST",
"summary": "Create a Natural User (Payer)",
"tags": [
"Users"
],
"example": {
"FirstName": "{{$randomFirstName}}",
"LastName": "{{$randomLastName}}",
"Email": "{{$randomEmail}}",
"Address": {
"AddressLine1": "{{$randomStreetAddress}}",
"AddressLine2": "{{$randomStreetName}}",
"City": "Paris",
"Region": "Ile-de-France",
"PostalCode": "75001",
"Country": "FR"
},
"UserCategory": "PAYER",
"TermsAndConditionsAccepted": false,
"Tag": "Created using Mangopay API Postman Collection"
}
},
{
"path": "/users/natural/{userId}",
"method": "PUT",
"summary": "Update a Natural User (Owner)",
"tags": [
"Users"
],
"example": {
"FirstName": "{{$randomFirstName}}",
"LastName": "{{$randomLastName}}",
"Email": "{{$randomEmail}}",
"Address": {
"AddressLine1": "{{$randomStreetAddress}}",
"AddressLine2": "{{$randomStreetName}}",
"City": "Paris",
"Region": "Ile-de-France",
"PostalCode": "75001",
"Country": "FR"
},
"Birthday": 652117514,
"CountryOfResidence": "FR",
"Nationality": "FR",
"UserCategory": "OWNER",
"TermsAndConditionsAccepted": true,
"Tag": "Created using Mangopay API Postman Collection"
}
},
{
"path": "/wallets",
"method": "POST",
"summary": "Create a Wallet",
"tags": [
"Wallets"
],
"example": {
"Owners": [
"{{USER_ID}}"
],
"Description": "Description of the user's wallet",
"Currency": "{{CURRENCY}}",
"Tag": "Created using Mangopay API Postman Collection"
}
},
{
"path": "/wallets/{walletId}",
"method": "PUT",
"summary": "Update a Wallet",
"tags": [
"Wallets"
],
"example": {
"Description": "Description of the user's wallet",
"Tag": "Created using Mangopay API Postman Collection"
}
},
{
"path": "/wallets/{usernaturalpayerwalletid}",
"method": "PUT",
"summary": "Update a Wallet (Natural Payer User)",
"tags": [
"Wallets"
],
"example": {
"Description": "Description of the user's wallet",
"Tag": "Created using Mangopay API Postman Collection"
}
},
{
"path": "/wallets/{usernaturalownerwalletid}",
"method": "PUT",
"summary": "Update a Wallet (Natural Owner User)",
"tags": [
"Wallets"
],
"example": {
"Description": "Description of the user's wallet",
"Tag": "Created using Mangopay API Postman Collection"
}
},
{
"path": "/wallets/{userlegalownerwalletid}",
"method": "PUT",
"summary": "Update a Wallet (Legal Owner User)",
"tags": [
"Wallets"
],
"example": {
"Description": "Description of the user's wallet",
"Tag": "Created using Mangopay API Postman Collection"
}
},
{
"path": "/cardregistrations",
"method": "POST",
"summary": "Create a Card Registration",
"tags": [
"Payment methods"
],
"example": {
"UserId": "{{USER_NATURAL_PAYER}}",
"Currency": "{{CURRENCY}}",
"CardType": "CB_VISA_MASTERCARD"
}
},
{
"path": "/cardregistrations/{cardregistrationid}",
"method": "PUT",
"summary": "Update a Card Registration",
"tags": [
"Payment methods"
],
"example": {
"RegistrationData": "{{REGISTRATION_DATA_KEY}}"
}
},
{
"path": "/cards/{cardchallengeflowid}",
"method": "PUT",
"summary": "Deactivate a card",
"tags": [
"Payment methods"
],
"example": {
"Active": false
}
},
{
"path": "/cards/{cardchallengeflowid}/validation",
"method": "POST",
"summary": "Create a Card Validation",
"tags": [
"Payment methods"
],
"example": {
"AuthorId": "{{USER_NATURAL_PAYER}}",
"SecureModeReturnURL": "https://mangopay.com/docs/please-ignore",
"IpAddress": "{{$randomIPV6}}",
"Tag": "Created using the Mangopay API Postman collection",
"BrowserInfo": {
"AcceptHeader": "application/json,text/javascript,*/*;q=0.01<",
"JavaEnabled": true,
"Language": "fr",
"ColorDepth": 32,
"ScreenHeight": 667,
"ScreenWidth": 375,
"TimeZoneOffset": "-120",
"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
}
}
},
{
"path": "/payins/card/direct",
"method": "POST",
"summary": "Create a Card Direct PayIn",
"tags": [
"Payment methods"
],
"example": {
"AuthorId": "{{USER_NATURAL_PAYER}}",
"CreditedUserId": "{{USER_NATURAL_PAYER}}",
"CreditedWalletId": "{{USER_NATURAL_PAYER_WALLET_ID}}",
"DebitedFunds": {
"Currency": "{{CURRENCY}}",
"Amount": 10
},
"Fees": {
"Currency": "{{CURRENCY}}",
"Amount": 0
},
"SecureModeReturnURL": "https://mangopay.com/docs/please-ignore",
"CardId": "{{CARD_CHALLENGE_FLOW_ID}}",
"StatementDescriptor": "Mangopay",
"Billing": {
"FirstName": "{{$randomFirstName}}",
"LastName": "{{$randomLastName}}",
"Address": {
"AddressLine1": "{{$randomStreetAddress}}",
"AddressLine2": "{{$randomStreetName}}",
"City": "Paris",
"Region": "Ile-de-France",
"PostalCode": "75001",
"Country": "FR"
}
},
"Shipping": {
"FirstName": "{{$randomFirstName}}",
"LastName": "{{$randomLastName}}",
"Address": {
"AddressLine1": "{{$randomStreetAddress}}",
"AddressLine2": "{{$randomStreetName}}",
"City": "Paris",
"Region": "Ile-de-France",
"PostalCode": "75001",
"Country": "FR"
}
},
"Tag": "Created using Mangopay API Postman Collection",
"Culture": "{{CULTURE}}",
"IpAddress": "{{$randomIPV6}}",
"BrowserInfo": {
"AcceptHeader": "text/html, application/xhtml+xml, application/xml;q=0.9, /;q=0.8",
"JavaEnabled": true,
"Language": "FR-FR",
"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
}
}
},
{
"path": "/recurringpayinregistrations/{recurringpayinregistrationid}",
"method": "PUT",
"summary": "Update a Recurring PayIn Registration",
"tags": [
"Payment methods"
],
"example": {
"CardId": "{{CARD_CHALLENGE_FLOW_ID}}",
"Status": "ENDED",
"Billing": {
"FirstName": "{{$randomFirstName}}",
"LastName": "{{$randomLastName}}",
"Address": {
"AddressLine1": "{{$randomStreetAddress}}",
"AddressLine2": "{{$randomStreetName}}",
"City": "Paris",
"Region": "Ile-de-France",
"PostalCode": "75001",
"Country": "FR"
}
},
"Shipping": {
"FirstName": "{{$randomFirstName}}",
"LastName": "{{$randomLastName}}",
"Address": {
"AddressLine1": "{{$randomStreetAddress}}",
"AddressLine2": "{{$randomStreetName}}",
"City": "Paris",
"Region": "Ile-de-France",
"PostalCode": "75001",
"Country": "FR"
}
}
}
},
{
"path": "/payins/recurring/card/direct",
"method": "POST",
"summary": "Create a Recurring PayIn CIT",
"tags": [
"Payment methods"
],
"example": {
"RecurringPayinRegistrationId": "{{RECURRING_PAYIN_REGISTRATION_ID}}",
"IpAddress": "{{$randomIPV6}}",
"BrowserInfo": {
"AcceptHeader": "text/html, application/xhtml+xml, application/xml;q=0.9, /;q=0.8",
"JavaEnabled": true,
"Language": "FR-FR",
"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
},
"SecureModeReturnURL": "https://mangopay.com/docs/please-ignore",
"StatementDescriptor": "POSTMAN",
"Tag": "Created using Mangopay API Postman Collection",
"DebitedFunds": {
"Currency": "{{CURRENCY}}",
"Amount": 10000
},
"Fees": {
"Currency": "{{CURRENCY}}",
"Amount": 1000
}
}
},
{
"path": "/payins/preauthorized/direct",
"method": "POST",
"summary": "Create a Preauthorized PayIn",
"tags": [
"Payment methods"
],
"example": {
"CreditedWalletId": "{{USER_NATURAL_PAYER_WALLET_ID}}",
"DebitedFunds": {
"Currency": "{{CURRENCY}}",
"Amount": 10000
},
"Fees": {
"Currency": "{{CURRENCY}}",
"Amount": 1000
},
"PreauthorizationId": "{{PREAUTHORIZATION_ID}}"
}
},
{
"path": "/deposit-preauthorizations/card/direct",
"method": "POST",
"summary": "Create a Deposit Preauthorization",
"tags": [
"Payment methods"
],
"example": {
"AuthorId": "{{USER_NATURAL_PAYER}}",
"DebitedFunds": {
"Currency": "{{CURRENCY}}",
"Amount": 20000
},
"CardId": "{{CARD_CHALLENGE_FLOW_ID}}",
"SecureModeReturnURL": "https://mangopay.com/docs/please-ignore",
"Culture": "{{CULTURE}}",
"IpAddress": "{{$randomIPV6}}",
"BrowserInfo": {
"AcceptHeader": "text/html, application/xhtml+xml, application/xml;q=0.9, /;q=0.8",
"JavaEnabled": true,
"Language": "FR-FR",
"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
},
"Tag": "Created using the Mangopay API Postman collection"
}
},
{
"path": "/deposit-preauthorizations/{depositid}",
"method": "PUT",
"summary": "Cancel a Deposit Preauthorization",
"tags": [
"Payment methods"
],
"example": {
"PaymentStatus": "CANCELED"
}
},
{
"path": "/payins/deposit-preauthorized/direct/full-capture",
"method": "POST",
"summary": "Create a Deposit Preauthorized PayIn",
"tags": [
"Payment methods"
],
"example": {
"AuthorId": "{{USER_NATURAL_PAYER}}",
"CreditedWalletId": "{{USER_NATURAL_PAYER_WALLET_ID}}",
"DebitedFunds": {
"Currency": "{{CURRENCY}}",
"Amount": 10000
},
"Fees": {
"Currency": "{{CURRENCY}}",
"Amount": 1000
},
"DepositId": "{{DEPOSIT_ID}}",
"Tag": "Created using Mangopay API Postman Collection"
}
},
{
"path": "/payins/card/web",
"method": "POST",
"summary": "Create a Web Card PayIn",
"tags": [
"Payment methods"
],
"example": {
"Tag": "Created using Mangopay API Postman Collection",
"AuthorId": "{{USER_NATURAL_PAYER}}",
"DebitedFunds": {
"Currency": "{{CURRENCY}}",
"Amount": 12000
},
"Fees": {
"Currency": "{{CURRENCY}}",
"Amount": 1000
},
"ReturnURL": "https://mangopay.com/docs/please-ignore",
"CardType": "CB_VISA_MASTERCARD",
"CreditedWalletId": "{{USER_NATURAL_PAYER_WALLET_ID}}",
"Culture": "{{CULTURE}}"
}
},
{
"path": "/wallets/{usernaturalpayerwalletid}/virtual-accounts/{virtualaccountid}",
"method": "PUT",
"summary": "Deactivate a Virtual Account",
"tags": [
"Payment methods"
],
"example": {
"Active": false
}
},
{
"path": "/wallets/{userlegalownerwalletid}/bankingaliases/iban",
"method": "POST",
"summary": "Create an IBAN Banking Alias",
"tags": [
"Payment methods"
],
"example": {
"OwnerName": "Alex Smith",
"Country": "LU",
"Tag": "Created using Mangopay API Postman Collection"
}
},
{
"path": "/bankingaliases/{bankingaliasid}",
"method": "PUT",
"summary": "Deactivate a Banking Alias",
"tags": [
"Payment methods"
],
"example": {
"Active": false
}
},
{
"path": "/payins/bankwire/direct",
"method": "POST",
"summary": "Create a Direct Bank Wire PayIn",
"tags": [
"Payment methods"
],
"example": {
"AuthorId": "{{USER_LEGAL_OWNER}}",
"CreditedUserId": "{{USER_LEGAL_OWNER}}",
"CreditedWalletId": "{{USER_LEGAL_OWNER_WALLET_ID}}",
"DeclaredDebitedFunds": {
"Currency": "{{CURRENCY}}",
"Amount": 1200
},
"DeclaredFees": {
"Currency": "{{CURRENCY}}",
"Amount": 12
},
"Tag": "Created using Mangopay API Postman Collection"
}
},
{
"path": "/payins/directdebit/direct",
"method": "POST",
"summary": "Create a Direct Debit PayIn (Legal Payer User)",
"tags": [
"Payment methods"
],
"example": {
"AuthorId": "{{USER_LEGAL_PAYER}}",
"CreditedWalletId": "{{USER_LEGAL_PAYER_WALLET_ID}}",
"DebitedFunds": {
"Currency": "{{CURRENCY}}",
"Amount": 1000
},
"Fees": {
"Currency": "{{CURRENCY}}",
"Amount": 0
},
"Tag": "Created using Mangopay API Postman Collection",
"MandateId": "{{MANDATE_ID}}",
"StatementDescriptor": "PlatformName"
}
},
{
"path": "/payins/payment-methods/bancontact",
"method": "POST",
"summary": "Create a Bancontact PayIn",
"tags": [
"Payment methods"
],
"example": {
"AuthorId": "{{USER_NATURAL_PAYER}}",
"DebitedFunds": {
"Currency": "EUR",
"Amount": 1627
},
"Fees": {
"Currency": "EUR",
"Amount": 163
},
"ReturnURL": "https://www.mangopay.com/docs/please-ignore",
"CreditedWalletId": "{{USER_NATURAL_PAYER_WALLET_ID}}",
"Culture": "EN",
"StatementDescriptor": "Example123",
"Tag": "Created using the Mangopay API Postman collection",
"Recurring": false
}
},
{
"path": "/payins/payment-methods/blik",
"method": "POST",
"summary": "Create a BLIK PayIn",
"tags": [
"Payment methods"
],
"example": {
"AuthorId": "{{USER_NATURAL_PAYER}}",
"CreditedWalletId": "{{USER_NATURAL_PAYER_WALLET_ID_PLN}}",
"DebitedFunds": {
"Currency": "PLN",
"Amount": 1000
},
"Fees": {
"Currency": "PLN",
"Amount": 0
},
"ReturnURL": "https://www.mangopay.com/docs/please-ignore",
"Tag": "Created using the Mangopay API Postman collection",
"StatementDescriptor": "Mangopay"
}
},
{
"path": "/payins/payment-methods/ideal",
"method": "POST",
"summary": "Create an iDEAL PayIn",
"tags": [
"Payment methods"
],
"example": {
"AuthorId": "{{USER_NATURAL_PAYER}}",
"CreditedWalletId": "{{USER_NATURAL_PAYER_WALLET_ID}}",
"DebitedFunds": {
"Currency": "{{CURRENCY}}",
"Amount": 2000
},
"Fees": {
"Currency": "{{CURRENCY}}",
"Amount": 0
},
"ReturnURL": "http://www.mangopay.com/docs/please-ignore",
"Tag": "Created using the Mangopay API Postman collection",
"StatementDescriptor": "Mangopay",
"Bic": "INGBNL2A"
}
},
{
"path": "/payins/payment-methods/klarna",
"method": "POST",
"summary": "Create a Klarna PayIn",
"tags": [
"Payment methods"
],
"example": {
"Tag": "Created using the Mangopay API Postman collection",
"AuthorId": "{{USER_NATURAL_PAYER}}",
"DebitedFunds": {
"Currency": "EUR",
"Amount": 1500
},
"Fees": {
"Currency": "EUR",
"Amount": 300
},
"CreditedWalletId": "{{USER_NATURAL_PAYER_WALLET_ID}}",
"ReturnURL": "http://www.mangopay.com/docs/please-ignore",
"StatementDescriptor": "Mangopay",
"Billing": {
"FirstName": "{{$randomFirstName}}",
"LastName": "{{$randomLastName}}",
"Address": {
"AddressLine1": "6 rue de la Cit\u00e9",
"AddressLine2": "Appartement 3",
"City": "Paris",
"Region": "\u00eele-de-france",
"PostalCode": "75003",
"Country": "FR"
}
},
"Shipping": {
"FirstName": "{{$randomFirstName}}",
"LastName": "{{$randomLastName}}",
"Address": {
"AddressLine1": "Rue de la Fourche 26",
"AddressLine2": "Appartement 3",
"City": "Bruxelles",
"Region": "Bruxelles-Capitale",
"PostalCode": "75003",
"Country": "BE"
}
},
"LineItems": [
{
"Name": "Running shoes",
"Quantity": 2,
"UnitAmount": 400,
"TaxAmount": 100,
"Description": "ID of Seller 1"
},
{
"Name": "Walking shoes",
"Quantity": 1,
"UnitAmount": 400,
"TaxAmount": 100,
"Description": "ID of Seller 2"
}
],
"Country": "FR",
"Culture": "FR",
"Email": "alex.smith@example.com",
"Phone": "[+33][689854321]",
"AdditionalData": "{\"customer_account_info\": [{\"unique_account_identifier\": \"382f5a69-c51c-45af-9707-6991eb08f7bf\",\"app_id\": \"81363501-3540-494a-8627-33bc6112035d\",\"loyalty_level\": \"high\",\"customer_email\": \"customer@email.com\",\"customer_phone\": \"0611223344\",\"customer_ranking\": 2,\"customer_reviews\": 5,\"last_login_time\": \"2023-10-21T19:11:34Z\",\"account_security\": {\"last_verification_method\": \"2FA TOTP\",\"last_verification_time\": \"2023-10-21T19:11:34Z\",\"device_id\": \"772af5a5-2d55-4a5e-bb79-85969f683810\",\"fraud_behavior\": false,\"devices_linked\": 2,\"phone_verified\": true,\"email_verified\": true,\"failed_transactions_attempts\": 0},\"account_registration_date\": \"2020-06-10T12:02:21Z\",\"account_last_modified\": \"2022-12-22T18:45:44Z\"}],\"marketplace_seller_info\": [{\"sub_merchant_id\": \"615a0e87-4941-45dc-978d-e6efcbd90ba0\",\"sub_merchant_name\": \"Marketbrick Ltd.\",\"sub_merchant_postal_code\": \"75010\",\"product_category\": \"Computers\",\"product_name\": \"Asus Zenbook 14\",\"account_registration_date\": \"2020-06-10T12:02:21Z\",\"account_last_modified\": {\"password\": \"2020-06-10T12:02:21Z\",\"email\": \"2020-06-10T12:02:21Z\",\"listing\": \"2020-06-10T12:02:21Z\",\"login\": \"2020-06-10T12:02:21Z\",\"address\": \"2020-06-10T12:02:21Z\"},\"digital_download\": false,\"seller_rating\": 4.5,\"number_of_trades\": 34,\"volume_of_trades\": 4500}],\"payment_history_full\": [{\"unique_account_identifier\": \"382f5a69-c51c-45af-9707-6991eb08f7bf\",\"number_paid_purchases\": 10,\"payment_option\": \"card\",\"total_amount_paid_purchases\": 1000.10,\"date_of_first_paid_purchase\": \"2020-06-10T12:12:34Z\",\"date_of_last_paid_purchase\": \"2023-10-26T18:52:38Z\"},{\"unique_account_identifier\": \"382f5a69-c51c-45af-9707-6991eb08f7bf\",\"number_paid_purchases\": 14,\"payment_option\": \"non klarna credit\",\"total_amount_paid_purchases\": 2322.10,\"date_of_first_paid_purchase\": \"2021-10-11T20:31:15Z\",\"date_of_last_paid_purchase\": \"2023-09-22T14:59:22Z\"}],\"marketplace_winner_info\": [{\"account_registration_date\": \"2020-06-10T12:02:21Z\",\"account_last_modified\": {\"password\": \"2022-12-22T18:45:44Z\",\"email\": \"2020-06-10T12:02:21Z\",\"listing\": \"2023-08-14T08:23:34Z\",\"login\": \"2020-06-10T12:02:21Z\",\"address\": \"2020-06-10T12:02:21Z\"},\"number_of_trades\": 24,\"volume_of_trades\": 3322}],\"other_delivery_address\": [{\"shipping_method\": \"pick-up point\",\"shipping_type\": \"express\",\"first_name\": \"Test\",\"last_name\": \"Person\",\"street_address\": \"Rue La Fayette\",\"street_number\": \"33\",\"postal_code\": \"75009\",\"city\": \"Paris\",\"country\": \"FR\"}]}",
"Reference": "Example1234"
}
},
{
"path": "/payins/payment-methods/multibanco",
"method": "POST",
"summary": "Create a Multibanco PayIn",
"tags": [
"Payment methods"
],
"example": {
"AuthorId": "{{USER_NATURAL_PAYER}}",
"DebitedFunds": {
"Currency": "EUR",
"Amount": 1000
},
"Fees": {
"Currency": "EUR",
"Amount": 0
},
"CreditedWalletId": "{{USER_NATURAL_PAYER_WALLET_ID}}",
"StatementDescriptor": "Mangopay",
"Tag": "Created using the Mangopay API Postman collection",
"ReturnURL": "http://www.mangopay.com/docs/please-ignore"
}
},
{
"path": "/payins/payment-methods/payconiq",
"method": "POST",
"summary": "Create a Payconiq PayIn",
"tags": [
"Payment methods"
],
"example": {
"AuthorId": "{{USER_NATURAL_PAYER}}",
"CreditedWalletId": "{{USER_NATURAL_PAYER_WALLET_ID}}",
"DebitedFunds": {
"Currency": "EUR",
"Amount": 1000
},
"Fees": {
"Currency": "EUR",
"Amount": 0
},
"Country": "BE",
"StatementDescriptor": "Example123",
"Tag": "Created using the Mangopay API Postman collection",
"ReturnURL": "https://mangopay.com/docs/please-ignore"
}
},
{
"path": "/payins/payment-methods/paypal/data-collection",
"method": "POST",
"summary": "Submit risk data for PayPal PayIn",
"tags": [
"Payment methods"
],
"example": {
"sender_account_id": "A12345N343",
"sender_first_name": "Jane",
"sender_last_name": "Doe",
"sender_email": "jane.doe@example.com",
"sender_phone": "(0033) 678123456",
"sender_country_code": "FR",
"sender_create_date": "2012-12-09T19:14:55.277-0:00",
"sender_signup_ip": "10.220.90.20",
"sender_popularity_score": "high",
"receiver_account_id": "A12345N344",
"receiver_create_date": "2012-12-09T19:14:55.277-0:00",
"receiver_email": "jane@example.com",
"receiver_address_country_code": "FR",
"business_name": "Jane Ltd",
"recipient_popularity_score": "high",
"first_interaction_date": "2012-12-09T19:14:55.277-0:00",
"txn_count_total": "34",
"vertical": "Household goods",
"transaction_is_tangible": "0"
}
},
{
"path": "/payins/payment-methods/paypal/recurring",
"method": "POST",
"summary": "Create a Recurring PayPal PayIn (CIT)",
"tags": [
"Payment methods"
],
"example": {
"ReturnURL": "http://docs.mangopay.com/please-ignore",
"CancelURL": "http://example.com",
"LineItems": [
{
"Name": "Product A subscription package",
"Quantity": 1,
"UnitAmount": 5000,
"TaxAmount": 0,
"Description": "Seller 1 ID",
"Category": "PHYSICAL_GOODS"
},
{
"Name": "Product B subscription package",
"Quantity": 1,
"UnitAmount": 5000,
"TaxAmount": 0,
"Description": "Seller 2 ID",
"Category": "PHYSICAL_GOODS"
}
],
"Tag": "Created using the Mangopay API Postman collection",
"RecurringPayinRegistrationId": "{{RECURRING_PAYIN_REGISTRATION_ID}}",
"ShippingPreference": "SET_PROVIDED_ADDRESS",
"Reference": "{{$guid}}",
"StatementDescriptor": "Example123",
"DataCollectionId": "{{DATA_COLLECTION_ID}}"
}
},
{
"path": "/payins/payment-methods/paypal",
"method": "POST",
"summary": "Create a PayPal PayIn",
"tags": [
"Payment methods"
],
"example": {
"Tag": "Created using the Mangopay API Postman collection",
"AuthorId": "{{USER_NATURAL_PAYER}}",
"DebitedFunds": {
"Currency": "EUR",
"Amount": 1500
},
"Fees": {
"Currency": "EUR",
"Amount": 300
},
"CreditedWalletId": "{{USER_NATURAL_PAYER_WALLET_ID}}",
"ReturnURL": "http://docs.mangopay.com/please-ignore",
"StatementDescriptor": "Mangopay",
"Shipping": {
"FirstName": "{{$randomFirstName}}",
"LastName": "{{$randomLastName}}",
"Address": {
"AddressLine1": "{{$randomStreetAddress}}",
"AddressLine2": "{{$randomStreetName}}",
"City": "Paris",
"Region": "\u00eele-de-france",
"PostalCode": "75003",
"Country": "FR"
}
},
"LineItems": [
{
"Name": "Running shoes",
"Quantity": 2,
"UnitAmount": 400,
"TaxAmount": 100,
"Description": "ID of Seller 1",
"Category": "PHYSICAL_GOODS"
},
{
"Name": "Walking shoes",
"Quantity": 1,
"UnitAmount": 400,
"TaxAmount": 100,
"Description": "ID of Seller 2",
"Category": "PHYSICAL_GOODS"
}
],
"Culture": "{{CULTURE}}",
"ShippingPreference": "SET_PROVIDED_ADDRESS",
"Reference": "{{$guid}}",
"DataCollectionId": "{{DATA_COLLECTION_ID}}"
}
},
{
"path": "/payins/{paypalpayinid}/trackings",
"method": "PUT",
"summary": "Add tracking information to a PayPal PayIn",
"tags": [
"Payment methods"
],
"example": {
"TrackingNumber": "123456789",
"Carrier": "DHL",
"NotifyBuyer": true
}
},
{
"path": "/payins/payment-methods/satispay",
"method": "POST",
"summary": "Create a Satispay PayIn",
"tags": [
"Payment methods"
],
"example": {
"AuthorId": "{{USER_NATURAL_PAYER}}",
"CreditedWalletId": "{{USER_NATURAL_PAYER_WALLET_ID}}",
"DebitedFunds": {
"Currency": "{{CURRENCY}}",
"Amount": 1000
},
"Fees": {
"Currency": "{{CURRENCY}}",
"Amount": 0
},
"ReturnURL": "https://www.mangopay.com/docs/please-ignore",
"Tag": "Created using the Mangopay API Postman collection",
"StatementDescriptor": "Mangopay",
"Country": "FR"
}
},
{
"path": "{envurl}/v2.1/{clientId}/payins/payment-methods/swish",
"method": "POST",
"summary": "Create a Swish PayIn",
"tags": [
"Payment methods"
],
"example": {
"AuthorId": "{{USER_NATURAL_PAYER}}",
"CreditedWalletId": "{{USER_NATURAL_PAYER_WALLET_ID_SEK}}",
"DebitedFunds": {
"Currency": "SEK",
"Amount": 1728
},
"Fees": {
"Currency": "SEK",
"Amount": 173
},
"ReturnURL": "http://docs.mangopay.com/please-ignore",
"Tag": "Created using the Mangopay API Postman collection",
"StatementDescriptor": "Example123",
"PaymentFlow": "WEB"
}
},
{
"path": "/payins/payment-methods/twint",
"method": "POST",
"summary": "Create a Twint PayIn",
"tags": [
"Payment methods"
],
"example": {
"AuthorId": "{{USER_NATURAL_PAYER}}",
"CreditedWalletId": "{{USER_NATURAL_PAYER_WALLET_ID_CHF}}",
"DebitedFunds": {
"Currency": "CHF",
"Amount": 1267
},
"Fees": {
"Currency": "CHF",
"Amount": 372
},
"ReturnURL": "http://docs.mangopay.com/please-ignore",
"Tag": "Created using the Mangopay API Postman collection",
"StatementDescriptor": "Example123"
}
},
{
"path": "/transfers",
"method": "POST",
"summary": "Create a Transfer",
"tags": [
"Transfers"
],
"example": {
"AuthorId": "{{USER_NATURAL_PAYER}}",
"DebitedFunds": {
"Currency": "{{CURRENCY}}",
"Amount": 500
},
"Fees": {
"Currency": "{{CURRENCY}}",
"Amount": 10
},
"DebitedWalletId": "{{USER_NATURAL_PAYER_WALLET_ID}}",
"CreditedWalletId": "{{USER_NATURAL_OWNER_WALLET_ID}}",
"Tag": "Created using Mangopay API Postman Collection"
}
},
{
"path": "/users/data-formats/validation",
"method": "POST",
"summary": "Validate the format of User Data",
"tags": [
"User Data Format"
],
"example": {
"CompanyNumber": {
"CompanyNumber": "AB123456",
"CountryCode": "IT"
}
}
},
{
"path": "/users/{userId}/identity-verifications",
"method": "POST",
"summary": "Create an IDV Session",
"tags": [
"IDV Sessions (hosted KYC"
],
"example": {
"Tag": "Created using the Mangopay API Postman collection",
"ReturnUrl": "https://docs.mangopay.com/please-ignore"
}
},
{
"path": "/users/{userId}/kyc/documents/{kycdocumentid}/pages",
"method": "POST",
"summary": "Create a KYC Document Page",
"tags": [
"KYC Documents"
],
"example": {
"File": "iVBORw0KGgoAAAANSUhEUgAABJwAAAMACAYAAABhLX1qAAAMamlDQ1BJQ0MgUHJvZmlsZQAASImVVwdYU8kWnluSkJDQAhGQEnoTpFcpIbQIAtLBRkgCCSXGhKBiRxcVXLuIYkVXRRRdXQFZVMReFsXeF1RUlHVRF0VReRMS0GVf+d75vrnz58yZ/5Q7kzsDgGYvVyLJRbUAyBPnS+PCg5kpqWlM0jOAABKgABdA5fJkElZsbBSAMtj/Xd7fgtZQrjsquP45/l9Fhy+Q8QBAJkKcwZfx8iBuAgDfxJNI8wEgKvQW0/MlCjwfYl0pDBDitQqcpcR7FDhDiRsHbBLi2BBfBUCNyuVKswDQeAD1zAJeFuTR+Ayxs5gvEgOgOQriAJ6Qy4dYEfuovLypClwOsS20l0AM4wHeGd9xZv2NP2OIn8vNGsLKvAZELUQkk+RyZ/6fpfnfkpcrH/RhDRtVKI2IU+QPa3gnZ2qkAlMh7hJnRMcoag1xr4ivrDsAKEUoj0hU2qNGPBkb1g8wIHbmc0MiITaCOEycGx2l0mdkisI4EMPVgs4Q5XMSINaHeIlAFhqvstkmnRqn8oXWZkrZLJX+PFc64Ffh65E8J5Gl4n8rFHBU/JhGoTAhGWIKxJYFoqRoiDUgdpLlxEeqbMYUCtnRgzZSeZwifkuI4wTi8GAlP1aQKQ2LU9mX5MkG88W2CUWcaBU+lC9MiFDWBzvN4w7ED3PBrgrErMRBHoEsJWowF74gJFSZO/ZCIE6MV/H0SvKD45RzcYokN1Zlj5sLcsMVenOI3WUF8aq5eFI+XJxKfjxTkh+boIwTL8zmjo1VxoOvBFGADUIAE8hhywBTQTYQtXTVdcFfypEwwAVSkAUEwFGlGZyRPDAihs94UAj+gEgAZEPzggdGBaAA6r8MaZVPR5A5MFowMCMHPIM4D0SCXPhbPjBLPOQtCTyFGtE/vHNh48F4c2FTjP97/aD2m4YFNVEqjXzQI1Nz0JIYSgwhRhDDiHa4IR6A++FR8BkEmyvujfsM5vHNnvCM0Ep4TLhJaCPcnSIqkg6Lchxog/xhqlpkfF8L3BpyeuDBuD9kh8w4AzcEjrg79MPCA6FnD6hlq+JWVIU5jPtvGXz3NlR2ZGcySh5BDiLbDp+pYa/hMcSiqPX39VHGmjFUb/bQyHD/7O+qz4d95HBLbAl2GDuHncQuYI1YHWBiJ7B67DJ2TIGHVtfTgdU16C1uIJ4cyCP6hz+uyqeikjLnaudO58/KsXzBjHzFxmNPlcyUirKE+UwW/DoImBwxz2kU09XZ1RUAxbdG+ff1jjHwDUEYF7/pitwB8Kf09/c3ftNF1QFwpB1u/75vOptXAND0ADhfwJNLC5Q6XPEgwH8JTbjTDIAJsAC2MB9X4An8QBAIBWNBDEgAqWAyrLIQrnMpmA5mgwWgGJSClWAd2Ai2gh1gD9gPDoE60AhOgrPgErgKboL7cPV0gFegG7wHfQiCkBAaQkcMEFPECnFAXBFvJAAJRaKQOCQVSUeyEDEiR2YjC5FSZDWyEdmOVCE/I0eRk8gFpBW5i7Qjnchb5BOKoVRUFzVGrdHRqDfKQiPRBHQSmoVOQwvRRehytBytRPehtehJ9BJ6E21DX6E9GMDUMQZmhjli3hgbi8HSsExMis3FSrAyrBKrwRrge76OtWFd2EeciNNxJu4IV3AEnojz8Gn4XHwZvhHfg9fip/HreDvejX8l0AhGBAeCL4FDSCFkEaYTigllhF2EI4QzcC91EN4TiUQG0YboB
# --- truncated at 32 KB (316 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mangopay/refs/heads/main/examples/request-examples.json