API reference

Quickstart#

From a new product to a working Sandbox request. Two steps happen in your dashboard, one on your server.

1. Dashboard · ServicesEnable a service

   Add it to your product and fill in its configuration.

2. Dashboard · API keysCreate an API key

   Scope it to the services you need. You'll see it once.

3. Your serverSend your first request

   This section's request, with your key. It uses Sandbox test values, so it passes validation.

Authentication#

Create a key on your product's API Keys page and send it in the X-Api-Key header with every request.

Belongs to

One product, and one environment

Can call

Only the services you scope it to

Shown

Once, when you create it

Expires

After 1 to 365 days, or never

Revoke

Any time, from the product's API Keys page

Keep keys on your server. Never put them in browser code, mobile apps, source control or logs.

Environments#

Every API key belongs to one environment. Don't send Live traffic with a Sandbox key, or test with a Live one.

Initiate a transaction#

Starts any operation. The service handle picks it; the payload carries its fields.

Headers

Body

Responses#

Every service answers with the same envelope. What's specific to the operation is in data.

Errors#

The HTTP status tells you whether the request got through; code and message tell you what happened to the operation.

• DoUse a unique reference for every operation.
• DoRetry only transient failures, with exponential backoff.
• Don'tRetry validation or authentication errors automatically.
• Don'tLog API keys or sensitive customer data.

Services#

Set service to one of these handles and send its fields in payload. Each sample uses Sandbox test values.