Quickstart
This page will help you get started with the ClientPay API. The ClientPay API is designed for software engineers, developers, or anyone ready to create custom solutions with RESTful APIs. You'll be up and running in a jiffy!
Becoming an Integrator
Want to become an integrator? Contact us at [email protected]. We are excited to get you up and running.
Authentication
Visit the Authentication section.
Base URL
All URLs referenced in this documentation will have the following base:
HTTP Methods
The ClientPay API supports 2 types of HTTP methods:
GET
GET requests retrieve data. GET requests do not modify or create since they are safe.
POST
Create new resources with a POST request. For instance, make a POST request to populate an invoice payment page with transaction data.
SSL
All API methods have a valid certificate. Make sure your connection library supports HTTPS.
PCI Compliance
Anyone involved with the processing, transmission, or storage of credit card data must comply with the Payment Card Industry Data Security Standards (PCI DSS). ClientPay is Level 1 PCI Compliant.
Make sure to serve your payment pages using Transport Layer Security (TLS) so that they take advantage of HTTPS.
Sandbox Environment
If you'd like to test our API calls in a Sandbox environment, become an integrator and we'll set you up!
Rate Review Process
We are a traditional merchant account provider, so we guide new customers through a rate review process in order to set them up with a merchant account to process payments.
Service Agreement
We enjoy connecting with our customers so we do not publish our terms/agreements. Instead, we engage them with a tailored contract to suit their needs.
Updated over 7 years ago