API Introduction

The Peerwallet API is designed to serve Buyers, Sellers, and Vendors, enabling seamless integration and automation on the platform. It is structured into well-defined segments, allowing you to quickly locate and implement the necessary features. Before getting started, there are a few key steps and considerations:

1. API SETUP

Ensure you have configured your API privileges here. From your API settings, you can generate your API keys and passphrase. These credentials serve as the gateway to your account, so keep them secure.

2. PASSPHRASE

Your passphrase is a unique encryption key tied to your account. It is crucial for securing sensitive information. When we send a webhook, the passphrase is included in the header to verify that the request is coming from Peerwallet.

3. CALLS & RESPONSES

Every API response includes a "note" field, providing detailed explanations of any errors or issues, making debugging straightforward.

4. API LIMITS & SECURITY

To protect your account, Peerwallet monitors unusual API activity. If we detect excessive or suspicious requests, your API access may be temporarily blocked for a few minutes before resuming. You can check your API limit status from your dashboard.

5. REQUEST ADDITIONS

Need a custom API response format or a specific integration feature? We’re happy to review your requests and provide solutions that align with your needs. Let us know how we can improve your integration experience.

6. CALLBACK & WEBHOOK

When creating a payment link, you can specify your webhook URL (post_url). After every successful payment, Peerwallet sends POST data to this URL. You can also verify the payment status by making an additional API call to a designated endpoint. Webhook notifications are only sent after a payment is successfully completed.

For further assistance, feel free to reach out. We’re here to help! 🚀