Create a Cancel of an Intent
Declare the full or partial cancellation of a payment authorization processed by a third-party PSP
PUT
You can use this endpoint to cancel all or part of an Intent.
Path parameters
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
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
200 - Response parameters
200 - Response parameters
The unique identifier of the intent.
The full amount authorized in the Intent, which must equal the sum of the total amounts of all
LineItems.The remaining amount of the Intent that can be split and transferred to the sellers’ wallets.
The amount needing to be settled to the Platform’s escrow wallet before the Intent Splits can be executed.
The currency of the intent.
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.The status of the Intent:
AUTHORIZED– The IntentAmountwas authorized for acquisition by the PSP.PARTIALLY_CAPTURED– Part of the IntentAmountwas captured and is expected in a Settlement.CAPTURED– The full IntentAmountwas captured and is expected in a Settlement.CANCELED– Some or all of theAmountwas canceled.REFUNDED– Some or all of theAmountwas 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 theAmount.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.
Information about the cancellation processed by the third-party PSP.
Information about the buyer.
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.The date and time at which the Intent was created.
The date and time at which the Intent moved to
AUTHORIZED.400 - Intent must be AUTHORIZED to be canceled
400 - Intent must be AUTHORIZED to be canceled