Intents
Create an Intent Capture
Declare the full or partial capture of an authorization processed by a third-party PSP
POST
You can use this endpoint in three capture scenarios requiring three difference request bodies.
Path parameters
The unique identifier of the Intent.
Body parameters
- Full simultaneous capture
- Full separate capture
- Partial capture
No request body for 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).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, 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 IntentAmountwas authorized for acquisition by the PSP and can be captured or canceled.PARTIALLY_CAPTURED– Part of the IntentAmountfrom one or moreLineItemswas captured. The other parts are either still available for capture or cancel.CAPTURED– All of the IntentAmountwas captured. Part of it may have been subsequently refunded or disputed.CANCELLED– All of the IntentAmountwas canceled.REFUNDED– All of theCapturedAmountof allLineItemswas refunded.REFUND_REVERSED– The refund could not be completed and the funds were returned to the platform.DISPUTED– All of theCapturedAmountof allLineItemswas 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.
The possible next actions on the intent.
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).Information about the buyer.
Information about the line items included in the intent action.
The date and time at which the Intent was created.
The date and time at which the Intent moved to
AUTHORIZED.Information about the Capture.
400 - Amount must equal LineItems amounts
400 - Amount must equal LineItems amounts
400 - Capture Amount for a line item can't exceed authorized amount for the same line item
400 - Capture Amount for a line item can't exceed authorized amount for the same line item
400 - Partial capture already done so full capture not allowed
400 - Partial capture already done so full capture not allowed