Additional Operations

Three-Step: Transactions

Capture XML Request

ElementDescription
<capture>
api-key*api-key is obtained in the security keys section of the control panel settings.
transaction-id*Original Payment Gateway transaction id.
amountTotal amount to be settled, this amount may be equal to or less than the authorized amount.
merchant-defined-field-#Merchant specified custom fields.
Format: <merchant-defined-field-1>Value</merchant-defined-field-1>
tracking-numberShipping tracking number.
shipping-carrierShipping carrier used.
Values: ‘ups’, ‘fedex’, ‘dhl’, or ‘usps’
order-idOrder ID.
</capture>
*Required

Void XML Request

ElementDescription
<void>
api-key*api-key is obtained in the security keys section of the control panel settings.
transaction-id*Original Payment Gateway transaction id.
merchant-defined-field-#Merchant specified custom fields.
Format: <merchant-defined-field-1>Value</merchant-defined-field-1>
</void>
*Required

Refund XML Request

ElementDescription
<refund>
api-key*api-key is obtained in the security keys section of the control panel settings.
transaction-id*Original Payment Gateway transaction id.
amountTotal amount to be settled, this amount may be equal to or less than the authorized amount.
merchant-defined-field-#Merchant specified custom fields.
Format: <merchant-defined-field-1>Value</merchant-defined-field-1>
</refund>
*Required

Update XML Request

ElementDescription
<update>
api-key*api-key is obtained in the security keys section of the control panel settings.
transaction-id*Original Payment Gateway transaction id.
merchant-defined-field-#Merchant specified custom fields.
Format: <merchant-defined-field-1>Value</merchant-defined-field-1>
tracking-numberShipping tracking number.
shipping-carrierShipping carrier used.
Values: ‘ups’, ‘fedex’, ‘dhl’, or ‘usps’
order-idOrder ID.
</update>
*Required

Complete Partial Payment XML Request

ElementDescription
<complete-partial-payment>
api-key*api-key is obtained in the security keys section of the control panel settings.
partial-payment-id*Specify a partial payment ID. Required to collect an additional amount associated with an existing Partial Payment Transaction. Do not use on initial transaction.
</complete-partial-payment>
*Required