POST Capture Transaction
Captures a previously preauthorized transaction.
Required Headers
Request Body Parameters
Validation Rules
Required Fields
| Field | Type | Rules | Description |
|---|---|---|---|
transaction_id | string | required, max:36 | UUID of the transaction to capture |
amount | numeric | required, min:0 | Amount to capture (must be greater than or equal to 0) |
tax | numeric | required, min:0 | Tax to capture (must be greater than or equal to 0) |
Common Validation Error Messages
The following are common validation error messages returned by the API (in Spanish)::attribute es obligatorio.- Required field missing:attribute debe ser una cadena de texto.- Invalid data type (expected string):attribute debe ser un número.- Invalid data type (expected numeric):attribute no puede tener más de :max caracteres.- Maximum length exceeded:attribute debe ser mayor o igual a :min.- Minimum value not met:attribute no es válido.- Invalid value
Response Fields
Success Response (200 OK)
"CAPTURED" when capture is successfultrue when successful, false when there is an errorHTTP Status Codes
| Status Code | Description | Response Body |
|---|---|---|
200 OK | Successful capture | status: true, code: "CAPTURED" |
400 Bad Request | Missing required header (X-Merchant-ID or X-Request-ID) | Simple error message |
401 Unauthorized | Authentication failed (invalid Token-Top or Authorization) | code: "UNAUTHORIZED" |
404 Not Found | Transaction or subscription not found | code: "NOT_FOUND" |
422 Unprocessable Entity | Validation error or invalid state | code: "VALIDATION_ERROR", "INVALID_STATE", "PAYMENT_CAPTURE_FAILED" or "PROCESSING_ERROR" (invalid capture amount) |
500 Internal Server Error | Internal server error | code: "SERVICE_ERROR" |
Response Codes
| Code | Description |
|---|---|
CAPTURED | Successful capture |
VALIDATION_ERROR | Validation error in sent data (missing fields, incorrect types, etc.) |
UNAUTHORIZED | Authentication error |
NOT_FOUND | Transaction or subscription not found |
INVALID_STATE | Invalid state of transaction or subscription (not approved, incorrect type, no provider reference, etc.) |
PAYMENT_CAPTURE_FAILED | Capture failed at the payment provider |
PROCESSING_ERROR | Invalid capture amount (greater than authorized amount). Use the Renewal Preauthorize endpoint instead. |
SERVICE_ERROR | Internal server error |
Transaction Types
Original Transaction (Pre-Authorization)
- Type:
PRE_AUTH_TRANSACTIONorRENEWAL_PRE_AUTH_TRANSACTION - Status:
APPROVED - Purpose: Reserve funds without capturing them
Capture Transaction
- Type:
COMPLETION_TRANSACTION - Status:
APPROVED(success) orDECLINED/ERROR(failure) - Purpose: Capture the pre-authorized funds
- Linkage:
linked_transaction_idpoints to the original transaction
Headers
Unique identifier of the Merchant invoking Card Payment services. Should not be used to authenticate end users.
Tracking identifier associated with the request, used to establish a correlation_id between ecosystem components.
Token for authentication.
Basic authentication.
Body
Response
Successful capture. A new transaction of type COMPLETION_TRANSACTION is created.
Response when capturing a transaction. Creates a new transaction of type COMPLETION_TRANSACTION linked to the original transaction.
Response code. Value: 'CAPTURED' when capture is successful
"CAPTURED"
Operation status. true when successful, false when there is an error
true
Descriptive message about the capture result
"Pago capturado exitosamente"