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/
DESCRIPTION
This section contains methods for making payments to an account.
create
URL:
https://api.liquidweb.com/bleed/Billing/Payment/create
Description:
Creates a payment on the account
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| amount | A monetary value, such as -$.05, 0.05, or -5.00 | * Required |
| auth_only | A boolean value (0 or 1). | |
| bill_id | A positive integer value (i.e. 1 and up). | |
| card_code | The cvv code of a credit card, consisting of a number at least 3 digits and up to 4 digits in length (i.e. 1234, 010, etc). | |
| payment_type | One of: 'creditcard', 'paypal' | * Required |
| transaction_date | A valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object. |
Returns:
| Field | Type | Notes |
|---|---|---|
| accnt | A valid account number, up to 6 digits in length. Account the payment is associated with | |
| balance | A monetary value, such as -$.05, 0.05, or -5.00 The amount of funds left on payment | |
| bill_id | A positive integer value (i.e. 1 and up). Bill payment is associated with, optional. | * Optional |
| created_date | A valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object. Date / time payment was created | |
| id | A positive integer value (i.e. 1 and up). A unique id for a payment. | |
| is_closed | A boolean value (0 or 1). Reflects if the payment is closed(reported to accountants) or not | |
| paymentSource | An associative array of arbitrary keys and values. Hash of details about the payment source | * Optional |
| receipt_sent | A boolean value (0 or 1). Reflects if payment receipt has been sent or not | |
| source_id | A positive integer value (i.e. 1 and up). An id for the payment source. | |
| transactions | An array of arbitrary values. Array of payment transactions | * Optional |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
details
URL:
https://api.liquidweb.com/bleed/Billing/Payment/details
Description:
Provides details of a given payment
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| alsowith | A single word, consisting of only letters, digits, and underscores. | |
| id | A positive integer value (i.e. 1 and up). | * Required |
Returns:
| Field | Type | Notes |
|---|---|---|
| accnt | A valid account number, up to 6 digits in length. Account the payment is associated with | |
| balance | A monetary value, such as -$.05, 0.05, or -5.00 The amount of funds left on payment | |
| bill_id | A positive integer value (i.e. 1 and up). Bill payment is associated with, optional. | * Optional |
| created_date | A valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object. Date / time payment was created | |
| id | A positive integer value (i.e. 1 and up). A unique id for a payment. | |
| is_closed | A boolean value (0 or 1). Reflects if the payment is closed(reported to accountants) or not | |
| paymentSource | An associative array of arbitrary keys and values. Hash of details about the payment source | * Optional |
| receipt_sent | A boolean value (0 or 1). Reflects if payment receipt has been sent or not | |
| source_id | A positive integer value (i.e. 1 and up). An id for the payment source. | |
| transactions | An array of arbitrary values. Array of payment transactions | * Optional |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
list
URL:
https://api.liquidweb.com/bleed/Billing/Payment/list
Description:
List payments on the given account
Parameters:
| Parameter | Type | Notes | ||||||
|---|---|---|---|---|---|---|---|---|
| alsowith | A single word, consisting of only letters, digits, and underscores. | |||||||
| hide_void | A boolean value (0 or 1). | * Optional
| ||||||
| order_by | An associative array containing the fields: | |||||||
| ||||||||
| page_num | A positive integer value (i.e. 1 and up). | * Optional
| ||||||
| page_size | A positive integer value (i.e. 1 and up). | * Optional
| ||||||
| sort_order | One of: 'ASC', 'DESC', 'asc', 'desc' | |||||||
Returns:
| Field | Type | |||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| item_count | A non-negative integer value (i.e. 0 and up). | |||||||||||||||||||||||||||||||
| item_total | A non-negative integer value (i.e. 0 and up). | |||||||||||||||||||||||||||||||
| items | An array of associative arrays containing | |||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||
| page_num | A positive integer value (i.e. 1 and up). | |||||||||||||||||||||||||||||||
| page_size | A positive integer value (i.e. 1 and up). | |||||||||||||||||||||||||||||||
| page_total | A positive integer value (i.e. 1 and up). | |||||||||||||||||||||||||||||||
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
make
URL:
https://api.liquidweb.com/bleed/Billing/Payment/make
Description:
Charges the credit card on file for the given account the given amount, and applies those new funds to the account. Currently this method is only useful for credit card accounts or a one-time credit card profile. A forbidden exception will be thrown if used with a check account without providing a one-time profile.
Parameters:
| Parameter | Type | Notes |
|---|---|---|
| amount | A positive monetary value, such as $.05, 0.05, or 5.00 | * Required |
| card_code | The cvv code of a credit card, consisting of a number at least 3 digits and up to 4 digits in length (i.e. 1234, 010, etc). | |
| payment_profile_id | A positive integer value (i.e. 1 and up). |
Returns:
| Field | Type |
|---|---|
| amount | A positive monetary value, such as $.05, 0.05, or 5.00 |
Possible Errors:
Refer to the Error Handling documentation for the list of exception types
