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 Subscription to an Existing Plan
| Element | Description |
|---|
| <add-subscription> | Associate payment information with a recurring plan. |
| 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 when sensitive data is not presented. Example: Adding a Subscription using a Customer Vault ID. |
| customer-vault-id | Load customer details from an existing Customer Vault record . If set, no payment information is required during step two. |
| start-date | The first day that the customer will be charged. Format: YYYYMMDD |
| order-id | Order id. |
| po-number | Cardholder’s purchase order number. |
| order-description | Order description. |
| currency | Set transaction currency. Format: ISO 4217 |
| tax-amount | The sales tax included in the transaction amount associated with the purchase. Setting tax equal to any negative value indicates an order that is exempt from sales tax. Default: 0.00’ Format: x.xx |
| shipping-amount | Total shipping amount. |
| 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 Subscription record. |
| <plan> | |
| plan-id* | The unique plan ID that references only this recurring plan. |
| </plan> | |
| <billing> | The customer’s billing information |
| billing-id | Specify billing id. Recommended when using Customer Vault hybrid action. Will be ignored if no hybrid add/update-customer is done. |
| 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. |
| email | 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’ |
| </billing> | |
| <shipping> | The customer’s shipping information. |
| shipping-id | Specify shipping id. Recommended when using Customer Vault hybrid action. Will be ignored if no hybrid add/update-customer is done. |
| 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. |
| email | Shipping email address. |
| company | Shipping company. |
| address2 | Shipping address, line 2. |
| fax | Shipping fax number. |
| </shipping> | |
| </add-subscription> | |
* Always required** Required for ACH transactions
Add Subscription to a Custom Plan
| Element | Description |
|---|
| <add-subscription> | Associate payment information with a recurring plan. |
| 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 when sensitive data is not presented. Example: Adding a Subscription using a Customer Vault ID. |
| customer-vault-id | Load customer details from an existing Customer Vault record . If set, no payment information is required during step two. |
| start-date | The first day that the customer will be charged. Format: YYYYMMDD |
| order-id | Order id. |
| po-number | Cardholder’s purchase order number. |
| order-description | Order description. |
| currency | Set transaction currency. Format: ISO 4217 |
| tax-amount | The sales tax included in the transaction amount associated with the purchase. Setting tax equal to any negative value indicates an order that is exempt from sales tax. Default: ‘0.00’ Format: x.xx |
| shipping-amount | Total shipping amount. |
| 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 Subscription record. |
| <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 |
| 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 biling information |
| billing-id | Specify billing id. Recommended when using Customer Vault hybrid action. Will be ignored if no hybrid add/update-customer is done. |
| 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. |
| email | 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’ |
| </billing> | |
| <shipping> | The customer’s shipping information. |
| shipping-id | Specify shipping id. Recommended when using Customer Vault hybrid action. Will be ignored if no hybrid add/update-customer is done. |
| 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. |
| email | Shipping email address. |
| company | Shipping company. |
| address2 | Shipping address, line 2. |
| fax | Shipping fax number. |
| </shipping> | |
| </add-subscription> | |
* Always required** Required for ACH transactions*** Required unless ‘month-frequency’ and ‘day-of-month’ is set.**** Required unless ‘day-frequency’ is set.
| Element | Description |
|---|
| <update-subscription> | Update Customer’s information for a subscription. |
| 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 when sensitive data is not presented. Example: Updating a Subscription using a Customer Vault ID. |
| subscription-id* | The subscription that will be updated. |
| order-id | Order id. |
| po-number | Cardholder’s purchase order number. |
| order-description | Order description. |
| currency | Set transaction currency. Format: ISO 4217 |
| merchant-defined-field-# | Merchant specified custom fields. Format: <merchant-defined-field-1>Value</merchant-defined-field-1> |
| <billing> | The customer’s billing information |
| 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. |
| email | 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’ |
| </billing> | |
| <shipping> | The customer’s shipping information. |
| 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. |
| email | Shipping email address. |
| company | Shipping company. |
| address2 | Shipping address, line 2. |
| fax | Shipping fax number. |
| </shipping> | |
| </update-subscription> | |
* Always Required.** Required for ACH subscriptions.
