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.
Complete Action XML Request
| XML Element | Description |
|---|---|
| <complete-action> | |
| api-key* | api-key is obtained in the security keys section of the control panel settings. |
| token-id* | Customer payment token returned during step two. |
| </complete-action> |
*Required
Complete Action XML Response
| XML Element | Description |
|---|---|
| response | |
| result | 1=Transaction Approved 2=Transction Declined 3=Error in transaction data or system error |
| result-text | Textual response. |
| result-code | Numeric mapping of processor responses. (See Result Code Table) |
| action-type | Action type that was initially specified. Values: ‘sale’, ‘auth’, ‘credit’, ‘validate’, or ‘offline’ |
| subscription-id | Subscription ID used or created during action. |
| merchant-defined-field-# | Merchant specified custom fields. Format: <merchant-defined-field-1>Value</merchant-defined-field-1> |
| <plan> | |
| payments | The number of payments before the recurring plan is complete. Notes: ‘0’ for until canceled |
| amount | The plan amount to be charged each billing cycle. Format: x.xx |
| name | The display name of the plan. |
| plan-id | The plan ID that is associated with this subscription. |
| day-frequency | How often, in days, to charge the customer. Cannot be set with ‘month-frequency’ or ‘day-of-month’. |
| month-frequency | How often, in months, to charge the customer. Cannot be set with ‘day-frequency’. Must be set with ‘day-of-month’. Values: 1 through 24 |
| day-of-month | The day that the customer will be charged. Cannot be set with ‘day-frequency’. Must be set with ‘month-frequency’. Values: 1 through 31 - for months without 29, 30, or 31 days, the charge will be on the last day |
| </plan> | |
| <billing> | The customer’s billing information. |
| billing-id | Billing id used or created for this action. |
| 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. |
| social-security-number | Customer’s social security number |
| drivers-license-number | Drivers license number. |
| drivers-license-dob | Drivers license date of birth. |
| drivers-license-state | Customer’s drivers license state. Format: CC |
| cc-number | Masked credit card number. Format: XXXXXX********XXXX |
| cc-exp | Credit card expiration. Format: MMYY |
| account-name | The name on the customer’s bank account. |
| account-number | Masked bank account number. Format: X****XXXX |
| routing-number | Masked bank routing number. Format: X****XXXX |
| 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 | Billing id priority. Format: Numeric, 1-255 |
| </billing> | |
| <shipping> | The customer’s shipping information. |
| shipping-id | Shipping id used or created during action. |
| first-name | Shipping first name. |
| last-name | Shipping last name. |
| address1 | Shipping 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 | Shipping id priority. Format: Numeric, 1-255 |
| </shipping> | |
| </response> |