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.
User management
User regulatory status
| Resource | UserId |
|---|---|
| Related GET | GET View the Regulatory Status of a User |
| Related guide | Blocked users |
| Event type | Description |
|---|---|
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
| Resource | UserId |
|---|---|
| Related GET | GET View a User (SCA) |
| Related guides | SCA |
| Event type | Description |
|---|---|
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 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 |
Account closure
| Event type | Description |
|---|---|
USER_ACCOUNT_CLOSED | The User (Owner or Payer) was permanently closed and their 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 | Description |
|---|---|
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
| Resource | UserId |
|---|---|
| Related GET | GET View a User (SCA) |
| Related guides | SCA |
| Event type | Description |
|---|---|
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
| Resource | UserId |
|---|---|
| Related GET | GET View the SCA status of a User (SCA) |
| Related guides | SCA |
| Event type | Description |
|---|---|
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
|
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 |
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 |
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 |
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 |
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
| Resource | UserId |
|---|---|
| Related GET | GET View a User (SCA) |
| Related guides | Categories |
| Event type | Description |
|---|---|
USER_CATEGORY_UPDATED_TO_OWNER | The existing user’s This event is not triggered if |
USER_CATEGORY_UPDATED_TO_PAYER | The existing user’s |
USER_CATEGORY_UPDATED_TO_PLATFORM | The existing user’s |
User KYC status
| Resource | UserId |
|---|---|
| Related GET | |
| Related guides |
| Event type | Description |
|---|---|
USER_KYC_LIGHT | The User is not KYC/KYB verified by Mangopay and is therefore subject to KYC/KYB verification limits. The User’s |
USER_KYC_REGULAR | The User was KYC/KYB verified by Mangopay. The User’s |
User KYC renewal
| Resource | UserId |
|---|---|
| Related GET | |
| Related guides |
| Event type | Description |
|---|---|
USER_KYC_RENEWAL_REQUIRED | The User’s If the KYC/KYB verification process is not successfully completed before the end of this date (UTC), then the User’s As a result, the User will be subject to the same limits as an unverified user. For platforms in the EEA, this means they will be unable to request payouts. |
USER_KYC_RENEWED | The User has successfully completed the KYC/KYB verification process and a new The User’s |
The previously released event type USER_KYC_RENEWAL is redundant and will be removed in future.
IDV sessions
| Resource | IdvSessionId |
|---|---|
| Related GET | GET View an IDV Session |
| Related guides | Hosted KYC/KYB solution |
| Event type | Description |
|---|---|
IDENTITY_VERIFICATION_PENDING | The IDV Session’s After 7 days, the |
IDENTITY_VERIFICATION_VALIDATED | The IDV Session’s |
IDENTITY_VERIFICATION_FAILED | The IDV Session’s |
IDENTITY_VERIFICATION_INCONCLUSIVE | The IDV Session’s |
IDENTITY_VERIFICATION_OUTDATED | The IDV Session’s |
| Event type | IDENTITY_VERIFICATION_EXPIRED |
|---|---|
| Description | The IDV Session’s |
| Event type | IDENTITY_VERIFICATION_PENDING_PSC_ACTION |
|---|---|
| Description | The IDV Session has one or more PSCs whose hosted verification link is ready to be completed. Use this event to retrieve each PSC’s |
PSC sessions
| Resource | PscId |
|---|---|
| Related GET | GET View an IDV Session (via the PSCs array) |
| Related guides | Multi-session PSC flow for Business |
| Event type | IDENTITY_VERIFICATION_PSC_PENDING |
|---|---|
| Description | The PSC’s |
| Event type | IDENTITY_VERIFICATION_PSC_VALIDATED |
|---|---|
| Description | The PSC’s |
| Event type | IDENTITY_VERIFICATION_PSC_REJECTED |
|---|---|
| Description | The PSC’s |
| Event type | IDENTITY_VERIFICATION_PSC_ABANDONED |
|---|---|
| Description | The PSC’s |
User data format
| Resource | UserId |
|---|---|
| Related GET | GET View a User (SCA) |
| Related guides | Company number |
| Event type | Description |
|---|---|
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
| Resource | KYCDocumentId |
|---|---|
| Related GET | GET View a KYC Document |
| Related guides | Submitting KYC documents |
| Event type | Description |
|---|---|
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
| Resource | UboDeclarationId |
|---|---|
| Related GET | GET View a UBO Declaration |
| Related guides | Beneficial owners |
| Event type | Description |
|---|---|
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
| Resource | CountryCode |
|---|---|
| Related GET | GET View authorizations for a country |
| Related guides | Country restrictions |
| Event type | Description |
|---|---|
COUNTRY_AUTHORIZATION_UPDATED | The restrictions related to a country have been updated. |
Recipients
| Resource | RecipientId |
|---|---|
| Related GET | GET View a Recipient |
| Related guides | Recipients |
| Event type | Description |
|---|---|
RECIPIENT_ACTIVE | The Recipient was created successfully, including the SCA session if |
RECIPIENT_CANCELED | The Recipient creation was unsuccessful because the SCA session was not successful. The |
RECIPIENT_DEACTIVATED | 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 | Description |
|---|---|
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
| Resource | CardValidationId |
|---|---|
| Related GET | GET View a Card Validation |
| Related guides | Card validation without debit |
| Event type | Description |
|---|---|
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
| Resource | RecurringRegistrationId |
|---|---|
| Related GET | GET View a Recurring PayIn Registration |
| Related guides | Recurring card payments |
| Event type | Description |
|---|---|
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
| Resource | PreauthorizationId |
|---|---|
| Related GET | GET View a Preauthorization |
| Related guides | 7-day preauthorization |
| Event type | Description |
|---|---|
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
Note – Disclaimer about terminology
The use of the term “deposit” in this feature is for convenience only and does not constitute a traditional banking deposit under applicable banking regulations, including the EU Capital Requirements Directive (Directive 2013/36/EU) or the Deposit Guarantee Schemes Directive (Directive 2014/49/EU). Accordingly, these funds are not covered by any statutory deposit protection schemes, and Mangopay does not operate as a licensed banking institution.
| Resource | DepositId |
|---|---|
| Related GET | GET View a Deposit Preauthorization |
| Related guides |
|
| Event type | Description |
|---|---|
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
| Resource | PayInId |
|---|---|
| Related GET | GET View a PayIn (Pay by Bank) |
| Related guides | Pay by Bank |
| Event type | Description |
|---|---|
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 |
Virtual accounts
| Resource | VirtualAccountId |
|---|---|
| Related GET | GET View a Virtual Account |
| Related guides | Virtual accounts |
| Event type | Description |
|---|---|
VIRTUAL_ACCOUNT_ACTIVE | The account is active and can receive funds (see note about delayed UK CoP recognition for |
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
| Resource | MandateId |
|---|---|
| Related GET | GET View a Mandate |
| Related guides | Direct debit mandates |
| Event type | Description |
|---|---|
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
| Resource | DisputeId |
|---|---|
| Related GET | GET View a Dispute |
| Related guides | Disputes |
| Event type | Description |
|---|---|
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 |
Dispute documents
| Resource | DisputeDocumentId |
|---|---|
| Related GET | GET View a Dispute Document |
| Related guides | Disputes |
| Event type | Description |
|---|---|
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
| Resource | RepudiationId |
|---|---|
| Related GET | GET View a Repudiation |
| Related guides | Disputes |
| Event type | Description |
|---|---|
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
| Resource | SettlementId |
|---|---|
| Related GET | GET View a Settlement Transfer |
| Related guides | Disputes |
| Event type | Description |
|---|---|
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
| Resource | TransferId |
|---|---|
| Related GET | GET View a Transfer |
| Related guides |
| Event type | Description |
|---|---|
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
| Resource | ConversionId |
|---|---|
| Related GET | GET View a Conversion |
| Related guides | Conversions |
Instant conversions
| Event type | Description |
|---|---|
INSTANT_CONVERSION_CREATED | The Instant Conversion was initiated and its |
INSTANT_CONVERSION_SUCCEEDED | The Instant Conversion was processed successfully and its |
INSTANT_CONVERSION_FAILED | The Instant Conversion could not be processed. See the |
Quoted conversions
| Event type | Description |
|---|---|
QUOTED_CONVERSION_CREATED | The Quoted Conversion was initiated and its |
QUOTED_CONVERSION_SUCCEEDED | The Quoted Conversion was processed successfully and its |
QUOTED_CONVERSION_FAILED | The Quoted Conversion could not be processed. See the |
Payouts
Standard payouts
| Resource | PayoutId |
|---|---|
| Related GET | GET View a Payout |
| Related guides | Payouts |
| Event type | Description |
|---|---|
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
| Resource | PayoutId |
|---|---|
| Related GET | GET View a Payout and check mode applied |
| Related guides | Initiate an SCT Inst payout |
| Event type | Description |
|---|---|
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
| Resource | RefundId |
|---|---|
| Related GET | GET View a Refund |
| Related guides | Refunds - Pay-in |
| Event type | Description |
|---|---|
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
| Resource | RefundId |
|---|---|
| Related GET | GET View a Refund |
| Related guides | Refunds - Transfer |
| Event type | Description |
|---|---|
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
| Resource | RefundId |
|---|---|
| Related GET | GET View a Refund |
| Related guides | Payouts - Returns |
| Event type | Description |
|---|---|
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
| Resource | Intent CaptureId |
|---|---|
| Related GET | GET View an Intent |
| Related guides | Echo |
| Event type | Description |
|---|---|
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 |
INTENT_DISPUTE_WON | The Intent Dispute was successfully processed as |
INTENT_DISPUTE_LOST | The Intent Dispute was successfully processed as |
INTENT_SETTLED_NOT_PAID | The Intent was successfully reconciled. |
INTENT_PAID | The Intent was successfully paid. |
Intent Splits
| Resource | Intent SplitId |
|---|---|
| Related GET | GET View an Intent |
| Related guides | Echo |
| Event type | Description |
|---|---|
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. |
Settlements
| Resource | SettlementId |
|---|---|
| Related GET | GET View a Settlement |
| Related guides | Echo |
| Event type | Description |
|---|---|
SETTLEMENT_PENDING_UPLOAD | The Settlement object and |
SETTLEMENT_UPLOADED | A file was uploaded. |
SETTLEMENT_CREATED | The uploaded file was considered valid and reconciliation is in progress. A file is considered valid when it includes all required columns and a properly formatted footer. |
SETTLEMENT_UNMATCHED | None of the entries in the settlement file match the declared Intents. Call PUT Update a Settlement and generate a new upload URL to re-submit. |
SETTLEMENT_PARTIALLY_MATCHED | The settlement file was parsed and some lines matched successfully. If at least one line is incorrectly formatted, the file remains in this status and does not progress further. Cancel the Settlement and re-submit. |
SETTLEMENT_PENDING_FUNDS_RECEPTION | The settlement file was parsed and fully matched with Intents; waiting for funds to arrive on the technical wallet. |
SETTLEMENT_INSUFFICIENT_FUNDS | A partial amount was received on the technical wallet. The |
SETTLEMENT_RECONCILED | The full settlement amount ( |
SETTLEMENT_FAILED | The settlement file was rejected due to a technical error (e.g. format, timeout). Call POST Create a Settlement to create a new object. |
SETTLEMENT_CANCELLED | The settlement file was invalidated due to a reconciliation error. Once canceled, no further actions can be taken on this Settlement. Call POST Create a Settlement to create a new object. |
Reports
| Resource | ReportingId |
|---|---|
| Related GET | GET View a Report |
| Related guides | Reports |
| Event type | Description |
|---|---|
REPORT_GENERATED | The report has been generated and is ready for download at the |
REPORT_FAILED | The report was not generated successfully. |