Documentation
Search…
API Overview
  1. 1.
    Call Create Order API method to create an order with the Paychant API.
  2. 2.
    Paychant checks if the order is valid. 2a. If the order is valid, Paychant responds with 200 HTTP status and returns order data. After receiving 200 HTTP status, you should redirect the shopper to payment_url address. 2b. If the order is not valid, Paychant returns 422 (UnprocessableEntity) or other HTTP status and an error message.
  3. 3.
    When the shopper pays for the order, Paychant sends Payment Callback (Payment Notification) to your callback_url, which is defined when creating the order. Paychant also sends Payment Callback when order status is changed to canceled, expired, or to any other status. Please note that payment notifications are sent using POST method.

Environments

Live
Sandbox
https://api-live.paychant.com/v1
https://api-sandbox.paychant.com/v1

Limits and Quotas

  • 100 requests per 30 minutes base on IP address (Public API endpoints) Applies to API methods that do not require authentication, such as Get Exchange Rate and List Exchange Rates.
  • 200 requests per 30 minutes (Private API endpoints) Applies to API methods that use authentication, such as Get Order, List Orders, and Create Order. Reaching the limit will prevent further orders to be created/listed before the 30 minutes timer resets.

API Requests

To review your API Requests (examples: Create Order, Get Order, List Order), login to your Paychant dashboard account, then go to Settings » API Access.

Payment Callbacks (Payment Notifications)

Payment Callback (Payment Notification) is a response that is sent after the order status changes. Paychant sends the Payment Callback to the merchant's callback_url, which is set during the order creation.
Copy link
On this page
Environments
Limits and Quotas
API Requests
Payment Callbacks (Payment Notifications)