Overview
Error Handling

Methods

API Documentation (API Version bleed)

Billing/PayPal/Payment/

DESCRIPTION

This section contains methods for making PayPal payments to an account.

activate

URL:

https://api.liquidweb.com/bleed/Billing/PayPal/Payment/activate

Description:

Activates an account and subaccnt after receiving funds from paypal during a configurator order.

Parameters:

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

Returns:

FieldType
activeA boolean value (0 or 1).

Possible Errors:

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

create

URL:

https://api.liquidweb.com/bleed/Billing/PayPal/Payment/create

Description:

Creates a pending payment with PayPal to be applied to the given account for the given amount. The transaction will not be final until the user confirms with PayPal in their browser and we perform a call to paypalExecute.

Parameters:

ParameterTypeNotes
lineItemsAn array of associative arrays containing * Required
 
amountA monetary value, such as -$.05, 0.05, or -5.00* Required
descriptionA string of text, containing no newlines or other control characters.* Required
requested_amountA monetary value, such as -$.05, 0.05, or -5.00* Required
returnURLA string permitting tabs, carriage returns and newlines* Required

Returns:

FieldTypeNotes
accntA valid account number, up to 6 digits in length.
approval_typeA single word, consisting of only letters, digits, and underscores.* Optional
billing_agreement_idA string permitting tabs, carriage returns and newlines* Optional
created_dateA valid date and time in YYYY-MM-DD HH:MM:SS format.
idA positive integer value (i.e. 1 and up).
last_responseA string permitting tabs, carriage returns and newlines* Optional
merchantA single word, consisting of only letters and digits.* Optional
payer_idA string of text, containing no newlines or other control characters.* Optional
payment_stateA paypal payment state, such as created, pending, approved, failed, canceled, or expired* Optional
paypal_idA string of text, containing no newlines or other control characters.
requested_amountA positive floating-point value representing a price, allowing an optional 2 decimal points (must be two digits).
responseAn associative array of arbitrary keys and values.
sale_modeA paypal sale mode, such as INSTANT_TRANSFER, MANUAL_BANK_TRANSFER, or DELAYED_TRANSFER ECHECK* Optional
sale_stateA paypal sale state, such as pending, completed, refunded, denied, or partially_refunded* Optional
statusA single word, consisting of only letters, digits, hyphens, and underscores.* Optional

Possible Errors:

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

createForAccount

URL:

https://api.liquidweb.com/bleed/Billing/PayPal/Payment/createForAccount

Description:

Creates a pending payment with PayPal for an arbitrary account to be applied for the given amount. The transaction will not be final until the user confirms with PayPal in their browser and we perform a call to paypalExecute.

Parameters:

ParameterTypeNotes
accnt_numA valid account number, up to 6 digits in length.* Required
lineItemsAn array of associative arrays containing * Required
 
amountA monetary value, such as -$.05, 0.05, or -5.00* Required
descriptionA string of text, containing no newlines or other control characters.* Required
order_idA positive integer value (i.e. 1 and up).
requested_amountA monetary value, such as -$.05, 0.05, or -5.00* Required
returnURLA string permitting tabs, carriage returns and newlines* Required

Returns:

FieldTypeNotes
accntA valid account number, up to 6 digits in length.
approval_typeA single word, consisting of only letters, digits, and underscores.* Optional
billing_agreement_idA string permitting tabs, carriage returns and newlines* Optional
created_dateA valid date and time in YYYY-MM-DD HH:MM:SS format.
idA positive integer value (i.e. 1 and up).
last_responseA string permitting tabs, carriage returns and newlines* Optional
merchantA single word, consisting of only letters and digits.* Optional
payer_idA string of text, containing no newlines or other control characters.* Optional
payment_stateA paypal payment state, such as created, pending, approved, failed, canceled, or expired* Optional
paypal_idA string of text, containing no newlines or other control characters.
requested_amountA positive floating-point value representing a price, allowing an optional 2 decimal points (must be two digits).
responseAn associative array of arbitrary keys and values.
sale_modeA paypal sale mode, such as INSTANT_TRANSFER, MANUAL_BANK_TRANSFER, or DELAYED_TRANSFER ECHECK* Optional
sale_stateA paypal sale state, such as pending, completed, refunded, denied, or partially_refunded* Optional
statusA single word, consisting of only letters, digits, hyphens, and underscores.* Optional

Possible Errors:

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

details

URL:

