Mangopay docs

Product guides and API reference for Mangopay's wallet-first payment infrastructure

Docs

• The API Response object
• View an API Response
• The Apple Pay PayIn object
• Create an Apple Pay PayIn
• View a PayIn (Apple Pay)
• The Bancontact PayIn object
• Create a Bancontact PayIn
• View a PayIn (Bancontact)
• The Bank Account object
• Create a CA Bank Account
• Create a GB Bank Account
• Create an IBAN Bank Account
• Create an OTHER Bank Account
• Create a US Bank Account
• Deactivate a Bank Account
• List Bank Accounts for a User
• View a Bank Account
• The Bank Wire PayIn object
• Create a Bank Wire PayIn
• View a PayIn (Bank Wire)
• The Banking Alias object
• Create an IBAN Banking Alias
• Deactivate a Banking Alias
• View a Banking Alias
• View a Banking Alias for a Wallet
• The Bizum PayIn object
• Create a Bizum PayIn
• View a PayIn (Bizum)
• The BLIK PayIn object
• Create a BLIK PayIn (with code)
• Create a BLIK PayIn (without code)
• View a PayIn (BLIK)
• The Card Registration object: Register card details to obtain a CardId token for one-time, recurring, or preauthorized card payments
• Create a Card Registration
• Tokenize the card
• Update a Card Registration
• View a Card Registration
• The Card Validation object
• Create a Card Validation
• View a Card Validation
• The Card object
• Deactivate or edit a Card
• List Cards for a Fingerprint
• List Cards for a User
• View a Card
• The Client Wallet object
• List all Client Wallets
• List Client Wallets by FundsType
• View a Client Wallet
• The Client object
• Update a Client: Modify details about your platform registered with Mangopay
• Upload a Client logo
• View a Client: Retrieve details about your platform registered with Mangopay
• The Conversion Rate object (FX)
• View an indicative Conversion Rate
• The Conversion object (FX)
• Create an Instant Conversion between Client Wallets
• Create an Instant Conversion between user Wallets
• Create a Quoted Conversion between Client Wallets
• Create a Quoted Conversion between user Wallets
• View a Conversion
• The Country Authorizations object
• List Authorizations for all countries
• View Authorizations for a country
• Cancel a Deposit Preauthorization
• Create a Deposit Preauthorized PayIn
• Create a PayPal Deposit Preauthorization
• The Deposit Preauthorization object
• The Deposit Preauthorized PayIn object
• List Deposit Preauthorizations for a Card
• List Deposit Preauthorizations for a User
• View a Deposit Preauthorization (Card, PayPal)
• View a PayIn (Deposit Preauthorized Card)
• Create a Direct Card PayIn: Process a one-time payment with a CardId, obtained from the card registration process
• The Direct Card PayIn object: One-time payment using a tokenized card
• View a PayIn (Direct Card)
• Create a Direct Debit PayIn
• The Direct Debit PayIn object
• View a PayIn (Direct Debit)
• Create a Dispute Document
• Create a Dispute Document Page
• Create a weblink to view the Pages of a Dispute Document
• The Dispute Document object
• List all Dispute Documents
• List Documents for a Dispute
• Submit a Dispute Document
• View a Dispute Document
• Create a Bank Wire PayIn to the Repudiation Wallet
• Create a Settlement Transfer
• The Settlement Transfer object
• View a Settlement Transfer
• Close a Dispute
• The Dispute object
• List all Disputes
• List Disputes for a PayIn
• List Disputes pending settlement
• List Disputes for a User
• List Disputes for a Wallet
• Submit a Dispute
• Update a Dispute
• View a Dispute
• Supported payment methods
• Supported providers
• The Event object
• List all Events
• [Deprecated] Create a Giropay PayIn
• [Deprecated] The Giropay PayIn object
• View a PayIn (Giropay)
• Create a Google Pay PayIn
• The Google Pay PayIn object
• View a PayIn (Google Pay)
• Create an iDEAL PayIn
• [Deprecated] Create a Web Card PayIn (iDEAL)
• The iDEAL PayIn object
• View a PayIn (iDEAL)
• Create an IDV Session: Initiate a hosted KYC/KYB session and obtain a unique URL for the hosted fronted experience
• The IDV Session object: Container for Mangopay's hosted KYC/KYB solution
• List IDV Sessions for a User: Retrieve key details of all hosted KYC/KYC sessions attempted for a user
• View an IDV Session: See details of a hosted KYC/KYB session, outcome of checks, and verified data
• Cancel an Intent: Cancel all or part of an authorized Intent
• Create an Intent: Declare a transaction authorization processed by a third-party PSP
• Create an Intent Capture: Declare the full or partial capture of an authorization processed by a third-party PSP
• Create an Intent Dispute: Declare the full or partial dispute of a payment processed by a third-party PSP
• Create an Intent Refund: Declare the full or partial refund of a payment processed by a third-party PSP
• Create an Intent Split: Create a transfer to the wallet of the seller of an Intent line item.
• Execute an Intent Split: Release the funds of a Split to the wallet of the seller of the Intent line item.
• The Intent object
• Reverse an Intent Refund: Declare the reversal of a refund processed by a third-party PSP
• Reverse an Intent Split: Cancel an unexecuted Split
• Update an Intent Dispute: Track the outcome of a dispute processed by a third-party PSP
• Update an Intent Split: Modify a Split before execution.
• View an Intent: Retrieve the declaration of a transaction processed by a third-party PSP
• View an Intent Split: Retrieve details of a Split of an Intent.
• Create a Klarna PayIn
• The Klarna PayIn object
• View a PayIn (Klarna)
• Create a KYC Document: Create a container for files to be submitted
• Create a KYC Document Page: Upload a file to the KYC Document object
• The KYC Document object
• List all KYC Documents
• List KYC Documents for a User
• Submit a KYC Document
• View a KYC Document
• Cancel a Mandate
• Create a Mandate
• List all Mandates
• List Mandates for a Bank Account
• List Mandates for a User
• The Mandate object
• View a Mandate
• Create an MB WAY PayIn
• The MB WAY PayIn object
• View a PayIn (MB WAY)
• Create an Multibanco PayIn
• The Multibanco PayIn object
• View a PayIn (Multibanco)
• Managing API keys
• Permission scopes
• Authentication
• Create an access token for Checkout SDK features: Generate an access token to initialize the Checkout SDK to provide PayPal One-Click
• Create an access token for the Recipients embedded experience: Generate an access token to run the Recipients embedded experience using Mangopay Elements
• Create OAuth bearer token: Generate an OAuth bearer token to authenticate your API calls
• Data availability periods
• Data formats
• Filtering and sorting
• Idempotency
• Introduction
• Pagination
• Rate limiting
• Create a Pay by Bank PayIn
• The Pay by Bank PayIn object
• View a PayIn (Pay by Bank)
• View supported banks for Pay by Bank: Retrieve supported banks to present to a user for Pay by Bank pay-ins
• Create a Payconiq PayIn
• The Payconiq PayIn object
• View a PayIn (Payconiq)
• Look up metadata for a payment method
• The Payment Method Metadata object
• Check Instant Payout eligibility
• Create a Payout
• The Payout object
• View a Payout
• View a Payout and check mode applied
• Add tracking information to a PayPal PayIn
• Create a PayPal PayIn
• [Deprecated] Create a PayPal PayIn
• Create a Recurring PayPal PayIn (CIT)
• Create a Recurring PayPal PayIn (MIT)
• The PayPal PayIn object
• The Recurring PayPal PayIn object
• Submit data for a PayPal PayIn: Provide transaction data to PayPal prior to initiating a pay-in
• View data submitted for a PayPal PayIn: Retrieve pre-transaction data submitted previously
• View a PayIn (PayPal)
• Cancel or validate a Preauthorization
• Create a Preauthorization
• Create a Preauthorized PayIn
• List Preauthorizations for a Card
• List Preauthorizations for a User
• The Preauthorization object
• The Preauthorized PayIn object
• View a PayIn (Preauthorized Card)
• View a Preauthorization
• Create a Quote
• The Quote object (Guaranteed FX)
• View a Quote
• Create a Recipient: Register a bank account for local or international payouts
• Deactivate a Recipient: Permanently disable a Recipient
• List Recipients for a User: List recipients created for a UserId
• The Recipient object
• Validate data for a Recipient: Check that the user's Recipient data is valid before creation
• View payout methods: See payout methods available to your platform by currency and country
• View a Recipient: Fetch a Recipient or legacy Bank Account based on its ID
• View the schema for a Recipient: Fetch the data requirements for a given currency, payout method type, and recipient type
• Create a Recurring PayIn (CIT)
• Create a Recurring PayIn (MIT)
• The Recurring PayIn object
• View a PayIn (Recurring Card)
• Create a Recurring PayIn Registration (Card)
• Create a Recurring PayIn Registration (PayPal)
• The Recurring PayIn Registration object
• The Recurring PayIn Registration object (PayPal)
• Update a Recurring PayIn Registration
• Update a Recurring PayIn Registration (PayPal)
• View a Recurring PayIn Registration
• View a Recurring PayIn Registration (PayPal)
• Create a Refund for a PayIn
• Create a Refund for a Transfer
• List Refunds for a PayIn
• List Refunds for a Payout
• List Refunds for a Repudiation
• List Refunds for a Transfer
• The Refund object
• View a Refund
• Create a Report: Generate a reporting service report
• List all Reports: List key data of Reporting Service reports
• The Report object: Report object of Mangopay's Reporting Service (2025)
• View a Report: Retrieve a report from the Reporting Service
• Create a Transactions Report: Generate a legacy Transactions Report
• Create a Wallets Report: Generate a legacy Wallets Report
• List all Reports: List all legacy reports
• The legacy Report object
• View a Report: Retrieve a legacy report
• The Repudiation object
• View a Repudiation
• Create a Satispay PayIn
• The Satispay PayIn object
• View a PayIn (Satispay)
• Cancel a Settlement: Disregard a settlement file and stop it being processed
• Create a Settlement and generate a secure URL for file upload: Generate a pre-signed URL to which you can upload your Mangopay-format settlement file
• Settlement file format requirements
• The Settlement Object
• Update a Settlement and generate a new upload URL: Generate a new pre-signed URL to replace the file of an existing Settlement
• Upload settlement file to secure URL: Send a file to the secure upload URL received previously
• View a Settlement: Retrieve the settlement data generated from file upload
• View validation errors for a Settlement: Retrieve information about failed or partially matched settlements
• Create a Swish PayIn
• The Swish PayIn object
• View a PayIn (Swish)
• List Transactions for a Bank Account
• List Transactions for a Card
• List Transactions for a Card Fingerprint
• List Transactions for a Client Wallet
• List Transactions for a Deposit Preauthorization
• List Transactions for a Dispute
• List Transactions for a Mandate
• List Transactions for a Preauthorization
• List Transactions for a User
• List Transactions for a Wallet
• The Transaction object
• Create a Transfer
• The Transfer object
• View a Transfer
• Create a TWINT PayIn
• The TWINT PayIn object
• View a PayIn (TWINT)
• Create a UBO
• Create a UBO Declaration
• List UBO Declarations for a User
• Submit a UBO Declaration
• The UBO Declaration object
• The UBO object
• Update a UBO
• View a UBO
• View a UBO Declaration
• The User Data Format object
• Validate the format of User data
• The User EMoney object
• View User EMoney
• The User Regulatory Status object
• View a User Regulatory Status
• Categorize a Legal User: Transition a Legal Payer to Owner and enroll them in SCA
• Categorize a Natural User: Transition a Natural Payer to Owner and enroll them in SCA
• Close a Legal User: Permanently close a user account so it can no longer be used
• Close a Natural User: Permanently close a user account so it can no longer be used
• Create a Legal User
• Create a Legal User (SCA): Register a Legal Payer or Owner (with SCA enrollment)
• Create a Natural User
• Create a Natural User (SCA): Register a Natural Payer or Owner (with SCA enrollment)
• Enroll a User in SCA: Obtain an SCA redirection link to enroll an Owner user
• The Legal User object
• The Legal User object (SCA)
• List all Users: List User objects and key details
• Manage proxy consent for a User: Allow a user to give or revoke consent for proxy actions
• The Natural User object
• The Natural User object (SCA)
• Update a Legal User
• Update a Legal User (SCA): Modify details for a Legal Payer or Owner without changing category
• Update a Natural User
• Update a Natural User (SCA): Modify details for a Natural Payer or Owner without changing category
• View a User
• View a User (SCA): Retrieve a Natural or Legal User
• View the SCA status of a User: Retrieve SCA and consent information for a Natural or Legal User
• Create a Virtual Account: Set up a virtual IBAN or local account attached to a wallet
• Deactivate a Virtual Account: Close an account permanently to prevent it being used
• The External Instruction Bank Wire PayIn object
• List Virtual Accounts for a Wallet
• View a PayIn (External Instruction)
• View a Virtual Account: Fetch a Virtual Account or legacy Banking Alias based on its ID
• View Virtual Account availabilities: See your platform's account capabilities per account type and country
• The Virtual Account object
• Create a Wallet
• List Wallets for a User
• Update a Wallet
• View a Wallet
• The Wallet object
• Create a Web Card PayIn
• The Extended Web Card PayIn object
• View card details for a Web Card PayIn
• View a PayIn (Web Card)
• The Web Card PayIn object
• [Deprecated] Create a Web Direct-Debit PayIn
• View a PayIn
• [Deprecated] The Web Direct-Debit PayIn object
• Create a Hook: Set up a URL to receive notifications of an event type
• The Hook object
• List all Hooks
• Update a Hook
• View a Hook
• API status
• Customizing bank statement references
• Build with AI: Use Mangopay docs and SDKs with AI tools
• Mirakl Connector
• Third-party PSPs with Echo
• Enrich Orders with custom fields: How to set up and integrate custom fields for Echo with Mirakl
• Onboarding and synchronizing sellers: Guide to the new Mangopay-hosted experiences to onboard your sellers
• Team management: Manage your company's team members on the Mangopay Dashboard using role-based access control (RBAC)
• Roles and scopes: Understand the action scopes in reach Dashboard role
• All error codes
• Error report
• HTTP response codes
• Currencies: Summary of Mangopay features by currency
• Disputes
• Mangopay e-wallet system
• Mangopay Echo
• Echo integration
• How Echo works
• Echo reports: List intents, intent actions, settlements and splits
• Fees and billing
• Overview
• Rules
• Conversions
• Glossary
• All supported payment methods: Increase conversion and expand to new markets
• Payment method activation: Activating additional payment methods and currencies for your platform
• Overview
• Payment processing certificates
• Bancontact
• Bank wire
• Direct debit
• Pay by Bank
• Virtual IBANs
• Bizum
• BLIK
• Card processing overview
• 3DS
• Address verification system
• Co-branded cards
• 30-day preauth
• Overview
• How to process a card payment: Make a card payment to get funds into a Mangopay wallet
• Card fingerprint
• Overview
• How to process a 7-day card preauthorization
• Overview
• How to process a recurring card payment
• Overview
• How to validate a card without debiting a payment
• Giropay
• Overview
• How to process a Google Pay payment
• iDEAL | Wero
• Klarna
• MB WAY
• Multibanco
• Payconiq
• PayPal
• Satispay
• Swish
• TWINT
• Introduction
• Integrate payout flows
• Rejects, returns, and recalls: Guidance for dealing with payout rejects and returns
• Overview
• How to process a refund
• Introduction to SCA: Learn about Mangopay's SCA features applicable to Owner users
• Authentication factors: Learn how authentication factors work on the hosted webpage
• WebAuthn passkey on Android: Integrate Mangopay's passkey factor in Android apps
• WebAuthn passkey on iOS: Integrate Mangopay's passkey factor in iOS apps
• FAQ on Mangopay's SCA feature
• SCA on your platform: Integrating the mTLS certificate factor required for platforms taking SCA action under proxy
• Proxy management: Managing user consent to the proxy allowing you to take action on their behalf
• SCA on recipients (bank accounts): Read about Mangopay's new Recipients feature, replacing bank accounts
• SCA session redirection: Learn how to redirect a user for their hosted SCA session
• SCA on transfers: Read how SCA impacts the transfer endpoint
• SCA on users: Read about how SCA impacts user endpoints
• SCA on Mangopay Account access: Read about how SCA impacts wallet access endpoints
• Blocked users
• Categories
• Restrictions on Payer users
• Country restrictions
• Inactive users: Mangopay’s policy on inactive accounts (also called dormant accounts) and inactivity fees
• KYC/KYB limits: Read about the KYC/KYB limits applicable to users under Mangopay's Payment Services (EEA) and Electronic Money Services (EEA and UK)
• Privacy
• Terms and conditions
• Introduction and types
• Introduction
• Beneficial owners
• How to submit a UBO Declaration
• Company number
• Document submission process
• How to submit a KYC Document
• Identity proof best practices
• Dealing with refusals
• Document types
• Verification downgrade
• Hosted IDV for KYC/KYB: Integrate Mangopay's web-hosted KYC/KYB verification solution
• Business users: UX steps, validation flows, and outcomes of the hosted IDV flow for Legal Business users
• KYC/KYB integration: Integrate Mangopay's hosted KYC/KYB verification solution
• Natural users: UX steps, validation flows, and outcomes of the hosted IDV flow for Natural Users
• Organization users: UX steps, validation flows, and outcomes of the hosted IDV flow for Legal Organization users
• Dealing with hosted IDV refusals
• Soletrader users: UX steps, validation flows, and outcomes of the hosted IDV flow for Legal Soletrader users
• All requirements by user type
• Accepted identity documents
• Accepted local KYB documents
• Verification of Payee: How Verification of Payee (VOP) works and why it matters for your platform
• VOP on pay-ins: How Verification of Payee impacts pay-ins to Virtual Accounts
• Recipients and payouts: How Verification of Payee (VOP) impacts recipients and payouts
• Welcome to Mangopay docs
• Onboarding guide: How your platform can partner with Mangopay
• Company information and documents: Information and documents required to verify your platform during onboarding
• Postman
• API
• Dashboard
• Packages and changelogs
• Java SDK
• .NET SDK
• NodeJS SDK
• PHP SDK
• Changelog - Python SDK
• Ruby SDK
• Reports
• Echo
• Platform fees report: List transactions crediting or debiting your platform’s Fees Wallet
• Transactions report: List transactions crediting or debiting user wallets
• Wallets report: List user wallets, their owners, descriptions and tags, and their balances at the time of report creation
• Checkout SDK overview
• Checkout Web integration
• Recipients embedded experience: Integrating the Recipients UI component using Mangopay Elements
• Java
• .NET
• Node.js
• PHP
• Profiler overview
• Profiler - Android: How to integrate the fraud prevention profiler on Android.
• Profiler - iOS: How to integrate the fraud prevention profiler on iOS.
• Profiler - Web: How to integrate the fraud prevention profiler on web.
• Python
• Ruby
• Vault – Web
• Security at Mangopay: How Mangopay handles security, and best practices for your platform and users
• Support
• Address verification system (AVS)
• Recurring card payments
• Payment methods
• Payouts
• Webhook notifications
• Event types

OpenAPI Specs

• package
• package-lock
• settings
• openapi