POST/v1/tenants/{tenantId}/ecom_stores/{eComStoreId}/orders/{salesOrderId}/captures/{captureId}/payment_capture

Update payment capture status

Updates the payment capture status for a capture. Send CONFIRMED to unblock shipment after successful payment capture, or FAILED if capture failed. A failed capture can be retried by sending a new status. Once confirmed, the capture cannot be changed.

Parameters

tenantIdpathstringnon-nullrequired
eComStoreIdpathstringnon-nullrequired
salesOrderIdpathstringnon-nullrequired
captureIdpathstringnon-nullrequired

Request body (optional)

application/jsonobjectnon-null

capturedAmountstringnullableoptional: Amount captured, if applicable
Format: BigDecimal
Example"1499.00"
statusstringnon-nullrequired: Payment capture status
Allowed values"CONFIRMED""FAILED"
Example"CONFIRMED"

View schema definition

Responses

200Response

No response body documented.

401Unauthorized - Invalid or missing authentication

Unauthorized - Invalid or missing authentication

application/jsonobjectnon-null

errorstringnon-nullrequired: Stable error code
Example"INVALID_REQUEST"
messagestringnon-nullrequired: Human-readable error message
Example"Invalid customer ID format"
resolutionstringnon-nullrequired: Suggested next action
Example"Correct the customer ID and retry the request"

View schema definition

403

application/jsonobjectnon-null

errorstringnon-nullrequired: Stable error code
Example"INVALID_REQUEST"
messagestringnon-nullrequired: Human-readable error message
Example"Invalid customer ID format"
resolutionstringnon-nullrequired: Suggested next action
Example"Correct the customer ID and retry the request"

View schema definition

404Not Found - Capture not found or does not belong to this ecom store's order

Not Found - Capture not found or does not belong to this ecom store's order

application/jsonobjectnon-null

errorstringnon-nullrequired: Stable error code
Example"INVALID_REQUEST"
messagestringnon-nullrequired: Human-readable error message
Example"Invalid customer ID format"
resolutionstringnon-nullrequired: Suggested next action
Example"Correct the customer ID and retry the request"

View schema definition

409Conflict - Payment capture has already been confirmed or was abandoned

Conflict - Payment capture has already been confirmed or was abandoned

application/jsonobjectnon-null

errorstringnon-nullrequired: Stable error code
Example"INVALID_REQUEST"
messagestringnon-nullrequired: Human-readable error message
Example"Invalid customer ID format"
resolutionstringnon-nullrequired: Suggested next action
Example"Correct the customer ID and retry the request"

View schema definition

500

application/jsonobjectnon-null

errorstringnon-nullrequired: Stable error code
Example"INVALID_REQUEST"
messagestringnon-nullrequired: Human-readable error message
Example"Invalid customer ID format"
resolutionstringnon-nullrequired: Suggested next action
Example"Correct the customer ID and retry the request"

View schema definition