https://api.liquidweb.com/bleed/Billing/PayPal/Payment/details

Description:

Finds a paypal payment and returns its details.

Parameters:

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

Returns:

FieldTypeNotes
accntA valid account number, up to 6 digits in length.
approval_typeA single word, consisting of only letters, digits, and underscores.* Optional
billing_agreement_idA string permitting tabs, carriage returns and newlines* Optional
created_dateA valid date and time in YYYY-MM-DD HH:MM:SS format.
idA positive integer value (i.e. 1 and up).
last_responseA string permitting tabs, carriage returns and newlines* Optional
merchantA single word, consisting of only letters and digits.* Optional
payer_idA string of text, containing no newlines or other control characters.* Optional
payment_stateA paypal payment state, such as created, pending, approved, failed, canceled, or expired* Optional
paypal_idA string of text, containing no newlines or other control characters.
requested_amountA positive floating-point value representing a price, allowing an optional 2 decimal points (must be two digits).
sale_modeA paypal sale mode, such as INSTANT_TRANSFER, MANUAL_BANK_TRANSFER, or DELAYED_TRANSFER ECHECK* Optional
sale_stateA paypal sale state, such as pending, completed, refunded, denied, or partially_refunded* Optional
statusA single word, consisting of only letters, digits, hyphens, and underscores.* Optional

Possible Errors:

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

execute

URL:

https://api.liquidweb.com/bleed/Billing/PayPal/Payment/execute

Description:

Finalizes a pending PayPal transaction and credits the approved amount to the given account.

Parameters:

ParameterTypeNotes
idA positive integer value (i.e. 1 and up).* Required
send_receiptA boolean value (0 or 1).* Optional
  • Defaults to: 1

Returns:

FieldTypeNotes
accntA valid account number, up to 6 digits in length.
approval_typeA single word, consisting of only letters, digits, and underscores.* Optional
billing_agreement_idA string permitting tabs, carriage returns and newlines* Optional
created_dateA valid date and time in YYYY-MM-DD HH:MM:SS format.
idA positive integer value (i.e. 1 and up).
last_responseA string permitting tabs, carriage returns and newlines* Optional
merchantA single word, consisting of only letters and digits.* Optional
payer_idA string of text, containing no newlines or other control characters.* Optional
payment_stateA paypal payment state, such as created, pending, approved, failed, canceled, or expired* Optional
paypal_idA string of text, containing no newlines or other control characters.
requested_amountA positive floating-point value representing a price, allowing an optional 2 decimal points (must be two digits).
responseAn associative array of arbitrary keys and values.
sale_modeA paypal sale mode, such as INSTANT_TRANSFER, MANUAL_BANK_TRANSFER, or DELAYED_TRANSFER ECHECK* Optional
sale_stateA paypal sale state, such as pending, completed, refunded, denied, or partially_refunded* Optional
statusA single word, consisting of only letters, digits, hyphens, and underscores.* Optional

Possible Errors:

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

update

URL:

https://api.liquidweb.com/bleed/Billing/PayPal/Payment/update

Description:

Updates the payer_id of a paypal payment.

Parameters:

ParameterTypeNotes
idA positive integer value (i.e. 1 and up).* Required
payer_idA string of text, containing no newlines or other control characters.
statusA single word, consisting of only letters and digits.

Returns:

FieldTypeNotes
accntA valid account number, up to 6 digits in length.
approval_typeA single word, consisting of only letters, digits, and underscores.* Optional
billing_agreement_idA string permitting tabs, carriage returns and newlines* Optional
created_dateA valid date and time in YYYY-MM-DD HH:MM:SS format.
idA positive integer value (i.e. 1 and up).
last_responseA string permitting tabs, carriage returns and newlines* Optional
merchantA single word, consisting of only letters and digits.* Optional
payer_idA string of text, containing no newlines or other control characters.* Optional
payment_stateA paypal payment state, such as created, pending, approved, failed, canceled, or expired* Optional
paypal_idA string of text, containing no newlines or other control characters.
requested_amountA positive floating-point value representing a price, allowing an optional 2 decimal points (must be two digits).
sale_modeA paypal sale mode, such as INSTANT_TRANSFER, MANUAL_BANK_TRANSFER, or DELAYED_TRANSFER ECHECK* Optional
sale_stateA paypal sale state, such as pending, completed, refunded, denied, or partially_refunded* Optional
statusA single word, consisting of only letters, digits, hyphens, and underscores.* Optional

Possible Errors:

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