Chapter 4 — DocumentationFig. 3

Connect, verify, collect.

A REST API, four SDKs (JavaScript, Python, PHP, Ruby) and webhooks. The sample below creates one payment request, which the software passes to the payment partner; the rest of the documentation is organised in the six sections listed after it.

4.1Quick start

Quick start

One payment in twelve lines.

import Oltaris from "@oltaris/sdk";

const oltaris = new Oltaris("sk_test_7Hq2…");

const payment = await oltaris.payments.create({
  amount: 4900,                 // minor units
  currency: "EUR",
  method: "card",
  customer: { email: "buyer@example.com" },
  metadata: { order: "A-10342" },
});

console.log(payment.status);    // "authorized"

Fig. 3Creating a payment with the JavaScript SDK. Keys are issued on request.

1
Install. Add the SDK for your language, or call the REST API directly over HTTPS.
2
Authenticate. Use a test key first. Test and live environments share the same calls.
3
Create. Send the amount in minor units, the currency and the method. The response carries the status returned by the payment partner.
4
Listen. Subscribe a webhook endpoint to receive authorisation, capture, payout and dispute events as the payment partner reports them.

4.2Contents

Contents

Six sections.

The full documentation is issued with your API keys. Its sections are listed here so you know what to expect before you connect.

Section	Title	Covers
4.2.1	Getting started	Create keys, choose a test environment and send a first transaction.
4.2.2	API reference	Every endpoint, parameter and response code of the REST API.
4.2.3	SDKs	Client libraries for JavaScript, Python, PHP and Ruby, with installation notes.
4.2.4	Guides	Step-by-step procedures for checkout, subscriptions, marketplaces and mobile.
4.2.5	Webhooks	Event types, delivery, signatures and retry behaviour.
4.2.6	Good practice	Idempotency, error handling, currency presentation and reconciliation.

4.3Assistance

Assistance

If something does not behave as documented.

Support is by email, 24 hours a day, 7 days a week, with a reply within 24 hours. Include your request identifier and the response you received; write to contact@oltaris.io. Oltaris supplies the software only and never holds, transmits or settles funds: a question about a specific payout is answered from the payment partner's statement shown in your dashboard.

Go to chapter 5, Contact