On This Page

Capture an Authorized Payment

The capture request enables you to capture an authorized payment. You can either capture the entire amount in one request or request partial-capture amounts. Oney supports multiple partial-capture requests when the total amount of all captures is less than the authorized amount. Requesting a capture requires the

requestID

from the authorization response.

You can capture an authorized payment up to 28 days after the payment was authorized.

Calculating the Grand Total

Include the grand total in the request by using the

purchaseTotals_grandTotalAmount

field.

For information about how to calculate the grand total, see Calculating the Grand Total for Line Items.

Endpoints

Set the

apCaptureService_run

field to

true

, and send the request to one of these endpoints:

Production:

https://ics2ws.ic3.com/commerce/1.x/transactionProcessor

Test:

https://ics2wstest.ic3.com/commerce/1.x/transactionProcessor

Response Statuses

The capture service responds with one of these statuses as the

apCaptureReply_status

response field value:

FAILED

: The capture request failed.

PENDING

: The capture request is accepted but is not settled. Request the check status service to retrieve status updates. See Check a Transaction Status.

SETTLED

: The capture request is settled for the requested amount.

The capture service also responds with a reason code as the

apCaptureReply_reasonCode

processorInformation.responseCode

field value.

For more information on reason codes, see the Reason Codes for the Simple Order API.

Required Fields for Capturing a Payment

Include these required fields to capture a payment.

apCaptureService_authRequestID: Set the field value to the value of the request ID included in the authorization response.
apCaptureService_run: Set the field value to
true
.
apPaymentType: Set the field value to
ONY
.
merchantID
merchantReferenceCode
purchaseTotals_currency: Set to
EUR
.
purchaseTotals_grandTotalAmount

Optional Fields for Capturing a Payment

Choose from these optional fields to include additional information when capturing a payment.

item_#_productName
item_#_quantity
item_#_totalAmount
item_#_unitPrice

Example: Capturing a Payment

Request

<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.213">
	<merchantID>test_merchant</merchantID>
	<merchantReferenceCode>refnum-1234</merchantReferenceCode>
	<purchaseTotals>
		<currency>EUR</currency>
		<grandTotalAmount>220</grandTotalAmount>
	</purchaseTotals>
	<apPaymentType>ONY</apPaymentType>
	<apCaptureService run="true">
		<authRequestID>6953229325326859903007</authRequestID>
	</apCaptureService>
</requestMessage>

Response to a Successful Request

<replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data-1.213">
	<merchantReferenceCode>ref1695322956</merchantReferenceCode>
	<requestID>6953229557336619903008</requestID>
	<decision>ACCEPT</decision>
	<reasonCode>100</reasonCode>
	<requestToken>AxjnrwSTeO9xwpvL1GggANgZYjWmdqbQhOJDNsojmiG9Lz0h9XwMwIZNJMvRiy0P/Sbx3uHfMaEAQD4A8A9O</requestToken>
	<purchaseTotals>
		<currency>EUR</currency>
	</purchaseTotals>
	<apCaptureReply>
		<reasonCode>100</reasonCode>
		<status>SETTLED</status>
		<processorResponse>00004</processorResponse>
		<amount>220.00</amount>
		<dateTime>2023-09-21T19:02:39Z</dateTime>
		<reconciliationID>XFZ3ZMPB8H36</reconciliationID>
		<paymentStatus>settled</paymentStatus>
		<responseCode>00004</responseCode>
	</apCaptureReply>
</replyMessage>