Welcome to the comprehensive guide for the Paycrest Sender API. This documentation serves as a detailed reference for developers integrating Paycrest’s Sender API services into their applications. Whether you're looking to initiate orders, fetch order details, manage webhooks, or handle user authentication, this documentation covers all the necessary aspects to get started and ensure a smooth integration process.
If you encounter issues, find bugs, or have suggestions for improvements, just send an email to [email protected].
Thank you for choosing Paycrest as your off-ramp partner. We're excited to see the innovative solutions you build with our API and look forward to supporting your success.
Visit your sender dashboard to retrieve your Client ID and Client Secret.
If you're a new user, signup here as a "sender" and complete our Know-Your-Business (KYB) process.
Your Client Secret should always be kept secret. If you accidentally expose it via version control or other means, you should immediately reach out to [email protected] to generate a new API key.
Head over to the settings page of your Sender Dashboard to configure the feePercent, feeAddress, and refundAddress across the tokens and blockchain networks you intend to use.
Include your Client ID in the "API-Key" header of every request you make to Paycrest Offramp API.
e.g
const headers = {
"API-Key": "208a4aef-1320-4222-82b4-e3bca8781b4b",
}
Any request without a valid API key will fail with status code 401: Unauthorized. All API calls must be made over HTTPS.
Body of requests and responses are formatted as JSON with Content-Type always as application/json
Endpoint: /v1/sender/orders
Method: POST