Webhooks
Event types
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
| Resource | UserId |
|---|---|
| Related GET | GET View a User’s regulatory status |
| Related guide | Blocked users |
| Event type | USER_INFLOWS_BLOCKED |
|---|---|
| Description | The User has been blocked by Mangopay and can no longer make pay-ins or send or receive transfers. |
| Event type | USER_INFLOWS_UNBLOCKED |
|---|---|
| Description | The User has been unblocked by Mangopay and can now make pay-ins or send or receive transfers. |
| Event type | USER_OUTFLOWS_BLOCKED |
|---|---|
| Description | The User has been blocked by Mangopay and can no longer make payouts or send or receive transfers. |
| Event type | USER_OUTFLOWS_UNBLOCKED |
|---|---|
| Description | The User has been unblocked by Mangopay and can now make payouts or send or receive transfers. |
User account
| Resource | UserId |
|---|---|
| Related GET | GET View a User (SCA) |
| Related guides | SCA |
| Event type | USER_ACCOUNT_VALIDATION_ASKED |
|---|---|
| Description | The Owner User (Natural or Legal Soletrader) has triggered SCA enrollment or re-enrollment via a User endpoint. Their access to Mangopay features 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. |
| Event type | USER_ACCOUNT_ACTIVATED |
|---|---|
| Description | The Owner User (Natural or Legal Soletrader) completed the SCA session successfully following a call to a User endpoint, 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
| Event type | USER_ACCOUNT_CLOSED |
|---|---|
| Description | 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
| Resource | UserId |
|---|---|
| Related GET | GET View a User (SCA) |
| Related guides | SCA |
| Event type | SCA_ENROLLMENT_SUCCEEDED |
|---|---|
| Description | 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. |
| Event type | SCA_ENROLLMENT_EXPIRED |
|---|---|
| Description | 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. |
| Event type | SCA_ENROLLMENT_FAILED |
|---|---|
| Description | 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. |
User category
| Resource | UserId |
|---|---|
| Related GET | GET View a User (SCA) |
| Related guides | Categories |
| Event type | USER_CATEGORY_UPDATED_TO_OWNER |
|---|---|
| Description | 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. |
| Event type | USER_CATEGORY_UPDATED_TO_PAYER |
|---|---|
| Description | The existing user’s UserCategory was changed to PAYER. Re-categorization from OWNER to PAYER is only possible by Mangopay. |
| Event type | USER_CATEGORY_UPDATED_TO_PLATFORM |
|---|---|
| Description | The existing user’s UserCategory was changed to PLATFORM. Categorization as PLATFORM is only possible by Mangopay. |
User KYC status
| Resource | UserId |
|---|---|
| Related GET | GET View a User (SCA) |
| Related guides | User KYC/KYB verification |
| Event type | USER_KYC_LIGHT |
|---|---|
| Description | 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. |
| Event type | USER_KYC_REGULAR |
|---|---|
| Description | The User was KYC/KYB verified by Mangopay.The User’s KYCLevel changed from LIGHT to REGULAR. |
IDV sessions
| Resource | IdvSessionId |
|---|---|
| Related GET | GET View an IDV Session |
| Related guides | Hosted KYC/KYB solution |
| Event type | IDENTITY_VERIFICATION_VALIDATED |
|---|---|
| Description | The IDV Session’s Status changed to VALIDATED and the User became KYC/KYB verified. |
| Event type | IDENTITY_VERIFICATION_FAILED |
|---|---|
| Description | The IDV Session’s Status changed to REFUSED and the User was not KYC/KYB verified. |
| Event type | IDENTITY_VERIFICATION_INCONCLUSIVE |
|---|---|
| Description | 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. |
| Event type | IDENTITY_VERIFICATION_OUTDATED |
|---|---|
| Description | 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. |
User data format
| Resource | UserId |
|---|---|
| Related GET | GET View a User (SCA) |
| Related guides | Company number |
| Event type | LEGAL_COMPANY_NUMBER_VALIDATION_FAILED |
|---|---|
| Description | 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. |
| Event type | LEGAL_COMPANY_NUMBER_VALIDATION_SUCCEEDED |
|---|---|
| Description | 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
| Resource | KYCDocumentId |
|---|---|
| Related GET | GET View a KYC Document |
| Related guides | Submitting KYC documents |
| Event type | KYC_CREATED |
|---|---|
| Description | The KYC Document has been created but not yet submitted for review. |
| Event type | KYC_VALIDATION_ASKED |
|---|---|
| Description | The KYC Document has been submitted for validation and is being processed. |
| Event type | KYC_SUCCEEDED |
|---|---|
| Description | The KYC Document has been validated by Mangopay. |
| Event type | KYC_FAILED |
|---|---|
| Description | The KYC Document has been refused by Mangopay. |
| Event type | KYC_OUTDATED |
|---|---|
| Description | 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
| Resource | UboDeclarationId |
|---|---|
| Related GET | GET View a UBO Declaration |
| Related guides | Beneficial owners |
| Event type | UBO_DECLARATION_CREATED |
|---|---|
| Description | The UBO Declaration has been created but not yet submitted for review. |
| Event type | UBO_DECLARATION_VALIDATION_ASKED |
|---|---|
| Description | The UBO Declaration has been submitted for validation and is being processed. |
| Event type | UBO_DECLARATION_VALIDATED |
|---|---|
| Description | The UBO Declaration has been validated by the Mangopay Compliance team. |
| Event type | UBO_DECLARATION_INCOMPLETE |
|---|---|
| Description | The UBO Declaration is incomplete and additional information or documents may be required. |
| Event type | UBO_DECLARATION_REFUSED |
|---|---|
| Description | The UBO Declaration has been refused by Mangopay. |
Country authorizations
| Resource | CountryCode |
|---|---|
| Related GET | GET View authorizations for a country |
| Related guides | Country restrictions |
| Event type | COUNTRY_AUTHORIZATION_UPDATED |
|---|---|
| Description | The restrictions related to a country have been updated. |
Recipients
| Resource | RecipientId |
|---|---|
| Related GET | GET View a Recipient |
| Related guides | Recipients |
| Event type | RECIPIENT_ACTIVE |
|---|---|
| Description | The Recipient was created successfully, including the SCA session if RecipientScope is OWNER, and it can now be used for payments. |
| Event type | RECIPIENT_CANCELED |
|---|---|
| Description | The Recipient creation was unsuccessful because the SCA session was not successful. The CANCELED status is only relevant if RecipientScope is OWNER. |
| Event type | RECIPIENT_DEACTIVATED |
|---|---|
| Description | The Recipient was permanently deactivated and can no longer be used. |
Pay-ins
All payment methods
| Resource | PayInId |
|---|---|
| Related GET | GET View a PayIn (Direct Card) for example – same endpoint for all payment methods, different response object |
| Related guides | All payment methods |
| Event type | PAYIN_NORMAL_CREATED |
|---|---|
| Description | The PayIn transaction has been created but is not yet processed. |
| Event type | PAYIN_NORMAL_SUCCEEDED |
|---|---|
| Description | The PayIn transaction has been successfully processed. |
| Event type | PAYIN_NORMAL_FAILED |
|---|---|
| Description | The PayIn transaction has failed. |
Card payments
Card validations
| Resource | CardValidationId |
|---|---|
| Related GET | GET View a Card Validation |
| Related guides | Card validation without debit |
| Event type | CARD_VALIDATION_CREATED |
|---|---|
| Description | The Card Validation object has been created and the card is pending validation. |
| Event type | CARD_VALIDATION_FAILED |
|---|---|
| Description | The Card Validation has failed, setting the corresponding card as invalid. |
| Event type | CARD_VALIDATION_SUCCEEDED |
|---|---|
| Description | The Card Validation has succeeded, setting the corresponding card as valid. |
Recurring pay-in registrations
| Resource | RecurringRegistrationId |
|---|---|
| Related GET | GET View a Recurring PayIn Registration |
| Related guides | Recurring card payments |
| Event type | RECURRING_REGISTRATION_CREATED |
|---|---|
| Description | The Recurring Registration object has been successfully created. |
| Event type | RECURRING_REGISTRATION_AUTH_NEEDED |
|---|---|
| Description | A pay-in against this recurring object requires authentication. |
| Event type | RECURRING_REGISTRATION_IN_PROGRESS |
|---|---|
| Description | The Recurring Registration object is in a valid state. Pay-ins against this recurring registration are possible. |
| Event type | RECURRING_REGISTRATION_ENDED |
|---|---|
| Description | The Recurring Registration object has been ended. It is no longer possible to make pay-ins against this recurring registration. |
Preauthorizations
| Resource | PreauthorizationId |
|---|---|
| Related GET | GET View a Preauthorization |
| Related guides | 7-day preauthorization |
| Event type | PREAUTHORIZATION_CREATED |
|---|---|
| Description | The Preauthorization object has been successfully created. |
| Event type | PREAUTHORIZATION_FAILED |
|---|---|
| Description | The authorization of this Preauthorization has failed. |
| Event type | PREAUTHORIZATION_PAYMENT_CANCELED |
|---|---|
| Description | The authorization of this Preauthorization has been canceled. |
| Event type | PREAUTHORIZATION_PAYMENT_EXPIRED |
|---|---|
| Description | The authorization of this Preauthorization has expired. |
| Event type | PREAUTHORIZATION_PAYMENT_VALIDATED |
|---|---|
| Description | The Preauthorization has been successfully debited. |
| Event type | PREAUTHORIZATION_PAYMENT_WAITING |
|---|---|
| Description | The Preauthorization object can now be debited. |
| Event type | PREAUTHORIZATION_SUCCEEDED |
|---|---|
| Description | The authorization of this Preauthorization has been successful. |
Deposit preauthorizations
| Resource | DepositId |
|---|---|
| Related GET | GET View a Deposit Preauthorization |
| Related guides | 30-day deposit preauthorization |
| Event type | DEPOSIT_PREAUTHORIZATION_CREATED |
|---|---|
| Description | The Deposit Preauthorization object has been successfully created. |
| Event type | DEPOSIT_PREAUTHORIZATION_FAILED |
|---|---|
| Description | The authorization of the Deposit Preauthorization has failed. |
| Event type | DEPOSIT_PREAUTHORIZATION_PAYMENT_CANCEL_REQUESTED |
|---|---|
| Description | The request to cancel the Deposit Preauthorization has been taken into account. |
| Event type | DEPOSIT_PREAUTHORIZATION_PAYMENT_CANCELED |
|---|---|
| Description | The Deposit Preauthorization has been successfully canceled. |
| Event type | DEPOSIT_PREAUTHORIZATION_PAYMENT_EXPIRED |
|---|---|
| Description | The authorization of the Deposit Preauthorization has expired. |
| Event type | DEPOSIT_PREAUTHORIZATION_PAYMENT_FAILED |
|---|---|
| Description | The payment action against the Deposit Preauthorization has failed, whether capture without complement, capture prior to complement, no-show request, or complement. A retry may be possible. |
| Event type | DEPOSIT_PREAUTHORIZATION_PAYMENT_NO_SHOW |
|---|---|
| Description | The Deposit Preauthorization wasn’t debited and a no-show has been successfully declared. A pay-in complement can be made. |
| Event type | DEPOSIT_PREAUTHORIZATION_PAYMENT_NO_SHOW_REQUESTED |
|---|---|
| Description | The Deposit Preauthorization wasn’t debited and a request for a no-show has been taken into account. A pay-in complement cannot yet be made. |
| Event type | DEPOSIT_PREAUTHORIZATION_PAYMENT_TO_BE_COMPLETED |
|---|---|
| Description | The Deposit Preauthorization was successfully debited (a successful pay-in against the preauthorization was made). A pay-in complement can be made. |
| Event type | DEPOSIT_PREAUTHORIZATION_PAYMENT_VALIDATED |
|---|---|
| Description | The Deposit Preauthorization has been successfully debited (a successful pay-in against the preauthorization has been made). No further pay-ins can be made. |
| Event type | DEPOSIT_PREAUTHORIZATION_PAYMENT_WAITING |
|---|---|
| Description | The authorization of the Deposit Preauthorization has been successful. It can now be debited. |
Banking payments
Pay by bank
| Resource | PayInId |
|---|---|
| Related GET | GET View a PayIn (Pay by Bank) |
| Related guides | Pay by Bank |
| Event type | PAYIN_NORMAL_PROCESSING_STATUS_PENDING_SUCCEEDED |
|---|---|
| Description | 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
| Resource | VirtualAccountId |
|---|---|
| Related GET | GET View a Virtual Account |
| Related guides | Virtual accounts |
| Event type | VIRTUAL_ACCOUNT_ACTIVE |
|---|---|
| Description | The account is active and can receive funds (see note about delayed UK CoP recognition for GB accounts). |
| Event type | VIRTUAL_ACCOUNT_BLOCKED |
| Description | 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. |
| Event type | VIRTUAL_ACCOUNT_CLOSED |
| Description | The account has been deactivated and is closed. Any funds sent to the account are returned. This is a final state. |
| Event type | VIRTUAL_ACCOUNT_FAILED |
| Description | 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
| Resource | MandateId |
|---|---|
| Related GET | GET View a Mandate |
| Related guides | Direct debit mandates |
| Event type | MANDATE_CREATED |
|---|---|
| Description | The Mandate has been created. |
| Event type | MANDATE_SUBMITTED |
|---|---|
| Description | The Mandate has been successfully validated, an email has been sent to the end user (if emails are configured). |
| Event type | MANDATE_ACTIVATED |
|---|---|
| Description | The Mandate request has been successfully created and validated. A bank wire can be initiated. |
| Event type | MANDATE_FAILED |
|---|---|
| Description | The Mandate request has failed. |
| Event type | MANDATE_EXPIRED |
|---|---|
| Description | The Mandate has expired. It is no longer possible to make bank wire pay-ins against this mandate. |
Disputes
Disputes
| Resource | DisputeId |
|---|---|
| Related GET | GET View a Dispute |
| Related guides | Disputes |
| Event type | DISPUTE_CREATED |
|---|---|
| Description | The Dispute has been created. It can either be closed directly or reviewed by the platform. |
| Event type | DISPUTE_ACTION_REQUIRED |
|---|---|
| Description | The contestable Dispute requires further action. The platform is notified by Mangopay in a short period of time. |
| Event type | DISPUTE_SUBMITTED |
|---|---|
| Description | The Dispute has been contested by the platform, either entirely or partially. |
| Event type | DISPUTE_SENT_TO_BANK |
|---|---|
| Description | The Dispute has been sent to the bank for review and approval following the Dispute Documents validation. |
| Event type | DISPUTE_FURTHER_ACTION_REQUIRED |
|---|---|
| Description | To settle the Dispute, additional documents are required. |
| Event type | DISPUTE_CLOSED |
|---|---|
| Description | The Dispute has been closed. It can either be WON or LOST by the platform. |
Dispute documents
| Resource | DisputeDocumentId |
|---|---|
| Related GET | GET View a Dispute Document |
| Related guides | Disputes |
| Event type | DISPUTE_DOCUMENT_CREATED |
|---|---|
| Description | The Dispute Document has been successfully added to the Dispute, either by the platform or Mangopay’s team. |
| Event type | DISPUTE_DOCUMENT_FAILED |
|---|---|
| Description | The Dispute Document has been refused by Mangopay’s team. |
| Event type | DISPUTE_DOCUMENT_SUCCEEDED |
|---|---|
| Description | The Dispute Document has been validated by Mangopay’s team. |
| Event type | DISPUTE_DOCUMENT_VALIDATION_ASKED |
|---|---|
| Description | The Dispute Document has been sent to Mangopay’s team for validation. |
Repudiations
| Resource | RepudiationId |
|---|---|
| Related GET | GET View a Repudiation |
| Related guides | Disputes |
| Event type | PAYIN_REPUDIATION_CREATED |
|---|---|
| Description | A chargeback has been filed and has been created in Mangopay’s environment (Repudiation Wallet). |
| Event type | PAYIN_REPUDIATION_FAILED |
|---|---|
| Description | A chargeback has been filed but the transaction from the Repudiation Wallet back to the initial pay-in author has failed. |
| Event type | PAYIN_REPUDIATION_SUCCEEDED |
|---|---|
| Description | A chargeback has been filed and successfully sent back to the initial pay-in author. |
Settlement transfers
| Resource | SettlementId |
|---|---|
| Related GET | GET View a Settlement Transfer |
| Related guides | Disputes |
| Event type | TRANSFER_SETTLEMENT_CREATED |
|---|---|
| Description | The Settlement Transfer has been created but is not yet processed. |
| Event type | TRANSFER_SETTLEMENT_FAILED |
|---|---|
| Description | The Settlement Transfer could not be processed. |
| Event type | TRANSFER_SETTLEMENT_SUCCEEDED |
|---|---|
| Description | The Settlement Transfer has been successfully processed. |
Transfers
| Resource | TransferId |
|---|---|
| Related GET | GET View a Transfer |
| Related guides |
| Event type | TRANSFER_NORMAL_CREATED |
|---|---|
| Description | The Transfer has been created but is not yet processed. |
| Event type | TRANSFER_NORMAL_FAILED |
|---|---|
| Description | The Transfer could not be processed. |
| Event type | TRANSFER_NORMAL_SUCCEEDED |
|---|---|
| Description | The Transfer has been successfully processed. |
FX conversions
| Resource | ConversionId |
|---|---|
| Related GET | GET View a Conversion |
| Related guides | Conversions |
Instant conversions
| Event type | INSTANT_CONVERSION_CREATED |
|---|---|
| Description | The Instant Conversion was initiated and its Status changed to CREATED, but is not yet processed. |
| Event type | INSTANT_CONVERSION_SUCCEEDED |
|---|---|
| Description | The Instant Conversion was processed successfully and its Status changed to SUCCEEDED. |
| Event type | INSTANT_CONVERSION_FAILED |
|---|---|
| Description | The Instant Conversion could not be processed. See the ResultCode and ResultMessage for more information about the error that occurred. |
Quoted conversions
| Event type | QUOTED_CONVERSION_CREATED |
|---|---|
| Description | The Quoted Conversion was initiated and its Status changed to CREATED, but is not yet processed. |
| Event type | QUOTED_CONVERSION_SUCCEEDED |
|---|---|
| Description | The Quoted Conversion was processed successfully and its Status changed to SUCCEEDED. |
| Event type | QUOTED_CONVERSION_FAILED |
|---|---|
| Description | The Quoted Conversion could not be processed. See the ResultCode and ResultMessage for more information about the error that occurred. |
Payouts
Standard payouts
| Resource | PayoutId |
|---|---|
| Related GET | GET View a Payout |
| Related guides | Payouts |
| Event type | PAYOUT_NORMAL_CREATED |
|---|---|
| Description | The Payout transaction has been created but is not yet processed. |
| Event type | PAYOUT_NORMAL_FAILED |
|---|---|
| Description | The Payout transaction has failed. |
| Event type | PAYOUT_NORMAL_SUCCEEDED |
|---|---|
| Description | The Payout transaction has been successfully processed. |
Instant payouts
| Resource | PayoutId |
|---|---|
| Related GET | GET View a Payout and check mode applied |
| Related guides | Initiate an SCT Inst payout |
| Event type | INSTANT_PAYOUT_FAILED |
|---|---|
| Description | The Instant Payout transaction has failed. |
| Event type | INSTANT_PAYOUT_FALLBACKED |
|---|---|
| Description | The Payout could not be processed instantly; it will be processed in 48 hours as a standard payout instead. |
| Event type | INSTANT_PAYOUT_SUCCEEDED |
|---|---|
| Description | The Instant Payout transaction has been successfully processed. |
Refunds
Pay-in refunds
| Resource | RefundId |
|---|---|
| Related GET | GET View a Refund |
| Related guides | Refunds - Pay-in |
| Event type | PAYIN_REFUND_CREATED |
|---|---|
| Description | The PayIn Refund transaction has been created but is not yet processed. |
| Event type | PAYIN_REFUND_FAILED |
|---|---|
| Description | The PayIn Refund transaction could not be processed. |
| Event type | PAYIN_REFUND_SUCCEEDED |
|---|---|
| Description | The PayIn Refund transaction has been successfully processed. |
Transfer refunds
| Resource | RefundId |
|---|---|
| Related GET | GET View a Refund |
| Related guides | Refunds - Transfer |
| Event type | TRANSFER_REFUND_CREATED |
|---|---|
| Description | The Transfer Refund has been created but is not yet processed. |
| Event type | TRANSFER_REFUND_FAILED |
|---|---|
| Description | The Transfer Refund transaction could not be processed. |
| Event type | TRANSFER_REFUND_SUCCEEDED |
|---|---|
| Description | The Transfer Refund transaction has been successfully processed. |
Payout returns
| Resource | RefundId |
|---|---|
| Related GET | GET View a Refund |
| Related guides | Payouts - Returns |
| Event type | PAYOUT_REFUND_CREATED |
|---|---|
| Description | The payout return has been created. |
| Event type | PAYOUT_REFUND_FAILED |
|---|---|
| Description | The payout return has failed. |
| Event type | PAYOUT_REFUND_SUCCEEDED |
|---|---|
| Description | The payout return has been successfully processed. |
Reports
| Resource | ReportingId |
|---|---|
| Related GET | GET View a Report |
| Related guides | Reports |
| Event type | REPORT_GENERATED |
|---|---|
| Description | The report has been generated and is ready for download at the DownloadURL value. |
| Event type | REPORT_FAILED |
|---|---|
| Description | The report was not generated successfully. |