Authentication

Authentication

In order to begin using ClientPay API, you need an integratorKey, accountKey, and accountPin. You can obtain these by contacting our team at [email protected].

You will use those 3 pieces of data to acquire an accessId. Access IDs do not expire and are required in order to make any ClientPay API call.

Some API calls require a requestId, which is a unique identifier for each request, in addition to an accessId. You will need to get a new request ID for each call in order to ensure you're not making duplicate request.

Here’s a walkthrough of how to Authenticate via ClientPay.

1. Under the Token header in the Reference, use “POST New Access ID” to generate an accessId with your integratorKey, accountKey, and accountPin.
   a. “POST New Access ID” will also expire your current accessId and issue a new one.
   b. “POST Current Access ID” will return your current accessId if you forget it
   c. “POST Validate Access ID” will return if your accessId is expired, or not.
   d. “POST Expire Access ID” will expire your accessId
2. Under Tokens, “POST Generate Request ID” will return a requestId. Each Payment and Invoice request requires a unique requestId.

In order to test the Invoice or Payment API call, here are some test cards to use:

https://wiki.usaepay.com/developer/testcards