Integrations¶
Zapier Integration¶
SecPaid integrates seamlessly with various platforms and services, enhancing your ability to manage payments and automate workflows. This section provides an overview of our integration capabilities, focusing on our Zapier integration.
The integration uses OAuth2 with the Authorization Code grant flow for authentication:
- When a user sets up a Zap, they are redirected to SecPaid's
/authorize
endpoint to grant Zapier access to their account - Upon approval, SecPaid redirects back to Zapier's redirect URI with an authorization code
- Zapier exchanges the authorization code for an access token by making a POST request to SecPaid's
/token
endpoint - The access token is then used to make authenticated requests to the SecPaid API on behalf of the user
- Zapier securely stores the access token and handles refreshing it when needed.
- This allows the integration to maintain a secure connection to the user's SecPaid account.
API Requests¶
The SecPaid Zapier integration defines two key actions:
-
create_LinktoPay
- Creates a new payment link- Accepts
recipient_note
andamount
as input fields - Makes a POST request to
https://app.secpaid.com/api/v1/createLink
with the input data - Returns the created payment link details including the URL and QR code
- Accepts
-
getpayin
- Retrieves a list of received payments- Accepts
search
,page
,limit
as optional input fields to filter results - Makes a POST request to
https://app.secpaid.com/api/v1/getPayInTransactions
with the input parameters - Returns an array of matching payment transactions
- Accepts
For each API request, Zapier includes the access token in the Authorization
header to authenticate the request. The requests are made securely over HTTPS to ensure data privacy.
API Overview¶
API Overview¶
- V1 API
- Tailored for Low Code Automation Platforms like Zapier.
- It uses OAuth2 Authentication via Keycloak.
- For information on how to extract this Token, please contact us.
API Management¶
Rate Limiting¶
To ensure fair usage and maintain system stability, we implement rate limiting on our API. The limits are set individually on API-Keys. If you exceed these limits, you'll receive a 429 Too Many Requests
response.
Error Handling¶
- The Zapier App uses standard HTTP status codes to indicate the success or failure of a request.
- In addition to status codes, we provide detailed error messages in the response body to help you troubleshoot issues.
- Zapier provides customers with a Monitoring and Logging Overview on their Zaps. Meaning you can make use of those aswell
Getting Started¶
Ready to supercharge your payment processes with automation? Here's how to set up the SecPaid Zapier integration:
- Log in to your Zapier account or create a new account
- Navigate to "My Apps" and click on "Add Connection"
- Search for "SecPaid" and click on the SecPaid app
- Follow the authorization steps to connect your SecPaid account
- Start creating Zaps using SecPaid triggers and actions!
Our Developer Team is here to assist you with the integration process. Reach out anytime for support, feedback, or to request new features.