Developers API

Authorization

Every API request must include 2 headers for authorization:

{storeId} and {apiKey} are located on the Store page in your Keterion account.

Creating invoices flow

Step 1. The "Create invoice" endpoint returns the paymentGateway property which should be used to navigate users to when they are ready to pay for your order.

The Payment Gateway URL has a time limit and is valid for only 20 minutes.

We recommend calling the "Create invoice" endpoint every time before navigating your users to the Payment Gateway. E.g. you might want to call it when users click the "Checkout" button on your website, get the Payment Gateway URL in response, and redirect users to it.

Calling the endpoint multiple times with exact same externalOrderId does not create new invoices in our DB, but it extends the payment session for an existing invoice by another 20 minutes.

Step 2. You can use this endpoint to update an existing invoice to change network, coin, amount, and description. Note that changing network, coin and amount leads to a new payment token (Payment Gateway URL). Previous tokens become no longer valid.

Invoices with txStatus 0 or 2 cannot be updated.

Step 3. Use the "Check invoice status" endpoint to see if an invoice is paid or has some other status.

The payment status is reflected in the txStatus property of the response. And it may have following values:

API Endpoints

Create invoice

This endpoint creates an invoice in Keterion for an existing order in your store.

POST https://api.keterion.com/v1/merchants/order

Check invoice status

This endpoint returns invoice information with transaction data.

GET https://api.keterion.com/v1/merchants/order?e={externalOrderId}