Skip to navigation
APIPay In endpointsLegacy endpoints (deprecated)

Capture transaction (GET)

Deprecated
View as MarkdownOpen in Claude

This endpoint is deprecated. Use POST /capture/{transId} instead, which supports partial captures and service fee adjustments.

Capture an authorized transaction to complete the transaction and move funds from the customer to merchant account.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

OR
requestTokenstring

Long-lived API token sent in the requestToken header. See API token authentication.

Path parameters

amountdoubleRequired

Amount to be captured. The amount can’t be greater the original total amount of the transaction. 0 captures the total amount authorized in the transaction. Partial captures aren’t supported.

transIdstringRequired

ReferenceId for the transaction (PaymentId).

Response

Ok
responseCodeinteger

Code for the response. Learn more in API Response Codes.

pageIdentifierstring or null
Auxiliary validation used internally by payment pages and components.
roomIdlong

Field not in use on this endpoint. It always returns 0.

isSuccessboolean

Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.

responseTextstring

Response text for operation: ‘Success’ or ‘Declined’.

responseDataobject
Response data for capture transactions

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error
503
Service Unavailable Error