Payment Page

post

https://api.clientpay.com/PaymentPage/Forms/Add

Creates a flexible payment page that can accept any number of line items and can be configured to display up to 3 custom data points per item.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

accessId

string

required

Required for authentication

requestId

string

required

Required for authentication

items

array of objects

required

Required. One or more items must be provided.

items*

sessionId

string

The unique value optionally provided by API caller and added to payment. Useful for subsequent queries via "Status" endpoint.

billingAddress

string

Prepopulate the Address Line 1 (street) on the Payment page; (100 Chars Max).

billingCity

string

Prepopulate the city for the payment page; (100 Chars Max).

billingStateCode

string

Prepopulate the billing State on the payment form. Must be valid 2 letter code for US States and Canadian Provinces/Territories

billingZipCode

string

Prepopulate the billing Zip on the payment form.

enableClientSidePostBack

boolean

If True, will submit a windows.post message which can be read by parent window in the event that payment page is being presented in an iframe.

clientSideReturnAddress

string

If provided, will validate that given URL matches URL of parent window before generating windows.post message.

hideCustomerHeaderLogo

boolean

Defaults to false

If True, hides customer logo. False will display.

bccEmail

string

Upon completion of payment, any email address(es) entered here will receive a copy of the receipt. Multiple emails should be comma separated.

customHeaderText

string

Custom text that will display in large font at the top of the payment page.

itemIDLabel

string

Defaults to Item ID

This is the label that will accompany the Item ID in the items object. If no value provided, default is Item ID.

itemNameLabel

string

Defaults to Item Name

This is the label that will accompany the Item Name. If no value provided, default is Item Name.

lineItemDescriptionLabel

string

Defaults to Item Description

This is the label that will accompany the Line Item Description. If no value provided, default is Item Description.

customFooterText

string

Custom text that will display at the bottom of the page directly above the submit button.

Responses

200200

400400