Capture Service
The capture service is a follow-on service that uses the request ID returned from the
previous authorization. The request ID links the capture to the authorization. This
service transfers funds from the customer’s account to your bank and usually takes two
to four days to complete.
Payment Processor | Authorization and Capture Information |
---|---|
HSBC | The amount is rounded to the correct number of decimal places
for the currency. HSBC supports enhanced
response codes in authorization response messages. Enhanced
response codes provide detailed information about declined
transactions. Contact HSBC customer
support to have this capability enabled for your
account. |
Required Fields for Capturing a Payment
The following fields are required when creating a capture request:
- clientReferenceInformation.code
- orderInformation.amountDetails.currency
- orderInformation.amountDetails.totalAmount
- processingInformation.paymentSolution
- Set to008.
Related Information
Capturing a Payment
- Pass the original authorization ID in the URL, and send the service request toPOST https://<. Use one of these URL prefixes:url_prefix>/v2/payments/{id}/captures
- Test:apitest.cybersource.com
- Production:api.cybersource.com
- Production in India:api.in.cybersource.com
ADDITIONAL INFORMATION
Whereidis the authorization ID returned in the authorization response.{ "id": "6481692924466004003001" }The URL with theidvalue is included in the authorization response:{ "_links": { "capture": { "method": "POST", "href": "/pts/v2/payments/6481692924466004003001/captures" } } - Check the response message to make sure that the request was successful. A 200-level HTTP response code indicates success. For information about response codes, see Transaction Response Codes.
Example: Basic Credit Card Capture Using the REST
API
Capture Request
123456789101112{"clientReferenceInformation": { "code": "482046C3A7E94F5BD1FE3C66C" }, "processingInformation": { "paymentSolution": "008" }, "orderInformation": { "amountDetails": { "totalAmount": "49.95", "currency": "USD" } }}
Capture Response
123456789101112{"clientReferenceInformation": { "code": "482046C3A7E94F5BD1FE3C66C" }, "processingInformation": { "reconciliationID": "02850840187309570" }, "orderInformation": { "amountDetails": { "totalAmount": "49.95", "currency": "USD" } }}