Accept a payment

Create an order on your server, send the customer to Inkress's payment page, and confirm with a webhook. Card details never touch your server.

1Create an order

Call POST /api/v1/orders with your own reference_id, the kind (online for a web checkout), the total in the currency's major unit (2500 is J$2,500.00), the currency_code and the customer's email and name. The smallest order is J$150.00 or US$1.00.

reference_id must be unique for the merchant; a repeat gets 422 Reference ID already exists. Apps can also send an Idempotency-Key so a retried request returns the first order.

Send products (each an id and quantity) to sell catalogue items, or a total and title for a single amount. Send discount_code and Inkress checks it and prices the order itself.

2Send the customer to pay

The order comes back with payment_urls: redirect to payment_url, or share the short_link or the QR code at qr_url. Set meta_data.return_url and the customer lands back on your site after paying.

3Confirm with a webhook

Listen for orders.paid and mark the order paid in your system. You can also fetch the order with GET /api/v1/orders/:id; status 3 is paid.