Overview
Error Handling

Methods

API Documentation (API Version bleed)

Billing/PayPal/Agreement/

bindAgreement

URL:

https://api.liquidweb.com/bleed/Billing/PayPal/Agreement/bindAgreement

Description:

Parameters:

ParameterTypeNotes
set_pay_methodA boolean value (0 or 1).
tokenA string.* Required

Returns:

FieldType
agreement_stateOne of: 'ACTIVE', 'INACTIVE'

Possible Errors:

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

bindAgreementForAccount

URL:

https://api.liquidweb.com/bleed/Billing/PayPal/Agreement/bindAgreementForAccount

Description:

Parameters:

ParameterTypeNotes
accnt_numA valid account number, up to 6 digits in length.* Required
set_pay_methodA boolean value (0 or 1).
tokenA string.* Required

Returns:

FieldType
agreement_stateOne of: 'ACTIVE', 'INACTIVE'

Possible Errors:

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

createToken

URL:

https://api.liquidweb.com/bleed/Billing/PayPal/Agreement/createToken

Description:

Parameters:

ParameterTypeNotes
extra_paramsAn associative array containing the fields:
 
amountA monetary value, such as -$.05, 0.05, or -5.00* Required if:
  • make_payment is set to '1'
make_paymentA boolean value (0 or 1).
systemOne of: 'cart', 'manage_billing', 'mylw'* Optional
  • Defaults to: cart

Returns:

FieldType
approval_urlA valid http or https uri (i.e. http://www.liquidweb.com).
tokenA string.

Possible Errors:

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

createTokenForAccount

URL:

https://api.liquidweb.com/bleed/Billing/PayPal/Agreement/createTokenForAccount

Description:

Parameters:

ParameterTypeNotes
accnt_numA valid account number, up to 6 digits in length.* Required

Returns:

FieldType
approval_urlA valid http or https uri (i.e. http://www.liquidweb.com).
tokenA string.

Possible Errors:

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