Getting Started
Get up and running with the Paytrie API
This guide will walk you through the steps to start integrating with the Paytrie API.
Integration Options
Paytrie offers two primary integration methods:
Embedded Widget
Embed the Paytrie widget directly in your application using an iframe. Perfect for quick integrations with minimal backend code. Pre-fill user data via URL parameters.
API Integration
Build a custom integration using our REST API. Provides full control over the user experience and allows for deep integration with your existing systems.
Which option should I choose?
-
Choose the Embedded Widget if you want to:
- Get up and running quickly with minimal development time
- Offload KYC compliance and user management to Paytrie
- Avoid building and maintaining payment UI
- Pre-fill user information from your application
-
Choose API Integration if you need:
- Full control over the user interface and experience
- Custom workflows and business logic
- Direct integration with your backend systems
- Advanced features like programmatic transaction management
Both integration methods can be combined. Many partners start with the embedded widget for quick time-to-market, then gradually migrate to API integration as their needs grow.
Prerequisites
Before you begin, you'll need:
- A Paytrie account
- An API key (or vendor ID for embedded widget)
Step 1: Create a Paytrie account
Register for a Paytrie account at app.paytrie.com/SignupEmail.
Step 2: Request API access
Contact support@paytrie.com to request a developer API key. Include:
- Your registered email address
- A brief description of your integration use case
- Expected transaction volume
Step 3: Authenticate your requests
All API requests require authentication via the x-api-key header:
curl -X GET "https://api.paytrie.com/endpoint" \
-H "x-api-key: your-api-key-here"Step 4: Start building
Once you have your API key, you're ready to integrate.
For Embedded Widget Integration
If you chose the embedded widget approach, head over to the Embedded Widget Overview to learn how to embed the widget in your application, or jump directly to the URL Builder to start generating custom widget URLs.
For API Integration
Here's a typical API integration flow:
Register users
Use the Customer Onboarding endpoint to register users and collect KYC information.
Authenticate users
Implement the Authentication flow to get user tokens for transaction requests.
Get price quotes
Fetch real-time Price Quotes to display conversion rates to users.
Create transactions
Submit Transactions to process stablecoin purchases.
Handle webhooks
Set up Webhooks to receive notifications about user verification and transaction status changes.
Base URL
All API requests should be made to:
https://api.paytrie.com