Inkress DevelopersOrders · Create an order
Create an order
Creates an order for the merchant and returns the links the customer pays with. The order stays pending until the payment completes; listen for orders.paid.
Body
Your own ID for the order, unique for the merchant. You'll see it on the merchant's dashboard and in webhooks.
What the customer pays for the items, in the currency's major unit: 2500 is J$2,500.00. At least J$150.00 or US$1.00.
What sort of order this is.
onlinecartsubscriptioninvoiceofflineWho is paying. Matched to an existing customer by email.
Receipts go here.
First name.
Last name.
With country code.
JMD or USD.
Shown on the payment page and receipt.
Line items, each with a product id and quantity. Leave out for a single amount.
Inkress checks the code and re-prices the order itself. A discount amount you send is never trusted.
Delivery or shipping charged on top of total.
Extra settings for this order.
Where the customer goes after paying.
Order details such as a shipping address. Keys Inkress doesn't accept return 422.
Headers
Bearer with your secret key, or the merchant's OAuth token.
For apps. The same key and body within 24 hours return the first response instead of a second order. Idempotent requests.
Returns
The order, with payment_urls.payment_url for a redirect, short_link to share, qr_url for a QR code, and invoice_url.
| status | Meaning |
|---|---|
1 | pending: waiting for the customer to pay. |
2 | error: the payment failed. |
3 | paid: orders.paid has been sent. |
Errors
401 | Missing or wrong key, or the token doesn't have orders:write. |
422 | A required field is missing, the reference_id was used before (Reference ID already exists.), the total is under the minimum, the business isn't verified, or a transaction limit is reached. result.reason says which. |