Skip to main content
POST
/
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,
    "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
}
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
  • Partial 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.

​
Responses

​
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.
​
Buyer
object
Information about the buyer.
​
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.
​
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.
{
    "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."
    }
}

{
    "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
}

{
    "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"
    }
}
⌘I