Invoice

post

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

In order to create an Invoice Payment Page, you need an invoice object. You can create single or multi-invoice payment pages with the Invoice call. The invoices array, with the Invoice call, can be used to create multiple invoice objects.

If the call is successful, an Invoice Payment Page URL will be returned in order to process a payment. A RequestID is created for the API Invoice Payment Page as a unique identifier.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

accessId

string

required

The accessId credential used to authenticate the requester

requestId

string

required

Unique identifier for the request

customerRefNumber

string

Provided by you in initial POST apiInvoice/Forms/Add request.

sessionId

string

The unique value optionally provided by API caller and added to payment

invoices

array of objects

required

Field containing collection one or more invoices to be displayed on the Invoice Payment pages.

invoices*

cardholderName

string

Optional Field indicating the Name of the Card Account Holder on the Invoice Payment page; (100 Chars Max).

billingAddress

string

Optional Field indicating the Address Line 1 on the Invoice Payment page; (100 Chars Max).

billingCity

string

Optional Field indicating the City for the Invoice Payment page; (100 Chars Max).

billingCountry

string

Optional Field indicating the Country on the Invoice Payment page; (100 Chars Max).

duration

int32

Optional Field indicating the duration in seconds of payment page before expiring. Defaults at 15 mins. Max duration is 1 year.

billingZipCode

string

prepopulate the billing Zip on the payment form (Can be edited on the form by cardholder).

billingStateCode

string

Prepopulate the billing State on the payment form. Must be valid 2 letter code for US States and Canadian Provinces/Territories (Can be edited on the form by cardholder).

enableClientSidePostBack

boolean

Enables Windows Post message to parent window with payment information upon completion of payment.

clientSideReturnAddress

string

A security measure for the client side postback. Will check to make sure the URL of the parent window matches the URL provided. If none provided, won't check. If not a match, won't send postback.

hideCustomerHeaderLogo

boolean

Flag if set will hide customer's logo shown on top of the invoice payment page

bccEmail

string

Upon completion of payment, any email addresses provided in this field (separate multiple with a comma) will receive a copy of the receipt email.

customFooterText

string

This text will appear at the bottom of the payment page above the "Submit" button.

Response

200200