Capture
This page describes the Capture request and response using Velocity API. After a customer completes the checkout process, the authorized transaction is captured. You can use this operation to capture the payment amount. The amount field can take values equal to or less than the authorized amount. You can facilitate either a complete capture or a partial capture. A Partial Capture is defined as a Capture request with an amount greater than $0 and less than the Authorized Amount.
Note: Invoke this API only if you enable manual capture. Do not invoke if you have enabled auto-capture.
The table below specifies the endpoint and request requirements for the Capture operation:
Path Name | Path Details |
---|---|
Endpoint | [Velocity URL]/mpoint/capture-payment |
Request Method | POST |
Format/Content Type | text/xml |
Authentication | HTTP basic access authentication |
Request
The following is a sample request sent to capture an authorized transaction. It is sent from the merchant’s server to Velocity. It contains the transaction details of a customer:
<?xml version="1.0" encoding="UTF-8"?>
<root>
<capture client-id="[integer]" account="[integer]">
<transaction id="[integer]" order-no="UAT-28577880">
<amount country-id="100">10000</amount>
</transaction>
</capture>
</root>
Response
The following is a sample response returned from the Velocity server to a merchant. It contains the transaction ID and transaction status:
<?xml version="1.0" encoding="UTF-8"?>
<root>
<transactions client-id="[integer]">
<transaction id="[integer]" order-no="28577880">
<status code="1000"/>
</transaction>
</transactions>
</root>
Updated 7 months ago