Inkress DevelopersPayment links · Create a link
API reference / Payment links
Create a link
POST/api/v1/payment_linkspayment_links:write
A link the customer pays on Inkress's page at https://inkress.com/p/<uid>. Paying it creates an order and sends orders.paid.
Body
titlestringrequired
Shown on the payment page.
currency_codestringrequired
JMD or USD. Can't change later.
totalnumber
The amount, below 2,000,000. Can't change later.
descriptionstring
More detail on the payment page.
usage_limitinteger
How many payments the link is for. Kept with the link for your records.
expires_atstring
When it closes, ISO 8601. After that it can't be paid.
dataobject
Your own data. Put your reference in data.reference_id. data.available_from (ISO 8601 with an offset) keeps the link closed until then.
Headers
Authorizationheaderrequired
Bearer with your secret key, or the merchant's OAuth token.
Returns
The link, with its uid. status 1 means open.
Errors
401 | The key or token is missing, wrong or revoked, is for the other environment, or doesn't have the scope this endpoint needs. |
422 | title or the currency is missing, the total is out of range, or data.available_from has no offset. |