Overview
Error Handling

Methods

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:

ParameterType
payment_methodOne of: 'ach', 'credit_card'
payment_profile_idA positive integer value (i.e. 1 and up).

Returns:

FieldType
bk_descA string of text, containing no newlines or other control characters.
cc_expA valid month/year in MM/YYYY format.
masked_numberA credit card number with only the last four digits exposed, preceded by any number of X's (i.e. XXXXXXXXXXXX1234).
payment_methodA valid payment method (check, credit_card, ach, paypal, paypal_agreement).
payment_profile_idA 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:

ParameterTypeNotes
customer_uuidA valid UUID (Universally Unique IDentifier).* Required if:
  • accnt is not given
payment_profile_idA positive integer value (i.e. 1 and up).

Returns:

FieldTypeNotes
account_ordersA non-negative integer value (i.e. 0 and up).* Optional
account_statusA valid account status (active, pending-modify, pending-new, suspended, or terminated).* Optional
addressA string permitting tabs, carriage returns and newlines* Optional
bk_descA string of text, containing no newlines or other control characters.* Optional
cc_expA valid month/year in MM/YYYY format.* Optional
cityA string permitting tabs, carriage returns and newlines* Optional
companyA string permitting tabs, carriage returns and newlines* Optional
countryA string permitting tabs, carriage returns and newlines* Optional
customer_uuidA valid UUID (Universally Unique IDentifier).* Optional
faxA string permitting tabs, carriage returns and newlines* Optional
fnameA string permitting tabs, carriage returns and newlines* Optional
issuerA single word, consisting of only letters and digits.* Optional
lnameA string permitting tabs, carriage returns and newlines* Optional
masked_numberA credit card number with only the last four digits exposed, preceded by any number of X's (i.e. XXXXXXXXXXXX1234).* Optional
payment_methodA valid payment method (check, credit_card, ach, paypal, paypal_agreement).* Optional
payment_profile_idA positive integer value (i.e. 1 and up).
phoneA string permitting tabs, carriage returns and newlines* Optional
stateA string permitting tabs, carriage returns and newlines* Optional
zipA 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:

ParameterType
communicator_urlA valid http or https uri (i.e. http://www.liquidweb.com).
customer_uuidA valid UUID (Universally Unique IDentifier).
payment_methodOne of: 'ach', 'credit_card'
reasonOne of: 'default', 'onetime'

Returns:

FieldTypeNotes
accntA valid account number, up to 6 digits in length.* Optional
customer_uuidA valid UUID (Universally Unique IDentifier).* Optional
form_tokenA 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:

FieldType
payment_methodA valid payment method (check, credit_card, ach, paypal, paypal_agreement).

Possible Errors:

Refer to the Error Handling documentation for the list of exception types