Skip to main content

Documentation Index

Fetch the complete documentation index at: https://bancofcalifornia-preview.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

HTML 
<div id="transactions_additional_ops" class="current_content">
  <h1>
    Additional Operations<br />
    <span class="section">Three-Step: Transactions</span>
  </h1>
  <h2>Capture XML Request</h2>
  <table>
    <tbody>
      <tr>
        <th>Element</th>
        <th>Description</th>
      </tr>
      <tr>
        <td class="outerElement" colspan="2">&lt;capture&gt;</td>
      </tr>
      <tr>
        <td>api-key<sup>*</sup></td>
        <td>api-key is obtained in the security keys section of the control panel settings.</td>
      </tr>
      <tr>
        <td>transaction-id<sup>*</sup></td>
        <td>Original Payment Gateway transaction id.</td>
      </tr>
      <tr>
        <td>amount</td>
        <td>Total amount to be settled, this amount may be equal to or less than the authorized amount.</td>
      </tr>
      <tr>
        <td>merchant-defined-field-#</td>
        <td>
          Merchant specified custom fields.<br />
          <span class="allowed">
            Format: &lt;merchant-defined-field-1&gt;Value&lt;/merchant-defined-field-1&gt;
          </span>
        </td>
      </tr>
      <tr>
        <td>tracking-number</td>
        <td>Shipping tracking number.</td>
      </tr>
      <tr>
        <td>shipping-carrier</td>
        <td>
          Shipping carrier used.<br />
          <span class="allowed">Values: 'ups', 'fedex', 'dhl', or 'usps'</span>
        </td>
      </tr>
      <tr>
        <td>order-id</td>
        <td>Order ID.</td>
      </tr>
      <tr>
        <td>signature-image</td>
        <td>
          Cardholder signature image.<br />
          <span class="allowed">Format: base64 encoded raw PNG image. (16kiB maximum)</span>
        </td>
      </tr>
      <tr>
        <td class="outerElement" colspan="2">&lt;/capture&gt;</td>
      </tr>
    </tbody>
  </table>
  <table class="footnotes">
    <tbody>
      <tr>
        <td>*</td>
        <td>Required</td>
      </tr>
    </tbody>
  </table>
  <h2>Void XML Request</h2>
  <table>
    <tbody>
      <tr>
        <th>Element</th>
        <th>Description</th>
      </tr>
      <tr>
        <td class="outerElement" colspan="2">&lt;void&gt;</td>
      </tr>
      <tr>
        <td>api-key<sup>*</sup></td>
        <td>api-key is obtained in the security keys section of the control panel settings.</td>
      </tr>
      <tr>
        <td>transaction-id<sup>*</sup></td>
        <td>Original Payment Gateway transaction id.</td>
      </tr>
      <tr>
        <td>merchant-defined-field-#</td>
        <td>
          Merchant specified custom fields.<br />
          <span class="allowed">
            Format: &lt;merchant-defined-field-1&gt;Value&lt;/merchant-defined-field-1&gt;
          </span>
        </td>
      </tr>
      <tr>
        <td class="outerElement" colspan="2">&lt;/void&gt;</td>
      </tr>
    </tbody>
  </table>
  <table class="footnotes">
    <tbody>
      <tr>
        <td>*</td>
        <td>Required</td>
      </tr>
    </tbody>
  </table>
  <h2>Refund XML Request</h2>
  <table>
    <tbody>
      <tr>
        <th>Element</th>
        <th>Description</th>
      </tr>
      <tr>
        <td class="outerElement" colspan="2">&lt;refund&gt;</td>
      </tr>
      <tr>
        <td>api-key<sup>*</sup></td>
        <td>api-key is obtained in the security keys section of the control panel settings.</td>
      </tr>
      <tr>
        <td>transaction-id<sup>*</sup></td>
        <td>Original Payment Gateway transaction id.</td>
      </tr>
      <tr>
        <td>amount</td>
        <td>
          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.
        </td>
      </tr>
      <tr>
        <td>merchant-defined-field-#</td>
        <td>
          Merchant specified custom fields.<br />
          <span class="allowed">
            Format: &lt;merchant-defined-field-1&gt;Value&lt;/merchant-defined-field-1&gt;
          </span>
        </td>
      </tr>
      <tr>
        <td class="outerElement" colspan="2">&lt;/refund&gt;</td>
      </tr>
    </tbody>
  </table>
  <table class="footnotes">
    <tbody>
      <tr>
        <td>*</td>
        <td>Required</td>
      </tr>
    </tbody>
  </table>
  <h2>Update XML Request</h2>
  <table>
    <tbody>
      <tr>
        <th>Element</th>
        <th>Description</th>
      </tr>
      <tr>
        <td class="outerElement" colspan="2">&lt;update&gt;</td>
      </tr>
      <tr>
        <td>api-key<sup>*</sup></td>
        <td>api-key is obtained in the security keys section of the control panel settings.</td>
      </tr>
      <tr>
        <td>transaction-id<sup>*</sup></td>
        <td>Original Payment Gateway transaction id.</td>
      </tr>
      <tr>
        <td>merchant-defined-field-#</td>
        <td>
          Merchant specified custom fields.<br />
          <span class="allowed">
            Format: &lt;merchant-defined-field-1&gt;Value&lt;/merchant-defined-field-1&gt;
          </span>
        </td>
      </tr>
      <tr>
        <td>tracking-number</td>
        <td>Shipping tracking number.</td>
      </tr>
      <tr>
        <td>shipping-carrier</td>
        <td>
          Shipping carrier used.<br />
          <span class="allowed">Values: 'ups', 'fedex', 'dhl', or 'usps'</span>
        </td>
      </tr>
      <tr>
        <td>order-id</td>
        <td>Order ID.</td>
      </tr>
      <tr>
        <td>signature-image</td>
        <td>
          Cardholder signature image.<br />
          <span class="allowed">Format: base64 encoded raw PNG image. (16kiB maximum)</span>
        </td>
      </tr>
      <tr>
        <td class="outerElement" colspan="2">&lt;/update&gt;</td>
      </tr>
    </tbody>
  </table>
  <table class="footnotes">
    <tbody>
      <tr>
        <td>*</td>
        <td>Required</td>
      </tr>
    </tbody>
  </table>
  <h2>Complete Partial Payment XML Request</h2>
  <table>
    <tbody>
      <tr>
        <th>Element</th>
        <th>Description</th>
      </tr>
      <tr>
        <td class="outerElement" colspan="2">&lt;complete-partial-payment&gt;</td>
      </tr>
      <tr>
        <td>api-key<sup>*</sup></td>
        <td>api-key is obtained in the security keys section of the control panel settings.</td>
      </tr>
      <tr>
        <td>partial-payment-id<sup>*</sup></td>
        <td>
          Specify a partial payment ID. Required to collect an additional amount associated with an
          existing Partial Payment Transaction. Do not use on initial transaction.
        </td>
      </tr>
      <tr>
        <td class="outerElement" colspan="2">&lt;/complete-partial-payment&gt;</td>
      </tr>
    </tbody>
  </table>
  <table class="footnotes">
    <tbody>
      <tr>
        <td>*</td>
        <td>Required</td>
      </tr>
    </tbody>
  </table>
</div>