Documentation Index
Fetch the complete documentation index at: https://docs.mangopay.com/llms.txt
Use this file to discover all available pages before exploring further.
This page lists the event types for which Mangopay can send webhook notifications.
The event types are listed by feature for each RessourceId on which they occur. Alongside is the GET API call you can use to confirm the event is still valid and retrieve more details, as well as the related guide pages.
To listen to an event type on your chosen URL, set up a webhook in the Mangopay Dashboard (Developers > Webhooks) or using the POST Create a Hook endpoint.
Learn more about webhooks →
User management
User regulatory status
USER_INFLOWS_BLOCKED |
| The User has been blocked by Mangopay and can no longer make pay-ins or send or receive transfers. |
USER_INFLOWS_UNBLOCKED |
| The User has been unblocked by Mangopay and can now make pay-ins or send or receive transfers. |
USER_OUTFLOWS_BLOCKED |
| The User has been blocked by Mangopay and can no longer make payouts or send or receive transfers. |
USER_OUTFLOWS_UNBLOCKED |
| The User has been unblocked by Mangopay and can now make payouts or send or receive transfers. |
User account
USER_ACCOUNT_VALIDATION_ASKED |
The Owner User (Natural or Legal Soletrader) has triggered SCA enrollment or re-enrollment via a User endpoint. Their access to SCA-triggering actions is restricted until they complete the SCA redirection to enroll successfully.
This event is only triggered when the User’s UserStatus changes to PENDING_USER_ACTION, which only happens in the situations described here.
To obtain a new SCA redirection link to retry enrollment, call the POST Enroll a User endpoint. |
USER_ACCOUNT_ACTIVATED |
The Owner User (Natural or Legal Soletrader) completed an SCA session successfully, and can now access Mangopay features.
This event is only triggered when the User’s UserStatus changes from PENDING_USER_ACTION to ACTIVE. |
Account closure
USER_ACCOUNT_CLOSED |
The User (Owner or Payer) was permanently closed and their UserStatus changed to CLOSED.
The User was closed either by the platform, using the dedicated endpoint for Natural or Legal users, or by Mangopay as per the terms and conditions.
A user can only be closed if all the wallets they hold are empty. |
Mangopay SCA enrollment
SCA_ENROLLMENT_SUCCEEDED |
The user enrolled in Mangopay’s SCA feature successfully.
This event is triggered by any new enrollment (or re-enrollment) prompted by an API call, regardless of the endpoint that returned the SCA redirection link (users, recipients, transfers, wallets – see full list of endpoints).
This event is not triggered by authentication challenges once the user is enrolled. |
SCA_ENROLLMENT_EXPIRED |
The SCA enrollment session expired after 10 minutes before the user completed all steps to enroll all factors. To retry the enrollment, call another API endpoint that triggers SCA.
This event is not triggered by authentication challenges once the user is enrolled. |
SCA_ENROLLMENT_FAILED |
The user attempt enrollment but reached the maximum number of retries for one of the factors. To retry the enrollment, call another API endpoint that triggers SCA.
This event is not triggered by authentication challenges once the user is enrolled. |
Mangopay SCA email and phone number verification
SCA_EMAIL_VERIFIED |
The email address required for SCA was successfully verified by the completion of an SCA session after it was added or changed via an API call.
Note that a user cannot modify their email address from within an SCA session. |
SCA_PHONE_NUMBER_VERIFIED |
| The phone number used for SCA’s OTP factor was verified by the completion of an SCA session after it was changed either from within an SCA session or via an API call. |
Proxy consent status for SCA-triggering action scopes
SCA_CONTACT_INFORMATION_UPDATE_CONSENT_GIVEN |
The user checked the checkbox (and completed the SCA session) to give consent for your platform to update the User’s SCA contact information on their behalf, which you can do by setting ScaContext to USER_NOT_PRESENT in a call to: |
SCA_TRANSFER_CONSENT_GIVEN |
The user checked the checkbox (and completed the SCA session) to give consent for your platform to initiate a transfer to another OWNER user on their behalf, which you can do by setting ScaContext to USER_NOT_PRESENT in a call to: |
SCA_RECIPIENT_REGISTRATION_CONSENT_GIVEN |
The user checked the checkbox (and completed the SCA session) to give consent for your platform to register an external bank or payment account on their behalf, which you can do by setting ScaContext to USER_NOT_PRESENT in a call to: |
SCA_VIEW_ACCOUNT_INFORMATION_CONSENT_GIVEN |
The user checked the checkbox (and completed the SCA session) to give consent for your platform to retrieve wallet and transaction data on their behalf, which you can do by setting ScaContext to USER_NOT_PRESENT in a call to: |
SCA_CONTACT_INFORMATION_UPDATE_CONSENT_REVOKED |
| The user unchecked the checkbox (and completed the SCA session) to revoke consent to your platform updating the User’s SCA contact information on their behalf. |
SCA_TRANSFER_CONSENT_REVOKED |
The user unchecked the checkbox (and completed the SCA session) to revoke consent for your platform to initiate a transfer to another OWNER user on their behalf. |
SCA_RECIPIENT_REGISTRATION_CONSENT_REVOKED |
| The user unchecked the checkbox (and completed the SCA session) to revoke consent for your platform to register an external bank or payment account on their behalf. |
SCA_VIEW_ACCOUNT_INFORMATION_CONSENT_REVOKED |
| The user checked the checkbox (and completed the SCA session) to give consent for your platform to retrieve wallet and transaction data on their behalf |
User category
USER_CATEGORY_UPDATED_TO_OWNER |
The existing user’s UserCategory was changed to OWNER.
This event is not triggered if OWNER is set at user creation. This event usually coincides with SCA, triggering USER_ACCOUNT_VALIDATION_ASKED. |
USER_CATEGORY_UPDATED_TO_PAYER |
The existing user’s UserCategory was changed to PAYER. Re-categorization from OWNER to PAYER is only possible by Mangopay. |
USER_CATEGORY_UPDATED_TO_PLATFORM |
The existing user’s UserCategory was changed to PLATFORM. Categorization as PLATFORM is only possible by Mangopay. |
User KYC status
USER_KYC_LIGHT |
The User is not KYC/KYB verified by Mangopay and is therefore subject to KYC/KYB verification limits.
The User’s KYCLevel has changed from REGULAR to LIGHT. |
USER_KYC_REGULAR |
The User was KYC/KYB verified by Mangopay.The User’s KYCLevel changed from LIGHT to REGULAR. |
IDV sessions
IDENTITY_VERIFICATION_VALIDATED |
The IDV Session’s Status changed to PENDING and the session is available and hasn’t been completed. The session may or may not have been started and is valid for 24 hours from creation. |
IDENTITY_VERIFICATION_VALIDATED |
The IDV Session’s Status changed to VALIDATED and the User became KYC/KYB verified. |
IDENTITY_VERIFICATION_FAILED |
The IDV Session’s Status changed to REFUSED and the User was not KYC/KYB verified. A new session is needed for them to retry. |
IDENTITY_VERIFICATION_INCONCLUSIVE |
The IDV Session’s Status changed to REVIEW and the session is under manual review by Mangopay’s teams before an outcome can be given. |
IDENTITY_VERIFICATION_OUTDATED |
The IDV Session’s Status changed to OUT_OF_DATE indicating that the user’s KYC/KYB verification status was downgraded. To regain KYC/KYB verified status, the user must complete a new IDV Session successfully. |
LEGAL_COMPANY_NUMBER_VALIDATION_FAILED |
| The format of the company number is not valid for the headquarters address country of the Business-type Legal User. A invalid format blocks verification. |
LEGAL_COMPANY_NUMBER_VALIDATION_SUCCEEDED |
| The format of the company number is valid for the headquarters address country of the Business-type Legal User. The format is as expected for the country of registration but the veracity of the data has not yet been verified. |
KYC documents
KYC_CREATED |
| The KYC Document has been created but not yet submitted for review. |
KYC_VALIDATION_ASKED |
| The KYC Document has been submitted for validation and is being processed. |
KYC_SUCCEEDED |
| The KYC Document has been validated by Mangopay. |
KYC_FAILED |
| The KYC Document has been refused by Mangopay. |
KYC_OUTDATED |
| The KYC Document is no longer valid. This is due to an amendment of the user’s identity or other key details as per the KYC/KYB verification downgrade. |
UBO declarations
UBO_DECLARATION_CREATED |
| The UBO Declaration has been created but not yet submitted for review. |
UBO_DECLARATION_VALIDATION_ASKED |
| The UBO Declaration has been submitted for validation and is being processed. |
UBO_DECLARATION_VALIDATED |
| The UBO Declaration has been validated by the Mangopay Compliance team. |
UBO_DECLARATION_INCOMPLETE |
| The UBO Declaration is incomplete and additional information or documents may be required. |
UBO_DECLARATION_REFUSED |
| The UBO Declaration has been refused by Mangopay. |
Country authorizations
COUNTRY_AUTHORIZATION_UPDATED |
| The restrictions related to a country have been updated. |
Recipients
RECIPIENT_ACTIVE |
The Recipient was created successfully, including the SCA session if RecipientScope is OWNER, and it can now be used for payments. |
RECIPIENT_CANCELED |
The Recipient creation was unsuccessful because the SCA session was not successful. The CANCELED status is only relevant if RecipientScope is OWNER. |
RECIPIENT_DEACTIVATED |
| The Recipient was permanently deactivated and can no longer be used. |
Pay-ins
All payment methods
PAYIN_NORMAL_CREATED |
| The PayIn transaction has been created but is not yet processed. |
PAYIN_NORMAL_SUCCEEDED |
| The PayIn transaction has been successfully processed. |
PAYIN_NORMAL_FAILED |
| The PayIn transaction has failed. |
Card payments
Card validations
CARD_VALIDATION_CREATED |
| The Card Validation object has been created and the card is pending validation. |
CARD_VALIDATION_FAILED |
| The Card Validation has failed, setting the corresponding card as invalid. |
CARD_VALIDATION_SUCCEEDED |
| The Card Validation has succeeded, setting the corresponding card as valid. |
Recurring pay-in registrations
RECURRING_REGISTRATION_CREATED |
| The Recurring Registration object has been successfully created. |
RECURRING_REGISTRATION_AUTH_NEEDED |
| A pay-in against this recurring object requires authentication. |
RECURRING_REGISTRATION_IN_PROGRESS |
| The Recurring Registration object is in a valid state. Pay-ins against this recurring registration are possible. |
RECURRING_REGISTRATION_ENDED |
| The Recurring Registration object has been ended. It is no longer possible to make pay-ins against this recurring registration. |
Preauthorizations
PREAUTHORIZATION_CREATED |
| The Preauthorization object has been successfully created. |
PREAUTHORIZATION_FAILED |
| The authorization of this Preauthorization has failed. |
PREAUTHORIZATION_PAYMENT_CANCELED |
| The authorization of this Preauthorization has been canceled. |
PREAUTHORIZATION_PAYMENT_EXPIRED |
| The authorization of this Preauthorization has expired. |
PREAUTHORIZATION_PAYMENT_VALIDATED |
| The Preauthorization has been successfully debited. |
PREAUTHORIZATION_PAYMENT_WAITING |
| The Preauthorization object can now be debited. |
PREAUTHORIZATION_SUCCEEDED |
| The authorization of this Preauthorization has been successful. |
Deposit preauthorizations
DEPOSIT_PREAUTHORIZATION_CREATED |
| The Deposit Preauthorization object has been successfully created. |
DEPOSIT_PREAUTHORIZATION_PAYMENT_WAITING |
| The authorization of the Deposit Preauthorization has been successful. It can now be debited. |
DEPOSIT_PREAUTHORIZATION_PAYMENT_VALIDATED |
| The Deposit Preauthorization has been successfully debited: a successful pay-in against the preauthorization has been made. No further action can be taken. |
DEPOSIT_PREAUTHORIZATION_PAYMENT_FAILED |
| The payment action against the Deposit Preauthorization has failed. A retry may be possible. |
DEPOSIT_PREAUTHORIZATION_FAILED |
| The authorization of the Deposit Preauthorization has failed. |
DEPOSIT_PREAUTHORIZATION_PAYMENT_CANCEL_REQUESTED |
| The request to cancel the Deposit Preauthorization has been taken into account. |
DEPOSIT_PREAUTHORIZATION_PAYMENT_CANCELED |
| The Deposit Preauthorization has been successfully canceled. |
DEPOSIT_PREAUTHORIZATION_PAYMENT_EXPIRED |
| The authorization of the Deposit Preauthorization has expired. |
Banking payments
Pay by bank
PAYIN_NORMAL_PROCESSING_STATUS_PENDING_SUCCEEDED |
The Pay by Bank PayIn has been successfully initiated by the user. The funds have not yet arrived on Mangopay’s bank account and the pay-in Status is still CREATED. |
Virtual accounts
VIRTUAL_ACCOUNT_ACTIVE |
The account is active and can receive funds (see note about delayed UK CoP recognition for GB accounts). |
VIRTUAL_ACCOUNT_BLOCKED |
| The account is blocked and is not active. Any funds sent to the account are returned. This temporary status may be used during processes relating to user verification or fraud screening. |
VIRTUAL_ACCOUNT_CLOSED |
| The account has been deactivated and is closed. Any funds sent to the account are returned. This is a final state. |
VIRTUAL_ACCOUNT_FAILED |
| The account creation request failed or was rejected. This final state is rare. Any funds sent to the account are returned (if account details exist). |
Direct debit mandates
MANDATE_CREATED |
| The Mandate has been created. |
MANDATE_SUBMITTED |
| The Mandate has been successfully validated, an email has been sent to the end user (if emails are configured). |
MANDATE_ACTIVATED |
| The Mandate request has been successfully created and validated. A bank wire can be initiated. |
MANDATE_FAILED |
| The Mandate request has failed. |
MANDATE_EXPIRED |
| The Mandate has expired. It is no longer possible to make bank wire pay-ins against this mandate. |
Disputes
Disputes
DISPUTE_CREATED |
| The Dispute has been created. It can either be closed directly or reviewed by the platform. |
DISPUTE_ACTION_REQUIRED |
| The contestable Dispute requires further action. The platform is notified by Mangopay in a short period of time. |
DISPUTE_SUBMITTED |
| The Dispute has been contested by the platform, either entirely or partially. |
DISPUTE_SENT_TO_BANK |
| The Dispute has been sent to the bank for review and approval following the Dispute Documents validation. |
DISPUTE_FURTHER_ACTION_REQUIRED |
| To settle the Dispute, additional documents are required. |
DISPUTE_CLOSED |
The Dispute has been closed. It can either be WON or LOST by the platform. |
Dispute documents
DISPUTE_DOCUMENT_CREATED |
| The Dispute Document has been successfully added to the Dispute, either by the platform or Mangopay’s team. |
DISPUTE_DOCUMENT_FAILED |
| The Dispute Document has been refused by Mangopay’s team. |
DISPUTE_DOCUMENT_SUCCEEDED |
| The Dispute Document has been validated by Mangopay’s team. |
DISPUTE_DOCUMENT_VALIDATION_ASKED |
| The Dispute Document has been sent to Mangopay’s team for validation. |
Repudiations
PAYIN_REPUDIATION_CREATED |
| A chargeback has been filed and has been created in Mangopay’s environment (Repudiation Wallet). |
PAYIN_REPUDIATION_FAILED |
| A chargeback has been filed but the transaction from the Repudiation Wallet back to the initial pay-in author has failed. |
PAYIN_REPUDIATION_SUCCEEDED |
| A chargeback has been filed and successfully sent back to the initial pay-in author. |
Settlement transfers
TRANSFER_SETTLEMENT_CREATED |
| The Settlement Transfer has been created but is not yet processed. |
TRANSFER_SETTLEMENT_FAILED |
| The Settlement Transfer could not be processed. |
TRANSFER_SETTLEMENT_SUCCEEDED |
| The Settlement Transfer has been successfully processed. |
Transfers
TRANSFER_NORMAL_CREATED |
| The Transfer has been created but is not yet processed. |
TRANSFER_NORMAL_FAILED |
| The Transfer could not be processed. |
TRANSFER_NORMAL_SUCCEEDED |
| The Transfer has been successfully processed. |
FX conversions
Instant conversions
INSTANT_CONVERSION_CREATED |
The Instant Conversion was initiated and its Status changed to CREATED, but is not yet processed. |
INSTANT_CONVERSION_SUCCEEDED |
The Instant Conversion was processed successfully and its Status changed to SUCCEEDED. |
INSTANT_CONVERSION_FAILED |
The Instant Conversion could not be processed. See the ResultCode and ResultMessage for more information about the error that occurred. |
Quoted conversions
QUOTED_CONVERSION_CREATED |
The Quoted Conversion was initiated and its Status changed to CREATED, but is not yet processed. |
QUOTED_CONVERSION_SUCCEEDED |
The Quoted Conversion was processed successfully and its Status changed to SUCCEEDED. |
QUOTED_CONVERSION_FAILED |
The Quoted Conversion could not be processed. See the ResultCode and ResultMessage for more information about the error that occurred. |
Payouts
Standard payouts
PAYOUT_NORMAL_CREATED |
| The Payout transaction has been created but is not yet processed. |
PAYOUT_NORMAL_FAILED |
| The Payout transaction has failed. |
PAYOUT_NORMAL_SUCCEEDED |
| The Payout transaction has been successfully processed. |
Instant payouts
INSTANT_PAYOUT_FAILED |
| The Instant Payout transaction has failed. |
INSTANT_PAYOUT_FALLBACKED |
| The Payout could not be processed instantly; it will be processed in 48 hours as a standard payout instead. |
INSTANT_PAYOUT_SUCCEEDED |
| The Instant Payout transaction has been successfully processed. |
Refunds
Pay-in refunds
PAYIN_REFUND_CREATED |
| The PayIn Refund transaction has been created but is not yet processed. |
PAYIN_REFUND_FAILED |
| The PayIn Refund transaction could not be processed. |
PAYIN_REFUND_SUCCEEDED |
| The PayIn Refund transaction has been successfully processed. |
Transfer refunds
TRANSFER_REFUND_CREATED |
| The Transfer Refund has been created but is not yet processed. |
TRANSFER_REFUND_FAILED |
| The Transfer Refund transaction could not be processed. |
TRANSFER_REFUND_SUCCEEDED |
| The Transfer Refund transaction has been successfully processed. |
Payout returns
PAYOUT_REFUND_CREATED |
| The payout return has been created. |
PAYOUT_REFUND_FAILED |
| The payout return has failed. |
PAYOUT_REFUND_SUCCEEDED |
| The payout return has been successfully processed. |
Echo
Intents
INTENT_AUTHORIZED |
| The Intent was successfully created. |
INTENT_CAPTURED |
| The Intent Capture was successfully processed. |
INTENT_REFUNDED |
| The Intent Refund was successfully processed. |
INTENT_REFUND_REVERSED |
| The Intent Refund was successfully reversed. |
INTENT_DISPUTE_CREATED |
| The Intent Dispute was successfully processed. |
INTENT_DISPUTE_DEFENDED |
The Intent Dispute Status was successfully changed to DEFENDED. |
INTENT_DISPUTE_WON |
The Intent Dispute was successfully processed as WON. |
INTENT_DISPUTE_LOST |
The Intent Dispute was successfully processed as LOST. |
INTENT_SETTLED_NOT_PAID |
| The Intent was successfully reconciled. |
INTENT_PAID |
| The Intent was successfully paid. |
Intent Splits
SPLIT_CREATED |
| The Split was successfully created. |
SPLIT_PENDING_FUNDS_RECEPTION |
| The Split was successfully reconciled. |
SPLIT_AVAILABLE |
| The Split was successfully paid. |
SPLIT_REJECTED |
| The Split could not be processed due to a technical issue, and can be retried. |
SPLIT_REVERSED |
| The Split was successfully reversed. |
Reports
REPORT_GENERATED |
The report has been generated and is ready for download at the DownloadURL value. |
REPORT_FAILED |
| The report was not generated successfully. |
