Cancel an Intent

Declare the full or partial cancellation of a payment authorization processed by a third-party PSP

You can use this endpoint to cancel all or part of an Intent.

Path parameters

IntentId · string · required

The unique identifier of the Intent.

Full cancellation

The full Amount of the intent is canceled (all line items). The ExternalData references and date must be provided as cancellation was necessarily a different action taken via the third-party PSP.

Body parameters

ExternalData · object · required

Information about the cancellation processed by the third-party PSP. In a cancel scenario, external data is required because the reference is different from the Intent.

Hide child attributes

ExternalProcessingDate · Unix timestamp · required

The date at which the cancellation was created.

ExternalProviderReference · string · required

The unique identifier of the cancellation at the provider level

ExternalMerchantReference · string

The unique identifier of the cancellation at the merchant level

ExternalProviderName · string · required

The supported third-party PSP processing the transaction.

ExternalProviderPaymentMethod · string

One of the supported payment methods used to process the cancellation.

Responses

200 - Response parameters

Id · string

The unique identifier of the intent.

Amount · integer

The full amount authorized in the Intent, which must equal the sum of the total amounts of all LineItems.

AvailableAmountToSplit · integer

The remaining amount of the Intent that can be split and transferred to the sellers’ wallets.

UnfundedAmount · integer

The amount needing to be settled to the Platform’s escrow wallet before the Intent Splits can be executed.

Currency · integer

The currency of the intent.

PlatformFees · integer

The amount of fees to be diverted to the platform’s Fees Wallet when the Intent is split. This value can be overridden when the Split is created.

The PlatformFees value must the sum of all line item Seller.FeesAmount values.

Status · string

The status of the Intent:

• AUTHORIZED – The Intent Amount was authorized for acquisition by the PSP.
• PARTIALLY_CAPTURED – Part of the Intent Amount was captured and is expected in a Settlement.
• CAPTURED – The full Intent Amount was captured and is expected in a Settlement.
• CANCELED – Some or all of the Amount was canceled.
• REFUNDED – Some or all of the Amount was refunded.
• REFUND_REVERSED – The refund could not be completed and the funds were returned to the platform.
• DISPUTED – A dispute occurred on some or all of the Amount.
• DEFENDED – The disputed funds were returned to the platform temporarily until the dispute is resolved.
• DISPUTED_WON – The dispute was resolved in favor of the platform.
• DISPUTED_LOST – The dispute was resolved against the platform: funds permanently withdrawn to the buyer.

ExternalData · object

Information about the cancellation processed by the third-party PSP.

Show child attributes

ExternalProcessingDate · Unix timestamp

The date at which the cancellation was created

ExternalProviderReference · string

The unique identifier of the cancellation at the provider level

ExternalMerchantReference · string

The unique identifier of the cancellation at the merchant level

ExternalProviderName · string

The supported third-party PSP processing the transaction.

ExternalProviderPaymentMethod · string

One of the supported payment methods used to process the cancellation.

Buyer · object

Information about the buyer.

Show child attributes

Id · string

If it exists, the unique identifier of the Mangopay user making the payment via the third-party PSP. Must be a valid Mangopay UserId.

LineItems · array (object)

Information about the items purchased in the transaction.

The sum of all line item amounts must equal the Intent Amount value. The total for each line items is calculated as ((UnitAmount x Quantity) - DiscountAmount), which is shown in the TotalLineItemAmount returned. The TaxAmount is indicative and included in the UnitAmount.

The sum of all line item Seller.FeesAmount values must equal the Intent PlatformFees value.

Show child attributes

Seller · object

Information about the seller of the line item.

Show child attributes

AuthorId · string

The unique identifier of the seller of the line item.

Required if WalletId not sent.

WalletId · string

The unique identifier of the wallet to credit the seller’s funds.

Required if AuthorId not sent.

FeesAmount · integer

The amount of fees that will be diverted to the platform’s Fees Wallet when the Intent is split. This value can be overridden when the Split is created.

TransferDate · Unix timestamp

The future date when the funds are to be automatically transferred to the seller’s wallet.

