Overview
Error Handling

Methods

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:

ParameterTypeNotes
amountA monetary value, such as -$.05, 0.05, or -5.00* Required
auth_onlyA boolean value (0 or 1).
bill_idA positive integer value (i.e. 1 and up).
card_codeThe 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_typeOne of: 'creditcard', 'paypal'* Required
transaction_dateA valid date and time in YYYY-MM-DD HH:MM:SS format, or a DateTime object.

Returns:

FieldTypeNotes
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:

ParameterTypeNotes
alsowithA single word, consisting of only letters, digits, and underscores.
idA positive integer value (i.e. 1 and up).* Required

Returns:

FieldTypeNotes
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:

ParameterTypeNotes
alsowithA single word, consisting of only letters, digits, and underscores.
hide_voidA boolean value (0 or 1).* Optional
  • Defaults to: 1
order_byAn associative array containing the fields:
 
fieldOne of: 'balance', 'bill_id', 'created_date', 'id', 'is_closed'* Required
sortOne of: 'asc', 'desc'* Optional
  • Defaults to: desc
page_numA positive integer value (i.e. 1 and up).* Optional
  • Defaults to: 1
page_sizeA positive integer value (i.e. 1 and up).* Optional
  • Defaults to: 25
sort_orderOne of: 'ASC', 'DESC', 'asc', 'desc'

Returns:

FieldType
item_countA non-negative integer value (i.e. 0 and up).
item_totalA non-negative integer value (i.e. 0 and up).
itemsAn array of associative arrays containing
 
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
page_numA positive integer value (i.e. 1 and up).
page_sizeA positive integer value (i.e. 1 and up).
page_totalA 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:

ParameterTypeNotes
amountA positive monetary value, such as $.05, 0.05, or 5.00* Required
card_codeThe 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_idA positive integer value (i.e. 1 and up).

Returns:

FieldType
amountA 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