Skip to content
Last updated

About Reefpay APIs

What the API provides

The Reefpay API gives you programmatic access to every capability of the platform.

  • Payments: Create sales, authorizations, captures, voids, and refunds for credit cards and bank accounts.
  • Tokenization: Store and manage payment methods securely.
  • Account management: Create and manage clients, integrations (processor connections), and persons.
  • Reporting: Query transactions, list batches, and export settlement data.
  • Security: Retrieve encryption keys, manage passwords, and verify multi-factor authentication challenges.

All endpoints live under a single base URL and use a consistent request/response format.

EnvironmentBase URL
Sandboxhttps://api.dev.paradisegateway.net
Productionhttps://api.paradisegateway.net

How the API is organized

The API is organized around resources. Each resource has a predictable URL pattern and supports standard HTTP methods.

ResourceBase pathOperations
Authentication/v1/auth/keysRetrieve API key and encryption keys
Transactions/v1/transactionsCreate, list, retrieve, update, capture, cancel
Payment tokens/v1/payment_tokensCreate, list, retrieve, update, delete
Clients/v1/clientsCreate, list, retrieve, update, delete
Integrations/v1/integrationsCreate, list, retrieve, update, delete
Users/v1/usersCreate, list, retrieve, update, delete
Batches/v1/batchesList batches, update batch status
MFA/v1/mfaCreate challenges, verify codes
Passwords/v1/users/me/passwordsChange password

Authentication overview

The API uses an API key for authentication. Include the API key in the APIKEY header.

Further reading