Skip to main content
POST
Create an order and start payment

Autorisations

Authorization
string
header
requis

API token (olab_…) created in Settings → API tokens or with orbitlab login.

En-têtes

X-OrbitLab-Org
string

Organization to act on (id or slug) for tokens that can access several organizations. Defaults to your first organization.

Corps

application/json
items
object[]
requis
paymentMethod
enum<string>

Defaults to mobile_money, the only method that can collect payment. Card payments are unavailable: credit_card is accepted for free orders only.

Options disponibles:
mobile_money,
credit_card
mobileMoneyNetwork
string

Provider code, e.g. VODACOM_MPESA_COD (Mobile Money).

mobileMoneyPhone
string

Phone number (Mobile Money).

paymentCurrency
enum<string>

Charge in USD or the local currency. Defaults to local.

Options disponibles:
USD,
local
enableAutopay
boolean

Save the Mobile Money number for automatic renewals.

appliedPromoCodeId
string<uuid>

Promo code id from the validate endpoint.

billing
object
idempotencyKey
string

Alternative to the Idempotency-Key header.

lang
enum<string>

Language of the payment page.

Options disponibles:
fr,
en

Réponse

orderId, paymentMethod, provider and, for card payments, payment_url.

The response is of type object.