> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.mangopay.com/api-reference/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.mangopay.com/_mcp/server. # API Reference ## Docs - [Introduction](https://docs.mangopay.com/api-reference/overview/introduction.md): Get started with the Mangopay REST API: base URLs, environments, content type, and encoding. - [Managing API keys](https://docs.mangopay.com/api-reference/overview/api-keys.md) - [Permission scopes](https://docs.mangopay.com/api-reference/overview/api-keys/scopes.md) - [Authentication](https://docs.mangopay.com/api-reference/overview/authentication.md): Understand how to authenticate calls to the Mangopay API using OAuth 2.0, including a step-by-step guide, examples, and best practices. - [Rate limiting](https://docs.mangopay.com/api-reference/overview/rate-limiting.md): Understand the rate limits applied in the API: learn about the response headers that can help you manage rate limiting, plus best practices for your integration. - [Filtering and sorting](https://docs.mangopay.com/api-reference/overview/filtering-sorting.md): Understand how you can filter and sort resources provided by the Mangopay API, with examples and tips. - [Pagination](https://docs.mangopay.com/api-reference/overview/pagination.md): Learn about paginating results using query parameters, as well as useful response headers and how to link to individual pages. - [Idempotency](https://docs.mangopay.com/api-reference/overview/idempotency.md): Understand idempotency and how to make your requests idempotent, allowing you to prevent duplicated calls. - [Data formats](https://docs.mangopay.com/api-reference/overview/data-formats.md): See common data formats used in the Mangopay API for dates, times, amounts, currencies, and countries. - [Data availability periods](https://docs.mangopay.com/api-reference/overview/data-availability-periods.md): Read about durations that data resources remain available via different endpoints of the API, where limits are in place. - [The Natural User object (SCA)](https://docs.mangopay.com/api-reference/users/natural-user-object-sca.md) - [The Legal User object (SCA)](https://docs.mangopay.com/api-reference/users/legal-user-object-sca.md) - [The Natural User object](https://docs.mangopay.com/api-reference/users/natural-user-object.md) - [The Legal User object](https://docs.mangopay.com/api-reference/users/legal-user-object.md) - [The Regulatory Status object](https://docs.mangopay.com/api-reference/user-regulatory-status/regulatory-status-object.md) - [The User EMoney object](https://docs.mangopay.com/api-reference/user-emoney/user-emoney-object.md) - [The IDV Session object](https://docs.mangopay.com/api-reference/idv-sessions/idv-session-object.md): Container for Mangopay's hosted KYC/KYB solution - [The User Data Format object](https://docs.mangopay.com/api-reference/user-data-format/user-data-format-object.md) - [The KYC Document object](https://docs.mangopay.com/api-reference/kyc-documents/kyc-document-object.md) - [The UBO Declaration object](https://docs.mangopay.com/api-reference/ubo-declarations/ubo-declaration-object.md) - [The UBO object](https://docs.mangopay.com/api-reference/ubo-declarations/ubo-object.md) - [The Verified Identity object](https://docs.mangopay.com/api-reference/user-verified-identity/user-verified-identity-object.md) - [The Wallet object](https://docs.mangopay.com/api-reference/wallets/wallet-object.md) - [The Client Wallet object](https://docs.mangopay.com/api-reference/client-wallets/client-wallet-object.md) - [The Card Registration object](https://docs.mangopay.com/api-reference/card-registrations/card-registration-object.md): Register card details to obtain a `CardId` token for one-time, recurring, or preauthorized card payments - [The Card object](https://docs.mangopay.com/api-reference/cards/card-object.md) - [The Payment Method Metadata object](https://docs.mangopay.com/api-reference/payment-method-metadata/payment-method-metadata-object.md) - [The Card Validation object](https://docs.mangopay.com/api-reference/card-validations/card-validation-object.md) - [The Direct Card PayIn object](https://docs.mangopay.com/api-reference/direct-card-payins/direct-card-payin-object.md): One-time payment using a tokenized card - [The Recurring PayIn Registration object](https://docs.mangopay.com/api-reference/recurring-payin-registrations/recurring-payin-registration-object.md) - [The Recurring Card PayIn object](https://docs.mangopay.com/api-reference/recurring-card-payins/recurring-card-payin-object.md) - [The Preauthorization object](https://docs.mangopay.com/api-reference/preauthorizations/preauthorization-object.md) - [The Preauthorized PayIn object](https://docs.mangopay.com/api-reference/preauthorizations/preauthorized-payin-object.md) - [The Extended Preauthorization object](https://docs.mangopay.com/api-reference/extended-preauthorizations/extended-preauthorization-object.md) - [The Extended Preauthorized PayIn object](https://docs.mangopay.com/api-reference/extended-preauthorizations/extended-preauthorized-payin-object.md) - [The Deposit Preauthorization object](https://docs.mangopay.com/api-reference/deposit-preauthorizations/deposit-preauthorization-object.md) - [The Deposit Preauthorized PayIn object](https://docs.mangopay.com/api-reference/deposit-preauthorizations/deposit-preauthorized-payin-object.md) - [The Web Card PayIn object](https://docs.mangopay.com/api-reference/web-card-payins/web-card-payin-object.md) - [The Extended Web Card PayIn object](https://docs.mangopay.com/api-reference/web-card-payins/extended-web-card-payin-object.md) - [The Bank Wire PayIn object](https://docs.mangopay.com/api-reference/bank-wire-payins/bank-wire-payin-object.md) - [The Virtual Account object](https://docs.mangopay.com/api-reference/virtual-accounts/virtual-account-object.md) - [The External Instruction Bank Wire PayIn object](https://docs.mangopay.com/api-reference/virtual-accounts/external-instruction-bank-wire-payin-object.md) - [The Banking Alias object](https://docs.mangopay.com/api-reference/banking-aliases/banking-alias-object.md) - [The Pay by Bank PayIn object](https://docs.mangopay.com/api-reference/pay-by-bank/pay-by-bank-payin-object.md) - [The Mandate object](https://docs.mangopay.com/api-reference/mandates/mandate-object.md) - [The Direct Debit PayIn object](https://docs.mangopay.com/api-reference/direct-debit-payins/direct-debit-payin-object.md) - [[Deprecated] The Web Direct-Debit PayIn object](https://docs.mangopay.com/api-reference/web-direct-debit-payins/web-direct-debit-payin-object.md) - [The Apple Pay PayIn object](https://docs.mangopay.com/api-reference/apple-pay/apple-pay-payin-object.md) - [The Recurring Apple Pay PayIn object](https://docs.mangopay.com/api-reference/apple-pay/recurring-apple-pay-payin-object.md) - [The Bancontact PayIn object](https://docs.mangopay.com/api-reference/bancontact/bancontact-payin-object.md) - [The Bizum PayIn object](https://docs.mangopay.com/api-reference/bizum/bizum-payin-object.md) - [The BLIK PayIn object](https://docs.mangopay.com/api-reference/blik/blik-payin-object.md) - [[Deprecated] The Giropay PayIn object](https://docs.mangopay.com/api-reference/giropay/giropay-payin-object.md) - [The Google Pay PayIn object](https://docs.mangopay.com/api-reference/google-pay/google-pay-payin-object.md) - [The Recurring Google Pay PayIn object](https://docs.mangopay.com/api-reference/google-pay/recurring-google-pay-payin-object.md) - [The iDEAL PayIn object](https://docs.mangopay.com/api-reference/ideal/ideal-payin-object.md) - [The Klarna PayIn object](https://docs.mangopay.com/api-reference/klarna/klarna-payin-object.md) - [The MB WAY PayIn object](https://docs.mangopay.com/api-reference/mb-way/mb-way-payin-object.md) - [The Multibanco PayIn object](https://docs.mangopay.com/api-reference/multibanco/multibanco-payin-object.md) - [The Payconiq PayIn object](https://docs.mangopay.com/api-reference/payconiq/payconiq-payin-object.md) - [The PayPal PayIn object](https://docs.mangopay.com/api-reference/paypal/paypal-payin-object.md) - [The Recurring PayPal PayIn object](https://docs.mangopay.com/api-reference/paypal/recurring-paypal-payin-object.md) - [The Satispay PayIn object](https://docs.mangopay.com/api-reference/satispay/satispay-payin-object.md) - [The Swish PayIn object](https://docs.mangopay.com/api-reference/swish/swish-payin-object.md) - [The TWINT PayIn object](https://docs.mangopay.com/api-reference/twint/twint-payin-object.md) - [The Transfer object](https://docs.mangopay.com/api-reference/transfers/transfer-object.md) - [The Refund object](https://docs.mangopay.com/api-reference/refunds/refund-object.md) - [The Dispute object](https://docs.mangopay.com/api-reference/disputes/dispute-object.md) - [The Dispute Document object](https://docs.mangopay.com/api-reference/dispute-documents/dispute-document-object.md) - [The Repudiation object](https://docs.mangopay.com/api-reference/repudiations/repudiation-object.md) - [The Settlement Transfer object](https://docs.mangopay.com/api-reference/dispute-settlement/settlement-transfer-object.md) - [The Recipient object](https://docs.mangopay.com/api-reference/recipients/recipient-object.md) - [The Bank Account object](https://docs.mangopay.com/api-reference/bank-accounts/bank-account-object.md) - [The Payout object](https://docs.mangopay.com/api-reference/payouts/payout-object.md) - [The Conversion Rate object (FX)](https://docs.mangopay.com/api-reference/conversion-rates/conversion-rate-object.md) - [The Quote object (Guaranteed FX)](https://docs.mangopay.com/api-reference/quotes/quote-object.md) - [The Conversion object (FX)](https://docs.mangopay.com/api-reference/conversions/conversion-object.md) - [The Transaction object](https://docs.mangopay.com/api-reference/transactions/transaction-object.md) - [Supported providers](https://docs.mangopay.com/api-reference/echo/supported-providers.md) - [Supported payment methods](https://docs.mangopay.com/api-reference/echo/supported-payment-methods.md) - [The Intent object](https://docs.mangopay.com/api-reference/intents/intent-object.md) - [Settlement file format requirements](https://docs.mangopay.com/api-reference/settlements/settlement-file.md) - [The Settlement Object](https://docs.mangopay.com/api-reference/settlements/settlement-object.md) - [The API Response object](https://docs.mangopay.com/api-reference/api-responses/api-response-object.md) - [The Country Authorizations object](https://docs.mangopay.com/api-reference/country-authorizations/country-authorizations-object.md) - [The Hook object](https://docs.mangopay.com/api-reference/webhooks/hook-object.md) - [The Event object](https://docs.mangopay.com/api-reference/events/event-object.md) - [The Report object](https://docs.mangopay.com/api-reference/reporting/report-object.md): Report object of Mangopay's Reporting Service (2025) - [The legacy Report object](https://docs.mangopay.com/api-reference/reports/report-object.md) - [The Client object](https://docs.mangopay.com/api-reference/client/client-object.md) ## API Docs - API Reference > Overview > Authentication [Create OAuth bearer token](https://docs.mangopay.com/api-reference/overview/authentication/create-oauth-token.md) - API Reference > Overview > Authentication [Create an access token for the Recipients embedded experience](https://docs.mangopay.com/api-reference/overview/authentication/create-access-token-recipient.md) - API Reference > Overview > Authentication [Create an access token for Checkout SDK features](https://docs.mangopay.com/api-reference/overview/authentication/create-access-token-checkout.md) - API Reference > User management > Users [Create a Natural User (SCA)](https://docs.mangopay.com/api-reference/users/create-natural-user-sca.md) - API Reference > User management > Users [Update a Natural User (SCA)](https://docs.mangopay.com/api-reference/users/update-natural-user-sca.md) - API Reference > User management > Users [Categorize a Natural User](https://docs.mangopay.com/api-reference/users/categorize-natural-user.md) - API Reference > User management > Users [Create a Legal User (SCA)](https://docs.mangopay.com/api-reference/users/create-legal-user-sca.md) - API Reference > User management > Users [Update a Legal User (SCA)](https://docs.mangopay.com/api-reference/users/update-legal-user-sca.md) - API Reference > User management > Users [Categorize a Legal User](https://docs.mangopay.com/api-reference/users/categorize-legal-user.md) - API Reference > User management > Users [Enroll a User in SCA](https://docs.mangopay.com/api-reference/users/enroll-user.md) - API Reference > User management > Users [Manage proxy consent for a User](https://docs.mangopay.com/api-reference/users/manage-proxy-consent.md) - API Reference > User management > Users [View the SCA status of a User](https://docs.mangopay.com/api-reference/users/view-user-sca-status.md) - API Reference > User management > Users [View a User (SCA)](https://docs.mangopay.com/api-reference/users/view-user-sca.md) - API Reference > User management > Users [List all Users](https://docs.mangopay.com/api-reference/users/list-users.md) - API Reference > User management > Users [Close a Natural User](https://docs.mangopay.com/api-reference/users/close-natural-user.md) - API Reference > User management > Users [Close a Legal User](https://docs.mangopay.com/api-reference/users/close-legal-user.md) - API Reference > User management > Users > Non-SCA endpoints [Create a Natural User](https://docs.mangopay.com/api-reference/users/create-natural-user.md) - API Reference > User management > Users > Non-SCA endpoints [Update a Natural User](https://docs.mangopay.com/api-reference/users/update-natural-user.md) - API Reference > User management > Users > Non-SCA endpoints [Create a Legal User](https://docs.mangopay.com/api-reference/users/create-legal-user.md) - API Reference > User management > Users > Non-SCA endpoints [Update a Legal User](https://docs.mangopay.com/api-reference/users/update-legal-user.md) - API Reference > User management > Users > Non-SCA endpoints [View a User](https://docs.mangopay.com/api-reference/users/view-user.md) - API Reference > User management > Regulatory status [View the Regulatory Status of a User](https://docs.mangopay.com/api-reference/user-regulatory-status/view-user-regulatory-status.md) - API Reference > User management > User e-money [View User EMoney](https://docs.mangopay.com/api-reference/user-emoney/view-user-emoney.md) - API Reference > User verification > IDV sessions [Create an IDV Session](https://docs.mangopay.com/api-reference/idv-sessions/create-idv-session.md) - API Reference > User verification > IDV sessions [View an IDV Session](https://docs.mangopay.com/api-reference/idv-sessions/view-idv-session.md) - API Reference > User verification > IDV sessions [List IDV Sessions for a User](https://docs.mangopay.com/api-reference/idv-sessions/list-idv-sessions-user.md) - API Reference > User verification > IDV sessions [Retry a PSC Session](https://docs.mangopay.com/api-reference/idv-sessions/retry-psc-session.md) - API Reference > User verification > User data format [Validate the format of User data](https://docs.mangopay.com/api-reference/user-data-format/validate-user-data-format.md) - API Reference > User verification > KYC documents [Create a KYC Document](https://docs.mangopay.com/api-reference/kyc-documents/create-kyc-document.md) - API Reference > User verification > KYC documents [Create a KYC Document Page](https://docs.mangopay.com/api-reference/kyc-documents/create-kyc-document-page.md) - API Reference > User verification > KYC documents [Submit a KYC Document](https://docs.mangopay.com/api-reference/kyc-documents/submit-kyc-document.md) - API Reference > User verification > KYC documents [View a KYC Document](https://docs.mangopay.com/api-reference/kyc-documents/view-kyc-document.md) - API Reference > User verification > KYC documents [List KYC Documents for a User](https://docs.mangopay.com/api-reference/kyc-documents/list-kyc-documents-user.md) - API Reference > User verification > KYC documents [List all KYC Documents](https://docs.mangopay.com/api-reference/kyc-documents/list-kyc-documents.md) - API Reference > User verification > UBO declarations [Create a UBO Declaration](https://docs.mangopay.com/api-reference/ubo-declarations/create-ubo-declaration.md) - API Reference > User verification > UBO declarations [Create a UBO](https://docs.mangopay.com/api-reference/ubo-declarations/create-ubo.md) - API Reference > User verification > UBO declarations [Submit a UBO Declaration](https://docs.mangopay.com/api-reference/ubo-declarations/submit-ubo-declaration.md) - API Reference > User verification > UBO declarations [Update a UBO](https://docs.mangopay.com/api-reference/ubo-declarations/update-ubo.md) - API Reference > User verification > UBO declarations [View a UBO Declaration](https://docs.mangopay.com/api-reference/ubo-declarations/view-ubo-declaration.md) - API Reference > User verification > UBO declarations [View a UBO](https://docs.mangopay.com/api-reference/ubo-declarations/view-ubo.md) - API Reference > User verification > UBO declarations [List UBO Declarations for a User](https://docs.mangopay.com/api-reference/ubo-declarations/list-ubo-declarations-user.md) - API Reference > User verification > Verified identity [View the Verified Identity of a User](https://docs.mangopay.com/api-reference/user-verified-identity/view-user-verified-identity.md) - API Reference > Wallets > User wallets [Create a Wallet](https://docs.mangopay.com/api-reference/wallets/create-wallet.md) - API Reference > Wallets > User wallets [Update a Wallet](https://docs.mangopay.com/api-reference/wallets/update-wallet.md) - API Reference > Wallets > User wallets [View a Wallet](https://docs.mangopay.com/api-reference/wallets/view-wallet.md) - API Reference > Wallets > User wallets [List Wallets for a User](https://docs.mangopay.com/api-reference/wallets/list-wallets-user.md) - API Reference > Wallets > Client wallets [View a Client Wallet](https://docs.mangopay.com/api-reference/client-wallets/view-client-wallet.md) - API Reference > Wallets > Client wallets [List all Client Wallets](https://docs.mangopay.com/api-reference/client-wallets/list-client-wallets.md) - API Reference > Wallets > Client wallets [List Client Wallets by FundsType](https://docs.mangopay.com/api-reference/client-wallets/list-client-wallets-fundstype.md) - API Reference > Cards > Card registrations [Create a Card Registration](https://docs.mangopay.com/api-reference/card-registrations/create-card-registration.md) - API Reference > Cards > Card registrations [Tokenize the card](https://docs.mangopay.com/api-reference/card-registrations/tokenize-card.md) - API Reference > Cards > Card registrations [Update a Card Registration](https://docs.mangopay.com/api-reference/card-registrations/update-card-registration.md) - API Reference > Cards > Card registrations [View a Card Registration](https://docs.mangopay.com/api-reference/card-registrations/view-card-registration.md) - API Reference > Cards > Cards [Deactivate or edit a Card](https://docs.mangopay.com/api-reference/cards/deactivate-edit-card.md) - API Reference > Cards > Cards [View a Card](https://docs.mangopay.com/api-reference/cards/view-card.md) - API Reference > Cards > Cards [List Cards for a User](https://docs.mangopay.com/api-reference/cards/list-cards-user.md) - API Reference > Cards > Cards [List Cards for a Fingerprint](https://docs.mangopay.com/api-reference/cards/list-cards-fingerprint.md) - API Reference > Cards > Metadata [Look up metadata for a payment method](https://docs.mangopay.com/api-reference/payment-method-metadata/lookup-payment-method-metadata.md) - API Reference > Cards > Card validations [Create a Card Validation](https://docs.mangopay.com/api-reference/card-validations/create-card-validation.md) - API Reference > Cards > Card validations [View a Card Validation](https://docs.mangopay.com/api-reference/card-validations/view-card-validation.md) - API Reference > All pay-ins > Pay-ins [View a PayIn](https://docs.mangopay.com/api-reference/payins/view-payin.md) - API Reference > Card pay-ins > Direct card pay-ins [Create a Direct Card PayIn](https://docs.mangopay.com/api-reference/direct-card-payins/create-direct-card-payin.md) - API Reference > Card pay-ins > Recurring pay-in registrations [Create a Recurring PayIn Registration](https://docs.mangopay.com/api-reference/recurring-payin-registrations/create-recurring-payin-registration.md) - API Reference > Card pay-ins > Recurring pay-in registrations [Update a Recurring PayIn Registration](https://docs.mangopay.com/api-reference/recurring-payin-registrations/update-recurring-payin-registration.md) - API Reference > Card pay-ins > Recurring pay-in registrations [View a Recurring PayIn Registration](https://docs.mangopay.com/api-reference/recurring-payin-registrations/view-recurring-payin-registration.md) - API Reference > Card pay-ins > Recurring card pay-ins [Create a Recurring Card PayIn (CIT or MIT)](https://docs.mangopay.com/api-reference/recurring-card-payins/create-recurring-card-payin.md) - API Reference > Card pay-ins > Preauthorizations [Create a Preauthorization](https://docs.mangopay.com/api-reference/preauthorizations/create-preauthorization.md) - API Reference > Card pay-ins > Preauthorizations [Cancel or validate a Preauthorization](https://docs.mangopay.com/api-reference/preauthorizations/cancel-validate-preauthorization.md) - API Reference > Card pay-ins > Preauthorizations [View a Preauthorization](https://docs.mangopay.com/api-reference/preauthorizations/view-preauthorization.md) - API Reference > Card pay-ins > Preauthorizations [List Preauthorizations for a Card](https://docs.mangopay.com/api-reference/preauthorizations/list-preauthorizations-card.md) - API Reference > Card pay-ins > Preauthorizations [List Preauthorizations for a User](https://docs.mangopay.com/api-reference/preauthorizations/list-preauthorizations-user.md) - API Reference > Card pay-ins > Preauthorizations [Create a Preauthorized PayIn](https://docs.mangopay.com/api-reference/preauthorizations/create-preauthorized-payin.md) - API Reference > Card pay-ins > Extended Preauthorizations [Create a Card Extended Preauthorization](https://docs.mangopay.com/api-reference/extended-preauthorizations/create-card-extended-preauthorization.md) - API Reference > Card pay-ins > Extended Preauthorizations [Cancel an Extended Preauthorization](https://docs.mangopay.com/api-reference/extended-preauthorizations/cancel-extended-preauthorization.md) - API Reference > Card pay-ins > Extended Preauthorizations [View an Extended Preauthorization](https://docs.mangopay.com/api-reference/extended-preauthorizations/view-extended-preauthorization.md) - API Reference > Card pay-ins > Extended Preauthorizations [List Extended Preauthorizations for a Card](https://docs.mangopay.com/api-reference/extended-preauthorizations/list-extended-preauthorizations-card.md) - API Reference > Card pay-ins > Extended Preauthorizations [List Extended Preauthorizations for a User](https://docs.mangopay.com/api-reference/extended-preauthorizations/list-extended-preauthorizations-user.md) - API Reference > Card pay-ins > Extended Preauthorizations [Create an Extended Preauthorized PayIn](https://docs.mangopay.com/api-reference/extended-preauthorizations/create-extended-preauthorized-payin.md) - API Reference > Card pay-ins > Deposit Preauthorizations [Create a Card Deposit Preauthorization](https://docs.mangopay.com/api-reference/deposit-preauthorizations/create-card-deposit-preauthorization.md) - API Reference > Card pay-ins > Deposit Preauthorizations [Cancel a Deposit Preauthorization](https://docs.mangopay.com/api-reference/deposit-preauthorizations/cancel-deposit-preauthorization.md) - API Reference > Card pay-ins > Deposit Preauthorizations [View a Deposit Preauthorization](https://docs.mangopay.com/api-reference/deposit-preauthorizations/view-deposit-preauthorization.md) - API Reference > Card pay-ins > Deposit Preauthorizations [List Deposit Preauthorizations for a Card](https://docs.mangopay.com/api-reference/deposit-preauthorizations/list-deposit-preauthorizations-card.md) - API Reference > Card pay-ins > Deposit Preauthorizations [List Deposit Preauthorizations for a User](https://docs.mangopay.com/api-reference/deposit-preauthorizations/list-deposit-preauthorizations-user.md) - API Reference > Card pay-ins > Deposit Preauthorizations [Create a Deposit Preauthorized PayIn](https://docs.mangopay.com/api-reference/deposit-preauthorizations/create-deposit-preauthorized-payin.md) - API Reference > Card pay-ins > Web card pay-ins [Create a Web Card PayIn](https://docs.mangopay.com/api-reference/web-card-payins/create-web-card-payin.md) - API Reference > Card pay-ins > Web card pay-ins [View card details for a Web Card PayIn](https://docs.mangopay.com/api-reference/web-card-payins/view-card-details-web-card-payin.md) - API Reference > Banking pay-ins > Bank wires [Create a Bank Wire PayIn](https://docs.mangopay.com/api-reference/bank-wire-payins/create-bank-wire-payin.md) - API Reference > Banking pay-ins > Virtual accounts [View Virtual Account availabilities](https://docs.mangopay.com/api-reference/virtual-accounts/view-virtual-account-availabilities.md) - API Reference > Banking pay-ins > Virtual accounts [Create a Virtual Account](https://docs.mangopay.com/api-reference/virtual-accounts/create-virtual-account.md) - API Reference > Banking pay-ins > Virtual accounts [Deactivate a Virtual Account](https://docs.mangopay.com/api-reference/virtual-accounts/deactivate-virtual-account.md) - API Reference > Banking pay-ins > Virtual accounts [View a Virtual Account](https://docs.mangopay.com/api-reference/virtual-accounts/view-virtual-account.md) - API Reference > Banking pay-ins > Virtual accounts [List Virtual Accounts for a Wallet](https://docs.mangopay.com/api-reference/virtual-accounts/list-virtual-accounts-wallet.md) - API Reference > Banking pay-ins > Virtual accounts > Banking alias [Create an IBAN Banking Alias](https://docs.mangopay.com/api-reference/banking-aliases/create-iban-banking-alias.md) - API Reference > Banking pay-ins > Virtual accounts > Banking alias [Deactivate a Banking Alias](https://docs.mangopay.com/api-reference/banking-aliases/deactivate-banking-alias.md) - API Reference > Banking pay-ins > Virtual accounts > Banking alias [View a Banking Alias](https://docs.mangopay.com/api-reference/banking-aliases/view-banking-alias.md) - API Reference > Banking pay-ins > Virtual accounts > Banking alias [View a Banking Alias for a Wallet](https://docs.mangopay.com/api-reference/banking-aliases/view-banking-alias-wallet.md) - API Reference > Banking pay-ins > Pay by bank [View supported banks for Pay by Bank](https://docs.mangopay.com/api-reference/pay-by-bank/view-supported-banks-pay-by-bank.md) - API Reference > Banking pay-ins > Pay by bank [Create a Pay by Bank PayIn](https://docs.mangopay.com/api-reference/pay-by-bank/create-pay-by-bank-payin.md) - API Reference > Banking pay-ins > Direct debits [Create a Mandate](https://docs.mangopay.com/api-reference/mandates/create-mandate.md) - API Reference > Banking pay-ins > Direct debits [Cancel a Mandate](https://docs.mangopay.com/api-reference/mandates/cancel-mandate.md) - API Reference > Banking pay-ins > Direct debits [View a Mandate](https://docs.mangopay.com/api-reference/mandates/view-mandate.md) - API Reference > Banking pay-ins > Direct debits [List all Mandates](https://docs.mangopay.com/api-reference/mandates/list-mandates.md) - API Reference > Banking pay-ins > Direct debits [List Mandates for a User](https://docs.mangopay.com/api-reference/mandates/list-mandates-user.md) - API Reference > Banking pay-ins > Direct debits [List Mandates for a Bank Account](https://docs.mangopay.com/api-reference/mandates/list-mandates-bank-account.md) - API Reference > Banking pay-ins > Direct debits [List Mandates for a Recipient](https://docs.mangopay.com/api-reference/mandates/list-mandates-recipient.md) - API Reference > Banking pay-ins > Direct debits [Create a Direct Debit PayIn](https://docs.mangopay.com/api-reference/direct-debit-payins/create-direct-debit-payin.md) - API Reference > Banking pay-ins > Web direct debits [Create a Web Direct-Debit PayIn](https://docs.mangopay.com/api-reference/web-direct-debit-payins/create-web-direct-debit-payin.md) - API Reference > APM pay-ins > Apple Pay [Create an Apple Pay PayIn](https://docs.mangopay.com/api-reference/apple-pay/create-apple-pay-payin.md) - API Reference > APM pay-ins > Apple Pay > Recurring payments [Create a Recurring Apple Pay PayIn (CIT or MIT)](https://docs.mangopay.com/api-reference/apple-pay/create-recurring-apple-pay-payin.md) - API Reference > APM pay-ins > Bancontact [Create a Bancontact PayIn](https://docs.mangopay.com/api-reference/bancontact/create-bancontact-payin.md) - API Reference > APM pay-ins > Bizum [Create a Bizum PayIn](https://docs.mangopay.com/api-reference/bizum/create-bizum-payin.md) - API Reference > APM pay-ins > BLIK [Create a BLIK PayIn](https://docs.mangopay.com/api-reference/blik/create-blik-payin.md) - API Reference > APM pay-ins > Giropay [Create a Giropay PayIn](https://docs.mangopay.com/api-reference/giropay/create-giropay-payin.md) - API Reference > APM pay-ins > Google Pay [Create a Google Pay PayIn](https://docs.mangopay.com/api-reference/google-pay/create-google-pay-payin.md) - API Reference > APM pay-ins > Google Pay > Recurring payments [Create a Recurring Google Pay PayIn (CIT or MIT)](https://docs.mangopay.com/api-reference/google-pay/create-recurring-google-pay-payin.md) - API Reference > APM pay-ins > iDEAL [Create an iDEAL PayIn](https://docs.mangopay.com/api-reference/ideal/create-ideal-payin.md) - API Reference > APM pay-ins > Klarna [Create a Klarna PayIn](https://docs.mangopay.com/api-reference/klarna/create-klarna-payin.md) - API Reference > APM pay-ins > MB WAY [Create an MB WAY PayIn](https://docs.mangopay.com/api-reference/mb-way/create-mb-way-payin.md) - API Reference > APM pay-ins > Multibanco [Create a Multibanco PayIn](https://docs.mangopay.com/api-reference/multibanco/create-multibanco-payin.md) - API Reference > APM pay-ins > Payconiq [Create a Payconiq PayIn](https://docs.mangopay.com/api-reference/payconiq/create-payconiq-payin.md) - API Reference > APM pay-ins > PayPal [Submit data for a PayPal PayIn](https://docs.mangopay.com/api-reference/paypal/submit-data-paypal-payin.md) - API Reference > APM pay-ins > PayPal [View data submitted for a PayPal PayIn](https://docs.mangopay.com/api-reference/paypal/view-data-paypal-payin.md) - API Reference > APM pay-ins > PayPal > One-time payment [Create a PayPal PayIn](https://docs.mangopay.com/api-reference/paypal/create-paypal-payin.md) - API Reference > APM pay-ins > PayPal > Recurring payments [Create a Recurring PayPal PayIn (CIT or MIT)](https://docs.mangopay.com/api-reference/paypal/create-recurring-paypal-payin.md) - API Reference > APM pay-ins > PayPal > Preauthorized payments [Create a PayPal Deposit Preauthorization](https://docs.mangopay.com/api-reference/deposit-preauthorizations/create-paypal-deposit-preauthorization.md) - API Reference > APM pay-ins > PayPal > Preauthorized payments [Create a PayPal Extended Preauthorization](https://docs.mangopay.com/api-reference/extended-preauthorizations/create-paypal-extended-preauthorization.md) - API Reference > APM pay-ins > PayPal [Add tracking information to a PayPal PayIn](https://docs.mangopay.com/api-reference/paypal/add-tracking-paypal-payin.md) - API Reference > APM pay-ins > Satispay [Create a Satispay PayIn](https://docs.mangopay.com/api-reference/satispay/create-satispay-payin.md) - API Reference > APM pay-ins > Swish [Create a Swish PayIn](https://docs.mangopay.com/api-reference/swish/create-swish-payin.md) - API Reference > APM pay-ins > TWINT [Create a TWINT PayIn](https://docs.mangopay.com/api-reference/twint/create-twint-payin.md) - API Reference > Transfers > Transfers [Create a Transfer](https://docs.mangopay.com/api-reference/transfers/create-transfer.md) - API Reference > Transfers > Transfers [View a Transfer](https://docs.mangopay.com/api-reference/transfers/view-transfer.md) - API Reference > Refunds > Refunds [Create a Refund for a PayIn](https://docs.mangopay.com/api-reference/refunds/create-refund-payin.md) - API Reference > Refunds > Refunds [Create a Refund for a Transfer](https://docs.mangopay.com/api-reference/refunds/create-refund-transfer.md) - API Reference > Refunds > Refunds [View a Refund](https://docs.mangopay.com/api-reference/refunds/view-refund.md) - API Reference > Refunds > Refunds [List Refunds for a PayIn](https://docs.mangopay.com/api-reference/refunds/list-refunds-payin.md) - API Reference > Refunds > Refunds [List Refunds for a Transfer](https://docs.mangopay.com/api-reference/refunds/list-refunds-transfer.md) - API Reference > Refunds > Refunds [List Refunds for a Payout](https://docs.mangopay.com/api-reference/refunds/list-refunds-payout.md) - API Reference > Refunds > Refunds [List Refunds for a Repudiation](https://docs.mangopay.com/api-reference/refunds/list-refunds-repudiation.md) - API Reference > Disputes > Disputes [View a Dispute](https://docs.mangopay.com/api-reference/disputes/view-dispute.md) - API Reference > Disputes > Disputes [Submit a Dispute](https://docs.mangopay.com/api-reference/disputes/submit-dispute.md) - API Reference > Disputes > Disputes [Update a Dispute](https://docs.mangopay.com/api-reference/disputes/update-dispute.md) - API Reference > Disputes > Disputes [Close a Dispute](https://docs.mangopay.com/api-reference/disputes/close-dispute.md) - API Reference > Disputes > Disputes [List all Disputes](https://docs.mangopay.com/api-reference/disputes/list-disputes.md) - API Reference > Disputes > Disputes [List Disputes pending settlement](https://docs.mangopay.com/api-reference/disputes/list-disputes-settlement.md) - API Reference > Disputes > Disputes [List Disputes for a PayIn](https://docs.mangopay.com/api-reference/disputes/list-disputes-payin.md) - API Reference > Disputes > Disputes [List Disputes for a User](https://docs.mangopay.com/api-reference/disputes/list-disputes-user.md) - API Reference > Disputes > Disputes [List Disputes for a Wallet](https://docs.mangopay.com/api-reference/disputes/list-disputes-wallet.md) - API Reference > Disputes > Dispute documents [Create a Dispute Document](https://docs.mangopay.com/api-reference/dispute-documents/create-dispute-document.md) - API Reference > Disputes > Dispute documents [View a Dispute Document](https://docs.mangopay.com/api-reference/dispute-documents/view-dispute-document.md) - API Reference > Disputes > Dispute documents [Submit a Dispute Document](https://docs.mangopay.com/api-reference/dispute-documents/submit-dispute-document.md) - API Reference > Disputes > Dispute documents [List all Dispute Documents](https://docs.mangopay.com/api-reference/dispute-documents/list-dispute-documents.md) - API Reference > Disputes > Dispute documents [Create a Dispute Document Page](https://docs.mangopay.com/api-reference/dispute-documents/create-dispute-document-page.md) - API Reference > Disputes > Dispute documents [Create a weblink to view the Pages of a Dispute Document](https://docs.mangopay.com/api-reference/dispute-documents/create-weblink-to-view-dispute-document-pages.md) - API Reference > Disputes > Dispute documents [List Documents for a Dispute](https://docs.mangopay.com/api-reference/dispute-documents/list-documents-dispute.md) - API Reference > Disputes > Repudiations [View a Repudiation](https://docs.mangopay.com/api-reference/repudiations/view-repudiation.md) - API Reference > Disputes > Dispute settlement [Create a Settlement Transfer](https://docs.mangopay.com/api-reference/dispute-settlement/create-settlement-transfer.md) - API Reference > Disputes > Dispute settlement [View a Settlement Transfer](https://docs.mangopay.com/api-reference/dispute-settlement/view-settlement-transfer.md) - API Reference > Disputes > Dispute settlement [Create a Bank Wire PayIn to the Repudiation Wallet](https://docs.mangopay.com/api-reference/dispute-settlement/create-bank-wire-payin-to-repudiation-wallet.md) - API Reference > Payouts > Recipients [View the schema for a Recipient](https://docs.mangopay.com/api-reference/recipients/view-recipient-schema.md) - API Reference > Payouts > Recipients [Validate data for a Recipient](https://docs.mangopay.com/api-reference/recipients/validate-recipient-data.md) - API Reference > Payouts > Recipients [Create a Recipient](https://docs.mangopay.com/api-reference/recipients/create-recipient.md) - API Reference > Payouts > Recipients [Deactivate a Recipient](https://docs.mangopay.com/api-reference/recipients/deactivate-recipient.md) - API Reference > Payouts > Recipients [View a Recipient](https://docs.mangopay.com/api-reference/recipients/view-recipient.md) - API Reference > Payouts > Recipients [List Recipients for a User](https://docs.mangopay.com/api-reference/recipients/list-recipients-user.md) - API Reference > Payouts > Recipients [View payout methods](https://docs.mangopay.com/api-reference/recipients/view-payout-methods.md) - API Reference > Payouts > Bank accounts [Create an IBAN Bank Account](https://docs.mangopay.com/api-reference/bank-accounts/create-iban-bank-account.md) - API Reference > Payouts > Bank accounts [Create a US Bank Account](https://docs.mangopay.com/api-reference/bank-accounts/create-us-bank-account.md) - API Reference > Payouts > Bank accounts [Create a CA Bank Account](https://docs.mangopay.com/api-reference/bank-accounts/create-ca-bank-account.md) - API Reference > Payouts > Bank accounts [Create a GB Bank Account](https://docs.mangopay.com/api-reference/bank-accounts/create-gb-bank-account.md) - API Reference > Payouts > Bank accounts [Create an OTHER Bank Account](https://docs.mangopay.com/api-reference/bank-accounts/create-other-bank-account.md) - API Reference > Payouts > Bank accounts [Deactivate a Bank Account](https://docs.mangopay.com/api-reference/bank-accounts/deactivate-bank-account.md) - API Reference > Payouts > Bank accounts [View a Bank Account](https://docs.mangopay.com/api-reference/bank-accounts/view-bank-account.md) - API Reference > Payouts > Bank accounts [List Bank Accounts for a User](https://docs.mangopay.com/api-reference/bank-accounts/list-bank-accounts-user.md) - API Reference > Payouts > Payouts [Create a Payout](https://docs.mangopay.com/api-reference/payouts/create-payout.md) - API Reference > Payouts > Payouts [View a Payout and check mode applied](https://docs.mangopay.com/api-reference/payouts/view-payout-check-mode-applied.md) - API Reference > Payouts > Payouts [View a Payout](https://docs.mangopay.com/api-reference/payouts/view-payout.md) - API Reference > Payouts > Payouts [Check Instant Payout eligibility](https://docs.mangopay.com/api-reference/payouts/check-instant-payout-eligibility.md) - API Reference > FX conversions > Conversion rates [View an indicative Conversion Rate](https://docs.mangopay.com/api-reference/conversion-rates/view-conversion-rate.md) - API Reference > FX conversions > Quotes [Create a Quote](https://docs.mangopay.com/api-reference/quotes/create-quote.md) - API Reference > FX conversions > Quotes [View a Quote](https://docs.mangopay.com/api-reference/quotes/view-quote.md) - API Reference > FX conversions > Conversions [Create a Quoted Conversion between user Wallets](https://docs.mangopay.com/api-reference/conversions/create-quoted-conversion-user-wallets.md) - API Reference > FX conversions > Conversions [Create an Instant Conversion between user Wallets](https://docs.mangopay.com/api-reference/conversions/create-instant-conversion-user-wallets.md) - API Reference > FX conversions > Conversions [Create a Quoted Conversion between Client Wallets](https://docs.mangopay.com/api-reference/conversions/create-quoted-conversion-client-wallets.md) - API Reference > FX conversions > Conversions [Create an Instant Conversion between Client Wallets](https://docs.mangopay.com/api-reference/conversions/create-instant-conversion-client-wallets.md) - API Reference > FX conversions > Conversions [View a Conversion](https://docs.mangopay.com/api-reference/conversions/view-conversion.md) - API Reference > Transactions > Transactions [List Transactions for a User](https://docs.mangopay.com/api-reference/transactions/list-transactions-user.md) - API Reference > Transactions > Transactions [List Transactions for a Wallet](https://docs.mangopay.com/api-reference/transactions/list-transactions-wallet.md) - API Reference > Transactions > Transactions [List Transactions for a Client Wallet](https://docs.mangopay.com/api-reference/transactions/list-transactions-client-wallet.md) - API Reference > Transactions > Transactions [List Transactions for a Card](https://docs.mangopay.com/api-reference/transactions/list-transactions-card.md) - API Reference > Transactions > Transactions [List Transactions for a Card Fingerprint](https://docs.mangopay.com/api-reference/transactions/list-transactions-card-fingerprint.md) - API Reference > Transactions > Transactions [List Transactions for a Preauthorization](https://docs.mangopay.com/api-reference/transactions/list-transactions-preauthorization.md) - API Reference > Transactions > Transactions [List Transactions for an Extended Preauthorization](https://docs.mangopay.com/api-reference/transactions/list-transactions-extended-preauthorization.md) - API Reference > Transactions > Transactions [List Transactions for a Deposit Preauthorization](https://docs.mangopay.com/api-reference/transactions/list-transactions-deposit-preauthorization.md) - API Reference > Transactions > Transactions [List Transactions for a Bank Account](https://docs.mangopay.com/api-reference/transactions/list-transactions-bank-account.md) - API Reference > Transactions > Transactions [List Transactions for a Mandate](https://docs.mangopay.com/api-reference/transactions/list-transactions-mandate.md) - API Reference > Transactions > Transactions [List Transactions for a Dispute](https://docs.mangopay.com/api-reference/transactions/list-transactions-dispute.md) - API Reference > Echo > Provider coverage [List Intent external providers](https://docs.mangopay.com/api-reference/echo/list-intent-external-providers.md) - API Reference > Echo > Intents [Create an Intent](https://docs.mangopay.com/api-reference/intents/create-intent.md) - API Reference > Echo > Intents [Cancel an Intent](https://docs.mangopay.com/api-reference/intents/cancel-intent.md) - API Reference > Echo > Intents [Create an Intent Capture](https://docs.mangopay.com/api-reference/intents/create-intent-capture.md) - API Reference > Echo > Intents [Create an Intent Refund](https://docs.mangopay.com/api-reference/intents/create-intent-refund.md) - API Reference > Echo > Intents [Reverse an Intent Refund](https://docs.mangopay.com/api-reference/intents/reverse-intent-refund.md) - API Reference > Echo > Intents [Create an Intent Dispute](https://docs.mangopay.com/api-reference/intents/create-intent-dispute.md) - API Reference > Echo > Intents [Update an Intent Dispute](https://docs.mangopay.com/api-reference/intents/update-intent-dispute.md) - API Reference > Echo > Intents [View an Intent](https://docs.mangopay.com/api-reference/intents/view-intent.md) - API Reference > Echo > Intents [List all Intents](https://docs.mangopay.com/api-reference/intents/list-intents.md) - API Reference > Echo > Intent splits [Create an Intent Split](https://docs.mangopay.com/api-reference/intents/create-intent-split.md) - API Reference > Echo > Intent splits [Update an Intent Split](https://docs.mangopay.com/api-reference/intents/update-intent-split.md) - API Reference > Echo > Intent splits [Execute an Intent Split](https://docs.mangopay.com/api-reference/intents/execute-intent-split.md) - API Reference > Echo > Intent splits [Reverse an Intent Split](https://docs.mangopay.com/api-reference/intents/reverse-intent-split.md) - API Reference > Echo > Intent splits [View an Intent Split](https://docs.mangopay.com/api-reference/intents/view-intent-split.md) - API Reference > Echo > Intent splits [List all Intent Splits](https://docs.mangopay.com/api-reference/intents/list-intent-splits.md) - API Reference > Echo > Settlements [Create a Settlement and generate a secure URL for file upload](https://docs.mangopay.com/api-reference/settlements/create-settlement.md) - API Reference > Echo > Settlements [Upload a settlement file to the secure URL](https://docs.mangopay.com/api-reference/settlements/upload-settlement-file.md) - API Reference > Echo > Settlements [Update a Settlement and generate a new upload URL](https://docs.mangopay.com/api-reference/settlements/update-settlement.md) - API Reference > Echo > Settlements [Cancel a Settlement](https://docs.mangopay.com/api-reference/settlements/cancel-settlement.md) - API Reference > Echo > Settlements [View a Settlement](https://docs.mangopay.com/api-reference/settlements/view-settlement.md) - API Reference > Echo > Settlements [View validation errors for a Settlement](https://docs.mangopay.com/api-reference/settlements/view-settlement-validations.md) - API Reference > Echo > Settlements [List all Settlements](https://docs.mangopay.com/api-reference/settlements/list-settlements.md) - API Reference > Helpers > API responses [View an API Response](https://docs.mangopay.com/api-reference/api-responses/view-api-response.md) - API Reference > Helpers > Country authorizations [View Authorizations for a country](https://docs.mangopay.com/api-reference/country-authorizations/view-authorizations-country.md) - API Reference > Helpers > Country authorizations [List Authorizations for all countries](https://docs.mangopay.com/api-reference/country-authorizations/list-authorizations-countries.md) - API Reference > Helpers > Webhooks [Create a Hook](https://docs.mangopay.com/api-reference/webhooks/create-hook.md) - API Reference > Helpers > Webhooks [Update a Hook](https://docs.mangopay.com/api-reference/webhooks/update-hook.md) - API Reference > Helpers > Webhooks [View a Hook](https://docs.mangopay.com/api-reference/webhooks/view-hook.md) - API Reference > Helpers > Webhooks [List all Hooks](https://docs.mangopay.com/api-reference/webhooks/list-hooks.md) - API Reference > Helpers > Events [List all Events](https://docs.mangopay.com/api-reference/events/list-events.md) - API Reference > Helpers > Reports [Create a Report](https://docs.mangopay.com/api-reference/reporting/create-report.md) - API Reference > Helpers > Reports [View a Report](https://docs.mangopay.com/api-reference/reporting/view-report.md) - API Reference > Helpers > Reports [List all Reports](https://docs.mangopay.com/api-reference/reporting/list-reports.md) - API Reference > Helpers > Reports > Legacy reports [Create a Transactions Report](https://docs.mangopay.com/api-reference/reports/create-transactions-report.md) - API Reference > Helpers > Reports > Legacy reports [Create a Wallets Report](https://docs.mangopay.com/api-reference/reports/create-wallets-report.md) - API Reference > Helpers > Reports > Legacy reports [View a Report](https://docs.mangopay.com/api-reference/reports/view-report.md) - API Reference > Helpers > Reports > Legacy reports [List all Reports](https://docs.mangopay.com/api-reference/reports/list-reports.md) - API Reference > Platform account > Client [Update a Client](https://docs.mangopay.com/api-reference/client/update-client.md) - API Reference > Platform account > Client [Upload a Client logo](https://docs.mangopay.com/api-reference/client/upload-client-logo.md) - API Reference > Platform account > Client [View a Client](https://docs.mangopay.com/api-reference/client/view-client.md) ## OpenAPI Specification The raw OpenAPI 3.1 specification for this API is available at: - [OpenAPI JSON](https://docs.mangopay.com/api-reference/openapi.json) - [OpenAPI YAML](https://docs.mangopay.com/api-reference/openapi.yaml)