Payment

The Payment call allows you to send ClientPay data to directly process a payment.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The accessId credential used to authenticate the requester

string
required

Unique identifier for the request

string

Provided by you in initial POST api payment request.

string

The value provided by you in your initial POST api payment request call.

string

Optional encrypted value containing the Card numer, cardholder name etc

int32

Optional field indicating the Card numer, cardholder name etc

string
required

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

string
required

Credit Card number

int32
required

Month of expiration date

int32
required

Year of expiration date (4 digits)

string

Card code

string

Optional description field

string

Email for receipt

double
required

Required Field in request for Total amount of each payment request.

double

Optional Field in request for tax amount of payment.

string

Optional Field in request indicating the Order number from customer to attach to each payment; (64 Chars Max).

string
required

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

string

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

string

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

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).

string
required

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

string

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

Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json