ResourcesWebhooks

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

ResourceUserId
Related GETGET View the Regulatory Status of a User
Related guideBlocked users

Event typeDescription
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

ResourceUserId
Related GETGET View a User (SCA)
Related guidesSCA

Event typeDescription
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

Event typeDescription
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

ResourceUserId
Related GETGET View a User (SCA)
Related guidesSCA

Event typeDescription
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

ResourceUserId
Related GETGET View a User (SCA)
Related guidesSCA

Event typeDescription
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.

ResourceUserId
Related GETGET View the SCA status of a User (SCA)
Related guidesSCA

Event typeDescription
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

ResourceUserId
Related GETGET View a User (SCA)
Related guidesCategories

Event typeDescription
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

ResourceUserId
Related GET

GET View a User (SCA)

Related guides

User KYC/KYB verification


Event typeDescription
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.

User KYC renewal

ResourceUserId
Related GET

GET View the Regulatory Status of a User

Related guides

User KYC/KYB renewal


Event typeDescription
USER_KYC_RENEWAL_REQUIRED

The User’s KycRenewalDeadline is in 90 days.

If the KYC/KYB verification process is not successfully completed before the end of this date (UTC), then the User’s KYCLevel will be downgraded to LIGHT the following day.

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 KycRenewalDeadline has been set.

The User’s KYCLevel has not changed and remains REGULAR.


The previously released event type USER_KYC_RENEWAL is redundant and will be removed in future.

IDV sessions

ResourceIdvSessionId
Related GETGET View an IDV Session
Related guidesHosted KYC/KYB solution

Event typeDescription
IDENTITY_VERIFICATION_PENDING

The IDV Session’s Status is PENDING. The HostedUrl link is valid for completion and must be submitted within 7 days. The session may or may not have been started.

After 7 days, the Status of the IDV Session object changes to EXPIRED and can no longer be submitted. However, the link returned on HostedUrl remains active.

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.

Event typeIDENTITY_VERIFICATION_EXPIRED
Description

The IDV Session’s Status changed to EXPIRED, without being completed. By default, this happens 7 days after its CreationDate, but if the liveness step had been started (the QR code was generated), it happens 1 hour after the liveness step started instead. A new session is needed to retry.

Event typeIDENTITY_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 HostedUrl from the PSCs array via GET View an IDV Session and send it to them directly, if you’re not relying on Mangopay to email PSCs.

PSC sessions

ResourcePscId
Related GETGET View an IDV Session (via the PSCs array)
Related guidesMulti-session PSC flow for Business

Event typeIDENTITY_VERIFICATION_PSC_PENDING
Description

The PSC’s Status (in the PSCs array) changed to PENDING_VALIDATION. This occurs when The PSC Session is created, retried, or recreated (for example, after a partial match against an existing PSC).

Event typeIDENTITY_VERIFICATION_PSC_VALIDATED
Description

The PSC’s Status (in the PSCs array) changed to VALIDATED.

Event typeIDENTITY_VERIFICATION_PSC_REJECTED
Description

The PSC’s Status (in the PSCs array) changed to REJECTED. This occurs if one or more checks failed, or if the PSC did not complete the verification within the allowed timeframe (by default 7 days after the PSC Session’s CreationDate, or 1 hour after the liveness step started if it had been started). Use PUT Retry a PSC Session to generate a new session link for the PSC.

Event typeIDENTITY_VERIFICATION_PSC_ABANDONED
Description

The PSC’s Status (in the PSCs array) changed to ABANDONED. This action can only be performed by Mangopay, for example if the PSC was a duplicate of another declared PSC.

User data format

ResourceUserId
Related GETGET View a User (SCA)
Related guidesCompany number

Event typeDescription
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

ResourceKYCDocumentId
Related GETGET View a KYC Document
Related guidesSubmitting KYC documents

Event typeDescription
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

ResourceUboDeclarationId
Related GETGET View a UBO Declaration
Related guidesBeneficial owners

Event typeDescription
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

ResourceCountryCode
Related GETGET View authorizations for a country
Related guidesCountry restrictions

Event typeDescription
COUNTRY_AUTHORIZATION_UPDATED

The restrictions related to a country have been updated.

Recipients

ResourceRecipientId
Related GETGET View a Recipient
Related guidesRecipients

Event typeDescription
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

ResourcePayInId
Related GETGET View a PayIn (Direct Card) for example – same endpoint for all payment methods, different response object
Related guidesAll payment methods

Event typeDescription
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

ResourceCardValidationId
Related GETGET View a Card Validation
Related guidesCard validation without debit

Event typeDescription
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

ResourceRecurringRegistrationId
Related GETGET View a Recurring PayIn Registration
Related guidesRecurring card payments

Event typeDescription
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

ResourcePreauthorizationId
Related GETGET View a Preauthorization
Related guides7-day preauthorization

Event typeDescription
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.

ResourceDepositId
Related GETGET View a Deposit Preauthorization
Related guides

Event typeDescription
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

ResourcePayInId
Related GETGET View a PayIn (Pay by Bank)
Related guidesPay by Bank

Event typeDescription
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

ResourceVirtualAccountId
Related GETGET View a Virtual Account
Related guidesVirtual accounts

Event typeDescription
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

ResourceMandateId
Related GETGET View a Mandate
Related guidesDirect debit mandates

Event typeDescription
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

ResourceDisputeId
Related GETGET View a Dispute
Related guidesDisputes

Event typeDescription
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

ResourceDisputeDocumentId
Related GETGET View a Dispute Document
Related guidesDisputes

Event typeDescription
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

ResourceRepudiationId
Related GETGET View a Repudiation
Related guidesDisputes

Event typeDescription
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

ResourceSettlementId
Related GETGET View a Settlement Transfer
Related guidesDisputes

Event typeDescription
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

ResourceTransferId
Related GETGET View a Transfer
Related guides

Event typeDescription
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

ResourceConversionId
Related GETGET View a Conversion
Related guidesConversions

Instant conversions

Event typeDescription
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

Event typeDescription
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

ResourcePayoutId
Related GETGET View a Payout
Related guidesPayouts

Event typeDescription
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


Event typeDescription
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

ResourceRefundId
Related GETGET View a Refund
Related guidesRefunds - Pay-in

Event typeDescription
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

ResourceRefundId
Related GETGET View a Refund
Related guidesRefunds - Transfer

Event typeDescription
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

ResourceRefundId
Related GETGET View a Refund
Related guidesPayouts - Returns

Event typeDescription
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

ResourceIntent CaptureId
Related GETGET View an Intent
Related guidesEcho

Event typeDescription
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

ResourceIntent SplitId
Related GETGET View an Intent
Related guidesEcho

Event typeDescription
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

ResourceSettlementId
Related GETGET View a Settlement
Related guidesEcho

Event typeDescription
SETTLEMENT_PENDING_UPLOAD

The Settlement object and SettlementFileUploadUrl were generated. Upload your settlement file to the SettlementFileUploadUrl; see PUT Upload a settlement file to the secure URL for more details.

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 FundsMissingAmount shows the shortfall.

SETTLEMENT_RECONCILED

The full settlement amount (ActualSettlementAmount) was received on the technical wallet.

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

ResourceReportingId
Related GETGET View a Report
Related guidesReports

Event typeDescription
REPORT_GENERATED

The report has been generated and is ready for download at the DownloadURL value.

REPORT_FAILED

The report was not generated successfully.