Skip to main content

​
Environments

Sandbox and live credentials are separate. Build and test against the sandbox; move to live only once your integration is signed off.
Anything sent to the live environment incurs real fees and charges.

​
Authentication

Every API request uses HTTP Basic Authentication over HTTPS, with the API username and password PayChoice issues to you.
Your credentials are delivered through a one-time secure link: you receive an email with the link, it prompts for a one-time code, and it expires once the credentials have been viewed.
Keep credentials out of source control and client-side code. The PayChoice Widget and the Create Token page exist so that card and bank details never need to touch your servers.

​
Merchant and agency credentials

Most integrators have a merchant credential, scoped to one merchant account. Partners who manage several merchants have an agency credential, which can act on any of its merchants by passing merchant_guid on the request. A few endpoints, noted where they appear, are agency-only.

​
API versions

Both versions return JSON and accept the same fields. Use v5 for a new integration. Timestamps are ISO 8601 in UTC. Amounts are decimal strings in the merchant’s currency, for example "10.00".
The recurring billing endpoints under Billing use a different response envelope from the payment endpoints, and need an Accept: application/json header. Each section’s overview describes its own format.

​
Next

Make your first charge.