Create a Capture of an Intent

Declare the full or partial capture of an authorization processed by a third-party PSP

You can use this endpoint in three capture scenarios requiring three difference request bodies.

Path parameters

IntentId · string · required

The unique identifier of the Intent.

Full simultaneous capture

The full Amount of the intent is captured (all line items) and the ExternalData is the same as the Intent (same provider references and date).

Body parameters

No request body for full simultaneous capture.

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.

NextActions · string

The possible next actions on the intent.

ExternalData · object

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

The ExternalData values are required if they differ from the original Intent values, which is the case for captures that are separate from authorization (different reference and/or date).

Show child attributes

ExternalProcessingDate · Unix timestamp

The date at which the capture was created.

ExternalProviderReference · string

The unique identifier of the capture at the provider level.

ExternalMerchantReference · string

The unique identifier of the capture 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 capture.

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 line items included in the intent action.

Show child attributes

Id · string

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

TotalLineItemAmount · integer

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

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.

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 - Amount must equal LineItems amounts

{
    "Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Id": "538f0981-b975-4790-8a20-748a8afe8719",
    "Date": 1752063380,
    "Type": "param_error",
    "Errors": {
        "Amount": "The total intent amount does not match the sum of the declared LineItem amounts"
    }
}

400 - Capture Amount for a line item can't exceed authorized amount for the same line item

{
    "Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Id": "19232364-0772-4ba2-bb7d-5ac6aa1ea385",
    "Date": 1752064526,
    "Type": "param_error",
    "Errors": {
        "Amount": "Capture not possible: current captured amount [10000] plus capture amount [5000] exceeds the Intent.LineItemId=[int_li_0197ef2e-88f7-7bcc-8937-207a5e5f483a] with amount [10000]"
    }
}

400 - Partial capture already done so full capture not allowed

{
    "Message": "Action on the Intent resource is not permitted",
    "Id": "51a50212-30d5-4761-a2c7-f92aca09d697",
    "Date": 1750257386,
    "Type": "invalid_action",
    "Errors": {
        "Capture": "A partial operation was found, please include instructions in the request body"
    }
}

Full, simultaneous

{
    "Id": "int_0197ef1e-e53d-7e81-b648-b27b13a98ba9",
    "Amount": 20000,
    "AvailableAmountToSplit": 20000,
    "UnfundedAmount": 0,
    "Currency": "EUR",
    "PlatformFeesAmount": 0,
    "Status": "CAPTURED",
    "NextActions": "REFUNDED, DISPUTED",
    "ExternalData": {
        "ExternalProcessingDate": 1752057968,
        "ExternalProviderReference": "auth-stripe-d400210c-a4d9-4ce2-bfb1-9cf21cde5a80",
        "ExternalMerchantReference": "order-8db7e398-f460-43c8-91ef-19d76d54dbf6",
        "ExternalProviderName": "Stripe",
        "ExternalProviderPaymentMethod": "MASTERCARD"
    },
    "Buyer": {
        "Id": "user_m_01JZB09HSDZRVN60QH1006TK6E"
    },
    "Capture": {
        "Id": "int_capture_0197ef1e-fc77-7e14-97f8-96a38847e375"
    },
    "LineItems": [
        {
            "Id": "int_li_0197ef1e-e53f-7864-aa28-eaef2cc7170f",
            "TotalLineItemAmount": 10000,
            "CapturedAmount": 10000,
            "RefundedAmount": 0,
            "DisputedAmount": 0,
            "SplitAmount": 0
        },
        {
            "Id": "int_li_0197ef1e-e53f-7864-aa28-eaef2cc71710",
            "TotalLineItemAmount": 10000,
            "CapturedAmount": 10000,
            "RefundedAmount": 0,
            "DisputedAmount": 0,
            "SplitAmount": 0
        }
    ],
    "CreationDate": 1752063468,
    "ExecutionDate": 1752063474
}

Full, simultaneous

// No request body