Skip to navigation
Payments API

Create Hosted Payment Page

Creates a hosted payment page based on the parameters provided. The response will provide a link directly to the page for a customer to pay for an amount.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
namestringRequired
Name of the Hosted Payment page.
cc_midstringRequired

Merchant ID of the credit card MID to be used on the page. (Required if no ach_mid is provided.)

ach_midstringOptional

Merchant ID of the ACH MID to be used on the page. (Required if no cc_mid is provided.)

name_on_accountstringOptional

Customer name to be pre-filled on the HPP.

amountstringOptional

Amount to be pre-filled on the HPP.

lock_amountbooleanOptional
Setting if the amount should be locked or not.
disable_after_paymentbooleanOptional
Setting if the HPP should be disabled after payment.
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.
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.
hpp_optionslist of objectsOptional

Custom settings for an individual HPP.
Possible values include custom_01 through custom_05, invoice_id, address, phone or email.

Response

Hosted payment page created successfully
urlstring
Link to the hosted payment page for the customer.
successbooleanOptional

true when the page was created.

messagestringOptional

HPP created successfully.

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