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.

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 or null
Whether or not the edits were successfully made.
messagestring or null
Status message.
urlstring or null
The new url for the hosted payment page.

Errors