Transaction Operations – Additional Operations
Capture XML Request
| Element | Description |
|---|
| <capture> |
| api-key* | api-key is obtained in the security keys section of the control panel settings. |
| transaction-id* | Original Payment Gateway transaction id. |
| amount | Total 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-number | Shipping tracking number. |
| shipping-carrier | Shipping carrier used.
Values: ‘ups’, ‘fedex’, ‘dhl’, or ‘usps’ |
| order-id | Order ID. |
| signature-image | Cardholder signature image.
Format: base64 encoded raw PNG image. (16kiB maximum) |
| </capture> |
Void XML Request
| Element | Description |
|---|
| <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> |
Refund XML Request
| Element | Description |
|---|
| <refund> |
| api-key* | api-key is obtained in the security keys section of the control panel settings. |
| transaction-id* | Original Payment Gateway transaction id. |
| amount | Total amount to be refunded. This amount may be equal to or less than the settled amount. Setting the amount to 0.00 will refund the entire amount. |
| merchant-defined-field-# | Merchant specified custom fields.
Format: <merchant-defined-field-1>Value</merchant-defined-field-1> |
| </refund> |
Update XML Request
| Element | Description |
|---|
| <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-number | Shipping tracking number. |
| shipping-carrier | Shipping carrier used.
Values: ‘ups’, ‘fedex’, ‘dhl’, or ‘usps’ |
| order-id | Order ID. |
| signature-image | Cardholder signature image.
Format: base64 encoded raw PNG image. (16kiB maximum) |
| </update> |
Complete Partial Payment XML Request
| Element | Description |
|---|
| <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> |
