hello,
Home Page
Overview
Error Handling
Error Handling
Methods
- Account/
- Account/Auth/
- Account/Auth/TwoFactor/
- Account/BillingAddress/
- Account/ChangeOrder/Source/
- Account/ChatPassword/
- Account/Contact/
- Account/CreditCard/
- Account/Cycle/
- Account/Limits/
- Account/PasswordReset/
- Account/Paymethod/
- Account/SSH/Key/
- Account/Settings/
- Account/Subscriptions/
- Account/User/
- Account/User/StateData/
- Acronis/Backup/
- Asset/
- Asset/Connections/
- Asset/ControlPanel/Credentials/
- Asset/Measurements/
- Asset/Monitoring/
- Attribution/
- Basket/
- Basket/Domain/
- Basket/Item/
- Basket/Item/Config/
- Billing/
- Billing/Bill/
- Billing/Credit/
- Billing/CreditCard/Profile/
- Billing/Cycle/
- Billing/Invoice/
- Billing/Invoice/Preview/
- Billing/PayPal/Agreement/
- Billing/PayPal/Payment/
- Billing/Payment/
- Billing/Payment/Profile/
- BusinessEmail/Customer/
- BusinessEmail/Domain/
- Cloud/Backup/
- Cloud/Config/
- Cloud/IP/Pool/
- Cloud/Image/
- Cloud/Private/Parent/
- Cloud/Server/
- Cloud/Template/
- CloudSites/
- CloudSites/Usage/
- CodeGuard/User/
- Contact/
- Coupon/
- Coupon/Claim/
- Domain/
- Domain/Services/
- HostedEmail/Customer/
- HostedEmail/Domain/
- Licensing/
- Licensing/Cpanel/
- Licensing/Plesk/
- Market/Bundle/
- Market/Bundle/Package/
- Market/Cart/
- Market/Cart/Admin/Quote/
- Market/Cart/Discount/
- Market/Cart/Helpers/Configurator/
- Market/Cart/Item/
- Market/Package/
- Market/Package/Product/
- Market/Place/
- Meta/Timing/
- Migration/
- Migration/Account/
- Migration/Account/Server/
- Migration/Account/Server/Access/
- Migration/Destination/
- Monitoring/Bandwidth/
- Monitoring/Load/
- Monitoring/MWP/
- Monitoring/Services/
- Network/CDN/User/
- Network/CDN/Zone/
- Network/DNS/Domain/
- Network/DNS/Domain/Contact/
- Network/DNS/Domain/Nameserver/
- Network/DNS/Domain/Transfer/
- Network/DNS/Record/
- Network/DNS/Reverse/
- Network/DNS/Zone/
- Network/DNS/Zone/History/
- Network/Firewall/
- Network/Firewall/Ruleset/
- Network/IP/
- Network/LoadBalancer/
- Network/Pool/
- Network/Private/
- Network/Region/
- Network/SSHKey/
- Network/Util/
- Network/Zone/
- Notifications/
- OneTimeSecret/
- Order/AddOn/
- Product/
- Product/Addon/
- Product/Marketplace/
- Product/Series/
- Project/
- SSL/Certificate/
- Salesforce/Account/InterWorx/
- Salesforce/Chat/Auth/
- Salesforce/User/
- Server/
- Server/Auth/
- Server/Power/
- Server/VirtualDomain/
- Server/WHM/AccessHash/
- Server/WHM/DNS/
- Server/WHM/Firewall/
- Signup/Basic/
- Storage/Block/Cluster/
- Storage/Block/Volume/
- Storage/ObjectStore/
- Support/Alert/
- Support/Request/
- Support/Request/Attachment/
- Support/SystemStatus/
- Support/Ticket/Auth/
- Tags/Product/
- UserTask/
- Utilities/Info/
- VIP/
- VMware/vCloud/vDC/
- VPN/
- VPN/User/
- WWW/Cart/
- WordPress/Domain/
API Documentation (API Version bleed)
Billing/Payment/Profile/
DESCRIPTION
This section contains methods for managing customer payment profiles (used for automatic payment).
apply
URL:
https://api.liquidweb.com/bleed/Billing/Payment/Profile/apply
Description:
Designate a payment profile to be used for the specified account. (Called after submitting the hosted form.)
Parameters:
| Parameter | Type |
|---|---|
| payment_method | One of: 'ach', 'credit_card' |
| payment_profile_id | A positive integer value (i.e. 1 and up). |
Returns:
| Field | Type |
|---|---|
| bk_desc | A string of text, containing no newlines or other control characters. |
| cc_exp | A valid month/year in MM/YYYY format. |
| masked_number | A credit card number with only the last four digits exposed, preceded by any number of X's (i.e. XXXXXXXXXXXX1234). |
| payment_method | A valid payment method (check, credit_card, ach, paypal, paypal_agreement). |
| payment_profile_id | A positive integer value (i.e. 1 and up). |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
details
URL:
https://api.liquidweb.com/bleed/Billing/Payment/Profile/details
Description:
Get details for a profile.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| customer_uuid | A valid UUID (Universally Unique IDentifier). | * Required if:
|
| payment_profile_id | A positive integer value (i.e. 1 and up). |
Returns:
| Field | Type | Notes |
|---|---|---|
| account_orders | A non-negative integer value (i.e. 0 and up). | * Optional |
| account_status | A valid account status (active, pending-modify, pending-new, suspended, or terminated). | * Optional |
| address | A string permitting tabs, carriage returns and newlines | * Optional |
| bk_desc | A string of text, containing no newlines or other control characters. | * Optional |
| cc_exp | A valid month/year in MM/YYYY format. | * Optional |
| city | A string permitting tabs, carriage returns and newlines | * Optional |
| company | A string permitting tabs, carriage returns and newlines | * Optional |
| country | A string permitting tabs, carriage returns and newlines | * Optional |
| customer_uuid | A valid UUID (Universally Unique IDentifier). | * Optional |
| fax | A string permitting tabs, carriage returns and newlines | * Optional |
| fname | A string permitting tabs, carriage returns and newlines | * Optional |
| issuer | A single word, consisting of only letters and digits. | * Optional |
| lname | A string permitting tabs, carriage returns and newlines | * Optional |
| masked_number | A credit card number with only the last four digits exposed, preceded by any number of X's (i.e. XXXXXXXXXXXX1234). | * Optional |
| payment_method | A valid payment method (check, credit_card, ach, paypal, paypal_agreement). | * Optional |
| payment_profile_id | A positive integer value (i.e. 1 and up). | |
| phone | A string permitting tabs, carriage returns and newlines | * Optional |
| state | A string permitting tabs, carriage returns and newlines | * Optional |
| zip | A string permitting tabs, carriage returns and newlines | * Optional |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
hostedFormToken
URL:
https://api.liquidweb.com/bleed/Billing/Payment/Profile/hostedFormToken
Description:
Get a form_token that can be used to present the Authorize.net Hosted Form.
Parameters:
| Parameter | Type |
|---|---|
| communicator_url | A valid http or https uri (i.e. http://www.liquidweb.com). |
| customer_uuid | A valid UUID (Universally Unique IDentifier). |
| payment_method | One of: 'ach', 'credit_card' |
| reason | One of: 'default', 'onetime' |
Returns:
| Field | Type | Notes |
|---|---|---|
| accnt | A valid account number, up to 6 digits in length. | * Optional |
| customer_uuid | A valid UUID (Universally Unique IDentifier). | * Optional |
| form_token | A string permitting tabs, carriage returns and newlines |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
remove
URL:
https://api.liquidweb.com/bleed/Billing/Payment/Profile/remove
Description:
Removes any existing payment profile and sets the account's payment method to check.
Parameters:
No Values Defined
Returns:
| Field | Type |
|---|---|
| payment_method | A valid payment method (check, credit_card, ach, paypal, paypal_agreement). |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
