Skip to navigation
Payments API

Edit Hosted Payment Page

Allows for the editing of an existing hosted payment page. This will not remove existing components, but if something new is passed, it will override the existing field or add it to an existing payment page.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

hpp_client_idstringRequired
The client ID of the hosted payment page to edit

Request

This endpoint expects an object.
cc_midstringRequired

Merchant ID(s) associated with the hosted payment page. (Not editable after creation)

namestringOptional
Name of the Hosted Payment Page.
name_on_accountstringOptional
Name of the Customer.
amountstringOptional
Amount associated with the payment link.
lock_amountstringOptional

(true/false) whether the amount should be locked to the end user. Amount must be set in order to have this locked.

disable_after_paymentstringOptional

(true/false) whether the payment link should be disabled after 1 use.

success_redirect_urlstring or nullOptional<=1000 characters

Where to send the customer after an approved payment, instead of the Run success page.

  • Must be an https:// URL on a domain name. See Redirect after payment for the rules and the parameters added to the URL.
  • An invalid URL returns 400.
  • Omit it to keep the stored value. Send null or "" to clear it.
failure_redirect_urlstring or nullOptional<=1000 characters

Where to send the customer after a declined payment, instead of the Run decline page.

  • Must be an https:// URL on a domain name. See Redirect after payment for the rules and the parameters added to the URL.
  • An invalid URL returns 400.
  • Omit it to keep the stored value. Send null or "" to clear it.
min_amountstringOptional

Minimum amount, can only be present if “lock_amount” is “false”, can be equal to the amount if present.

max_amountstringOptional

Maximum amount, can only be present if “lock_amount” is “false”, can be equal to the amount if present.

hpp_optionslist of objectsOptional

An array containing the following parameters: Address (no optional pre-set value allowed), Phone, Email, Invoice ID, Custom Fields 01-05.

Response

HPP updated successfully
successboolean
Whether or not the edits were successfully made.
messagestring
Status message.
urlstring
The new url for the hosted payment page.
success_redirect_urlstring or nullOptional

The stored success destination in canonical form (lower-case scheme and host, :443 removed), or null if none is set.

failure_redirect_urlstring or nullOptional

The stored failure destination in canonical form (lower-case scheme and host, :443 removed), or null if none is set.

Errors

400
Bad Request Error
401
Unauthorized Error