Id · string

The unique identifier of the line item in Mangopay’s ecosystem.

Sku · string

The stock keeping unit (SKU) or other unique identifier of the item.

Name · string

The name of the item.

Description · string

The description of the item.

Quantity · integer

The number of units in the line item.

UnitAmount · integer

The cost of each unit, including TaxAmount and excluding DiscountAmount.

TaxAmount · integer

The amount of the UnitAmount which is tax.

DiscountAmount · integer

The amount of discount applied to the line item.

Category · string

The category of the item, as defined by the platform.

ShippingAddress · object

Information about the shipping address.

Show child attributes

AddressLine1 · string

The first line of the address.

AddressLine2 · string

The second line of the address.

City · string

The city of the address

Region · string

The region of the address.

PostalCode · string

The postal code of the address

Country · string

The country of the address

CapturedAmount · integer

The item total CAPTURED amount

RefundedAmount · integer

The item total REFUNDED amount

DisputedAmount · integer

The item total DISPUTED amount.

SplitAmount · integer

The item total COMPLETED amount.

CancelledAmount · integer

The item total CANCELED amount.

TotalLineItemAmount · integer

The total amount of the line item calculated as ((UnitAmount x Quantity) - DiscountAmount).

UnfundedSellerAmount · integer

The amount needing to be settled to the Platform’s escrow wallet before the Intent Splits can be executed for this seller.

CreationDate · string

The date and time at which the Intent was created.

ExecutionDate · Unix timestamp

The date and time at which the Intent moved to AUTHORIZED.

400 - Intent must be AUTHORIZED to be canceled

{
    "Message": "Action on the Intent resource is not permitted",
    "Id": "1a9c4474-6da1-473f-9659-99edb7a00884",
    "Date": 1756458918,
    "Type": "invalid_action",
    "Errors": {
        "Status": "Intent cannot be cancelled because it is not in AUTHORIZED status."
    }
}

Full cancel

{
    "Id": "409f8d2e-9eba-48f9-8a52-dc9bda4d9041",
    "Amount": 10000,
    "AvailableAmountToSplit": 0,
    "UnfundedAmount": 0,
    "Currency": "EUR",
    "PlatformFeesAmount": 0,
    "Status": "CANCELED",
    "ExternalData": {
        "ExternalProcessingDate": "03-10-2024",
        "ExternalProviderReference": "cancel-stripe-d5fad854-117c-4b1a-bf15-d8e2846749c7",
        "ExternalMerchantReference": "cancel-order-1d1d3c30-5f0f-4cda-ad0d-7ab3c315de3d",
        "ExternalProviderName": "Stripe",
        "ExternalProviderPaymentMethod": "PAYPAL"
    },
    "Buyer": {
        "Id": "user_m_01JCGBN7B7QG2YZ8ARA5J8WYMW"
    },
    "LineItems": [
        {
            "Id": "1f395091-6b27-440f-8d38-39832cf1cfc9",
            "TotalLineItemAmount": 7500,
            "CanceledAmount": 7500,
            "CapturedAmount": 0,
            "RefundedAmount": 0,
            "DisputedAmount": 0,
            "SplitAmount": 0
        },
        {
            "Id": "1f12c4d5-d6ea-40f2-ac8e-bb3c8770918c",
            "TotalLineItemAmount": 2500,
            "CanceledAmount": 2500,
            "CapturedAmount": 0,
            "RefundedAmount": 0,
            "DisputedAmount": 0,
            "SplitAmount": 0
        },
    ],
    "CreationDate": 1733329398,
    "ExecutionDate": 1733329423
}

Full cancel

{
    "ExternalData": {
        "ExternalProcessingDate": "03-10-2024",
        "ExternalProviderReference": "cancel-stripe-d5fad854-117c-4b1a-bf15-d8e2846749c7",
        "ExternalMerchantReference": "cancel-order-1d1d3c30-5f0f-4cda-ad0d-7ab3c315de3d",
        "ExternalProviderName": "Stripe",
        "ExternalProviderPaymentMethod": "PAYPAL"
    }
}