API reference

The merchant-facing REST API creates and retrieves Payment Intents. Call it from your server, not directly from the browser.

Base URL

https://api.lynq.am/api

All request and response bodies use JSON over HTTPS.

Authentication

Send a secret API key as a bearer token:

Authorization: Bearer sk_test_...

The key determines the merchant and environment. A test key accesses only test Payment Intents; a live key accesses only live Payment Intents.

Secret keys belong on your server. Do not call these endpoints from browser code or expose a secret key in client-side configuration.

Create a Payment Intent

POST /payment-intents Creates a Payment Intent in the environment selected by the secret key.

Headers

string

required

Bearer followed by your secret API key.

string

required

Use application/json.

string

Stable unique key for safely retrying the same create request. Recommended for every request.

Request body

number

required

Positive integer in minor currency units. For AMD 27,150.00, send 2715000.

string

required

Supported ISO 4217 code: AMD, USD, EUR, or RUB. Input is normalized to uppercase.

string

required

Merchant order identifier. Maximum 32 characters.

object

Optional customer details. id is required when the object is present; email and name are optional.

object

Optional string-to-string values for merchant reconciliation.

Example request

curl --request POST "https://api.lynq.am/api/payment-intents" \
  --header "Authorization: Bearer sk_test_..." \
  --header "Content-Type: application/json" \
  --header "Idempotency-Key: order:order_123:attempt:1" \
  --data '{
    "amount": 2500000,
    "currency": "AMD",
    "orderId": "order_123",
    "customer": {
      "id": "customer_123",
      "email": "buyer@example.com",
      "name": "Aram Petrosyan"
    },
    "metadata": {
      "cartId": "cart_456"
    }
  }'

Response fields

string

required

Lynq Payment Intent identifier.

number

required

Amount in minor currency units.

string

required

Normalized supported currency code.

string

required

Current Payment Intent status.

string

required

Merchant order identifier from the request.

string

Raw checkout credential. It is returned when the Payment Intent is created and should be passed only to the paying browser session.

object

Customer data supplied at creation, or null.

object

Non-sensitive summary of the selected payment method, or null before selection.

object

Latest display-safe payment failure, or null.

object

Authentication or redirect state used by hosted Checkout, or null. Do not drive this flow from merchant code.

string

Provider payment identifier when available, or null.

object

Merchant metadata, or null.

string

required

Creation timestamp.

string

required

Latest update timestamp.

Retrieve a Payment Intent

GET /payment-intents/:id Retrieves a Payment Intent owned by the authenticated merchant in the secret key’s environment.

string

required

Payment Intent identifier returned at creation.

curl --request GET "https://api.lynq.am/api/payment-intents/pi_..." \
  --header "Authorization: Bearer sk_test_..."

The response uses the same Payment Intent fields. The original raw client secret is not returned by retrieval.

Payment Intent statuses

Status	Meaning
`requires_payment_method`	Awaiting payment details.
`requires_action`	Authentication or a redirect is in progress inside Checkout.
`processing`	Processor completion is pending.
`succeeded`	Payment completed successfully.
`canceled`	Payment was canceled.

See Payment Intents for request fields and idempotency.

Checkout-owned endpoints

Hosted Checkout uses publishable-key endpoints to read its configuration and confirm the payment. Those endpoints collect payment-method details and manage authentication, so they are intentionally not merchant integration surfaces. Use the Checkout SDK instead of calling them directly.

Start here

Payment methods

Build your integration

Test and go live

Reference

Resources

Base URL

Authentication

Create a Payment Intent

Headers

Request body

Example request

Response fields

Retrieve a Payment Intent

Payment Intent statuses

Checkout-owned endpoints

​Base URL

​Authentication

​Create a Payment Intent

​Headers

​Request body

​Example request

​Response fields

​Retrieve a Payment Intent

​Payment Intent statuses

​Checkout-owned endpoints

Base URL

Authentication

Create a Payment Intent

Headers

Request body

Example request

Response fields

Retrieve a Payment Intent

Payment Intent statuses

Checkout-owned endpoints