Cancel an Intent

Cancel all or part of an authorized Intent

POST /v3.0/{ClientId}/payins/intents/{IntentId}/cancel

Full cancel

{ 
    "ExternalData": {
        "ExternalProcessingDate": 1769794421,
        "ExternalProviderReference": "cancel-stripe-01f82162-1fe2-4921-a322-1de2680ec995",
        "ExternalMerchantReference": "cancel-order-e76ec48d-9285-42fc-bd83-3e43d91352a0",
        "ExternalProviderName": "Stripe",
        "ExternalProviderPaymentMethod": "MASTERCARD"
    }
}

Full cancel

{
    "Id": "int_019c0ff6-7334-7217-9a1d-3f029defb965",
    "Amount": 20000,
    "AvailableAmountToSplit": 0,
    "UnfundedAmount": 0,
    "Currency": "EUR",
    "PlatformFeesAmount": 0,
    "Status": "CANCELLED",
    "ExternalData": {
        "ExternalProcessingDate": 1769794335,
        "ExternalProviderReference": "auth-stripe-07d87474-61ab-4054-8f9c-99d9b6478b00",
        "ExternalMerchantReference": "order-27cd989a-220f-486a-8714-b3120913dac4",
        "ExternalProviderName": "Stripe",
        "ExternalProviderPaymentMethod": "MASTERCARD"
    },
    "Buyer": {
        "Id": "user_m_01KF3087EDXEAK8VPD9DTMZW8N"
    },
    "LineItems": [
        {
            "Id": "int_li_019c0ff6-7339-73b9-aa3f-4b657d8629c0",
            "TotalLineItemAmount": 10000,
            "CapturedAmount": 0,
            "RefundedAmount": 0,
            "DisputedAmount": 0,
            "SplitAmount": 0,
            "CancelledAmount": 10000,
            "UnfundedSellerAmount": 0
        },
        {
            "Id": "int_li_019c0ff6-7339-73b9-aa3f-4b657d8629c1",
            "TotalLineItemAmount": 10000,
            "CapturedAmount": 0,
            "RefundedAmount": 0,
            "DisputedAmount": 0,
            "SplitAmount": 0,
            "CancelledAmount": 10000,
            "UnfundedSellerAmount": 0
        }
    ],
    "CreationDate": 1769794335,
    "ExecutionDate": 1769794339,
    "Cancel": {
        "Id": "int_cancel_019c0ff6-8493-7efd-a303-40ec83b1b7a8"
    }
}

You can use this endpoint to cancel all or part of an Intent before it has been captured. You can only call this endpoint if the Intent has the Status of AUTHORIZED. You cannot cancel an Intent if it has been captured in part (PARTIALLY_CAPTURED) or full (CAPTURED).

Path parameters

IntentId · string · required

The unique identifier of the Intent.

Full cancellation

If you send an empty body or only the ExternalData, then the full Amount of the intent is canceled (all line items). The ExternalData is optional and can be provided if the cancellation follows an event from the third-party PSP.

In a full cancellation, the Status becomes CANCELLED, indicating that no further actions are possible on the Intent.

Body parameters

ExternalData · object

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

Hide child attributes

ExternalProcessingDate · Unix timestamp · required

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.

Partial cancellation

Part of the original Intent Amount is canceled from one or more line items. Any amount can be canceled from any line item(s). The cancellation Amount must equal the sum of its line items.

Body parameters

Amount · integer · required

The amount of the cancellation.

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.

ExternalData · object

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

Hide child attributes

ExternalProcessingDate · Unix timestamp · required

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.

LineItems · array (object) · required

Information about the items canceled, required for a partial cancellation.

Hide child attributes

Id · string · required

The unique identifier of the line item in Mangopay ecosystem.

Amount · integer · required

The amount of the cancellation. The sum of the cancellation’s LineItems.Amount values must equal the Amount of 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 technical 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, as declared by the platform through Intent Captures, Refunds (and reversals), or Disputes (and decisions). Where partial actions occur, the top-level Intent Status may differ from the Status of Intent LineItems.

Intent Status values:

• AUTHORIZED – The Intent Amount was authorized for acquisition by the PSP and can be captured or canceled.
• PARTIALLY_CAPTURED – Part of the Intent Amount from one or more LineItems was captured. The other parts are either still available for capture or cancel.
• CAPTURED – All of the Intent Amount was captured. Part of it may have been subsequently refunded or disputed.
• CANCELLED – All of the Intent Amount was canceled.
• REFUNDED – All of the CapturedAmount of all LineItems was refunded.
• REFUND_REVERSED – The refund could not be completed and the funds were returned to the platform.
• DISPUTED – All of the CapturedAmount of all LineItems was disputed.
• DEFENDED – The dispute is being defended by the platform.
• DISPUTED_WON – The dispute was resolved in favor of the platform.
• DISPUTED_LOST – The dispute was resolved against the platform.

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.

Note: The uppercase value is expected. The API returns the sentence-case value.

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 CANCELLED 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 technical wallet before the Intent Splits can be executed for this seller.

SplitOriginWalletId · string

The unique identifier of the wallet from which the split will be debited.

This parameter is required for Intents where ExternalProviderName is Mangopay. If it is not defined in the Intent it must be defined at Split creation.

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.

Dispute · object

Information about the Dispute.

Show child attributes

Id · string

The unique identifier of the Dispute.

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": "int_019c0ff6-7334-7217-9a1d-3f029defb965",
    "Amount": 20000,
    "AvailableAmountToSplit": 0,
    "UnfundedAmount": 0,
    "Currency": "EUR",
    "PlatformFeesAmount": 0,
    "Status": "CANCELLED",
    "ExternalData": {
        "ExternalProcessingDate": 1769794335,
        "ExternalProviderReference": "auth-stripe-07d87474-61ab-4054-8f9c-99d9b6478b00",
        "ExternalMerchantReference": "order-27cd989a-220f-486a-8714-b3120913dac4",
        "ExternalProviderName": "Stripe",
        "ExternalProviderPaymentMethod": "MASTERCARD"
    },
    "Buyer": {
        "Id": "user_m_01KF3087EDXEAK8VPD9DTMZW8N"
    },
    "LineItems": [
        {
            "Id": "int_li_019c0ff6-7339-73b9-aa3f-4b657d8629c0",
            "TotalLineItemAmount": 10000,
            "CapturedAmount": 0,
            "RefundedAmount": 0,
            "DisputedAmount": 0,
            "SplitAmount": 0,
            "CancelledAmount": 10000,
            "UnfundedSellerAmount": 0
        },
        {
            "Id": "int_li_019c0ff6-7339-73b9-aa3f-4b657d8629c1",
            "TotalLineItemAmount": 10000,
            "CapturedAmount": 0,
            "RefundedAmount": 0,
            "DisputedAmount": 0,
            "SplitAmount": 0,
            "CancelledAmount": 10000,
            "UnfundedSellerAmount": 0
        }
    ],
    "CreationDate": 1769794335,
    "ExecutionDate": 1769794339,
    "Cancel": {
        "Id": "int_cancel_019c0ff6-8493-7efd-a303-40ec83b1b7a8"
    }
}

Full cancel

{ 
    "ExternalData": {
        "ExternalProcessingDate": 1769794421,
        "ExternalProviderReference": "cancel-stripe-01f82162-1fe2-4921-a322-1de2680ec995",
        "ExternalMerchantReference": "cancel-order-e76ec48d-9285-42fc-bd83-3e43d91352a0",
        "ExternalProviderName": "Stripe",
        "ExternalProviderPaymentMethod": "MASTERCARD"
    }
}