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
The unique identifier of the Intent.
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.
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.
The full Amount of the intent is captured (all line items) but the ExternalData references and date are different from the Intent (for example, a capture following preauthorization).
Body parameters
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).
Part of the original Intent Amount is captured from one or more line items. Any amount can be captured from any line item(s). The ExternalData references and date are different from the Intent. The Capture Amount must equal the sum of the Amount values captured for all line items.
Body parameters
The amount of the Capture, required for a partial capture. The Capture Amount must equal the sum of the Amount values captured for all line items.
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.
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 items purchased in the transaction, required for a partial capture.
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 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.
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.
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