PUT
/
v3.0
/
{ClientId}
/
payins
/
intents
/
{IntentId}
/
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"
    }
}
{
    "Id": "409f8d2e-9eba-48f9-8a52-dc9bda4d9041",
    "Amount": 10000,
    "AvailableAmountToSplit": 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
}
You can use this endpoint to cancel all or part of an Intent.

Path parameters

IntentId
string
required
The unique identifier of the Intent.
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.

Responses

{
    "Id": "409f8d2e-9eba-48f9-8a52-dc9bda4d9041",
    "Amount": 10000,
    "AvailableAmountToSplit": 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
}
{
    "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"
    }
}