Download OpenAPI specification:Download
Payments: create hosted checkout (POST /checkout/create/), get payment by id (GET /transactions/{id}/).
Charge currencies: USD and EUR only.
Merchant (dashboard session): organization profile, API keys, webhooks, and payment links
(payment links are not available with API keys—use Authorization: Token from the merchant web app).
Subscriptions: lifecycle (create, update, cancel, charges) is managed in the merchant dashboard; subscription REST endpoints for API keys are not part of this reference until published.
Webhooks: configure under Organization in the dashboard; events such as transaction.status_changed are documented in the product guides.
Create a payment session (hosted checkout). Returns checkout_url and token. Redirect the customer to checkout_url to complete payment. Requires API key with checkout:create scope.
| billing_country required | string <= 2 characters |
| billing_postal_code | string |
| billing_first_name required | string <= 100 characters |
| billing_last_name required | string <= 100 characters |
| billing_email required | string <email> |
| billing_phone | string |
| currency required | string Enum: "USD" "EUR" |
required | Array of objects or objects (ProductItem) |
| successUrl | string <uri> |
| failedUrl | string <uri> |
| cancelUrl | string <uri> |
{- "billing_country": "US",
- "billing_postal_code": "string",
- "billing_first_name": "string",
- "billing_last_name": "string",
- "billing_email": "user@example.com",
- "billing_phone": "string",
- "currency": "USD",
- "products": [
- {
- "id": "string",
- "quantity": 1
}
],
}{- "token": "string",
- "expires_at": 0
}Retrieve a payment by its public ID (e.g. TXabc123) or numeric ID. Returns amount, status, currency, products, and timestamps. Requires API key.
| id required | string Payment ID — use public ID (e.g. TXabc123) or numeric transaction ID |
{- "id": "string",
- "amount": "99.00",
- "status": "string",
- "currency": "USD",
- "payer_email": "user@example.com",
- "products": [
- {
- "id": "string",
- "name": "string"
}
], - "created_at": "2019-08-24T14:15:22Z"
}Partial update of editable organization fields (e.g. name, website, contact_email, telegram, price_mode).
| property name* additional property | any |
{ }Create a shareable link with a product snapshot. Currency must be USD or EUR. Requires catalog product ids from your organization.
| name required | string Internal label for the merchant dashboard |
required | Array of objects (PaymentLinkLine) |
| currency | string Default: "USD" Enum: "USD" "EUR" |
| pricing_mode | string Enum: "TAX_EXCLUSIVE" "TAX_INCLUSIVE" |
| expires_at | string or null <date-time> |
| max_uses | integer or null >= 1 |
object or null |
{- "name": "string",
- "products": [
- {
- "product_id": "string",
- "quantity": 1
}
], - "currency": "USD",
- "pricing_mode": "TAX_EXCLUSIVE",
- "expires_at": "2019-08-24T14:15:22Z",
- "max_uses": 1,
- "metadata": { }
}Creates a hosted checkout session from the link snapshot. USD or EUR. No merchant API key required.
| token required | string <uuid> |
| billing_country required | string <= 2 characters |
| billing_postal_code | string |
| billing_first_name required | string |
| billing_last_name required | string |
| billing_email required | string <email> |
| billing_phone | string |
| currency | string Enum: "USD" "EUR" |
| successUrl | string <uri> |
| failedUrl | string <uri> |
| cancelUrl | string <uri> |
{- "billing_country": "st",
- "billing_postal_code": "string",
- "billing_first_name": "string",
- "billing_last_name": "string",
- "billing_email": "user@example.com",
- "billing_phone": "string",
- "currency": "USD",
}