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.
Add/Update Customer XML Request
| XML Element | Description |
|---|---|
| <add-customer|update-customer> | Type of transaction to perform. |
| api-key* | api-key is obtained in the security keys section of the control panel settings. |
| redirect-url* | A URL on your web server that the gateway will redirect your customer to after sensitive data collection. Value is not required for ‘update-customer’ requests when sensitive data is not being presented. Example: Updating an address or zip code only. |
| customer-vault-id | Load customer details from an existing Customer Vault record. If set, no payment information is required during step two. |
| merchant-defined-field-# | Merchant specified custom fields. Format:<merchant-defined-field-1>Value</merchant-defined-field-1> |
| source-transaction-id | Specifies a payment gateway transaction id in order to associate payment information with a Customer Vault record. |
| <billing> | The customer’s billing information |
| billing-id | Specify billing id. Required for ‘update-customer’ if multiple billing-ids exist, optional for ‘add-billing’. |
| first-name | Cardholder’s first name. |
| last-name | Cardholder’s last name. |
| address1 | Cardholder’s billing address. |
| city | Card billing city. |
| state | Card billing state/province. Format: CC |
| postal | Card billing postal code. |
| country | Card billing country code. Format: CC/ISO 3166 |
| phone | Billing phone number. |
| Billing email address. | |
| company | Cardholder’s company. |
| address2 | Card billing address, line 2. |
| fax | Billing fax number. |
| account-type | The customer’s ACH account type. Values: ‘checking’ or ‘savings’ |
| entity-type | The customer’s ACH account entity. Values: ‘personal’ or ‘business’ |
| priority | Specify priority (If omitted, will be auto-generated and returned in response). Format: Numeric, 1-255 |
| </billing> | |
| <shipping> | The customer’s shipping information. |
| shipping-id | Specify shipping id (Required for update-customer if multiple shipping-ids exist. Optional for add-billing). |
| first-name | Shipping first name. |
| last-name | Shipping last name. |
| address1 | Shipping billing address. |
| city | Shipping city. |
| state | Shipping state/province. Format: CC |
| postal | Shipping postal code. |
| country | Shipping country code. Format: CC/ISO 3166 |
| phone | Shipping phone number. |
| Shipping email address. | |
| company | Shipping company. |
| address2 | Shipping address, line 2. |
| fax | Shipping fax number. |
| priority | Specify priority, if omitted, will be auto-generated and returned in response. Format: Numeric, 1-255 |
| </shipping> | |
| </add-customer|update-customer> |
*Required
XML Response
| XML Element | Description |
|---|---|
| <response> | |
| result | 1=Approved 2=Declined 3=Error in transaction data or system error |
| result-text | Textual response. |
| result-code | Numeric mapping of processor responses. (See Result Code Table) |
| form-url | URL used as the action of the HTML form in step two. |
| </response> |