API Integration
In this guide you’ll know how to work with OpenPay's APIs. Learn how to get your API Keys, authenticate, and integrate payments into your application.
Quick StartCopied!
Ready to start integrating? Choose your preferred approach for integration:
5-Minute Integration
Perfect for testing and getting started quickly
-
Generate API keys
-
Make your first API call
-
Process a test payment
Full Integration
Complete setup for production applications
-
Choose your SDK
-
Set up webhooks
-
Go live checklist
API KeysCopied!
OpenPay uses API keys to authenticate requests. You'll need both a Secret Key for server-side operations and a Publishable Key for client-side integration.
Sign In to OpenPay
-
Click the Developer Icon on the right of the top navigation bar and select API Keys
-
Click Create API key
-
Name your API key something creative and assign an appropriate role.
-
Hint: If you want to create objects using the API, you'll probably want to select Developer here.
-
-
Once your keys have been created, note down your Secret Key and Publishable Key.
Key Types & UsageCopied!
|
Key Type |
Usage |
Security Level |
|---|---|---|
|
Secret Key |
Server-side API calls, sensitive operations |
Keep Secret - Server only |
|
Publishable Key |
Client-side integration, payment forms |
Public Safe - Can be embedded |
Every endpoint in our API reference lets you make a test API call right from your browser. All you need to do is plug in your secret key and you should be good to go!
Your publishable key can be safely embedded wherever your customers avail your services. For example, you can embed your publishable key somewhere on your website or your app where your customers go to make payments.
Your secret key, as the name suggests, is meant to be kept secret. This key allows you to make changes that the publishable key doesn't grant access to, especially dangerous ones such as deleting customers and refunding payments.
Anyone with access to your secret key can make changes to your account on your behalf, so make sure to keep this key safe and secret! 🤫
Next Steps…Copied!
Here are some of the OpenPay’s SDKs:
Submit a request to our team (support@getopenpay.com) if there's an SDK you would like to see.
API Reference Explore our comprehensive API documentation to learn about all available endpoints, request/response formats, and implementation examples.