Payment Intents

A Payment Intent represents one attempt to collect a specific amount for an order. Create it from your server when the customer starts paying, then pass its client secret to the browser so Checkout can collect the payment. All requests go to https://api.lynq.am/api as JSON over HTTPS, with your secret key as a bearer token. The key selects the merchant and the mode: a test key reaches only test Payment Intents.

Create a Payment Intent

POST /payment-intents

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"
    }
  }'

{
  "id": "pi_...",
  "amount": 2500000,
  "currency": "AMD",
  "status": "requires_payment_method",
  "orderId": "order_123",
  "clientSecret": "pi_..._secret_...",
  "paymentMethod": null,
  "lastPaymentError": null,
  "metadata": {
    "cartId": "cart_456"
  }
}

Request fields

number

required

Positive integer in minor currency units. For AMD 25,000.00, send 2500000. Calculate it on your server from the order; do not trust a total sent by the browser.

string

required

AMD, USD, EUR, or RUB. Each uses two minor-unit digits. Input is normalized to uppercase.

string

required

Your order identifier, used to find the payment during reconciliation. 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 your own systems, such as a cart or invoice identifier. Do not put secrets, card data, or sensitive personal information here.

string

Stable unique key for this create request. Recommended on every request.

Idempotency

A stable key such as order:order_123:attempt:1 makes a retry return the original result instead of creating another Payment Intent. Reuse a key only when retrying the exact same request, for example after a timeout. Use a new key when the amount, currency, order, customer, or metadata changes, or when the customer starts a new attempt.

The client secret

clientSecret is returned once, when the Payment Intent is created. It authorizes Checkout for this one payment:

Return it only to the browser session paying the matching order, over HTTPS.
Do not store it in browser storage, analytics, error reports, logs, or URLs.
If the session is no longer usable, create a new Payment Intent.

Retrieve a Payment Intent

GET /payment-intents/:id

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

Use retrieval for reconciliation or server-side status checks. The response has the same fields without clientSecret, so it cannot rebuild a checkout session.

Response fields

string

required

Lynq Payment Intent identifier. Store it with your order.

number

required

Amount in minor currency units.

string

required

Normalized currency code.

string

required

Current status. See Statuses.

string

required

Order identifier from the request.

string

Checkout credential. Present only in the create response.

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 your code.

string

Provider payment identifier when available, or null.

object

Your metadata, or null.

string

required

Creation timestamp.

string

required

Latest update timestamp.

Statuses

Status	What it means	What your application should do
`requires_payment_method`	Checkout is waiting for usable payment details.	Let the customer enter or replace a method.
`requires_action`	Authentication or a wallet handoff is in progress.	Nothing: Lynq.js handles it.
`processing`	The provider has not produced a final result.	Show pending and wait for the webhook.
`succeeded`	Payment completed.	Fulfil after verifying the success webhook.
`canceled`	The Payment Intent can no longer be completed.	Create a new Payment Intent if the customer tries again.

Use one Payment Intent per checkout attempt, and never reuse one that has succeeded or been canceled.

Hosted Checkout has its own publishable-key endpoints for confirming payments. Do not call them directly; use Lynq.js.

Start here

Payment methods

Build your integration

Test and go live

Reference

Create a Payment Intent

Request fields

Idempotency

The client secret

Retrieve a Payment Intent

Response fields

Statuses

​Create a Payment Intent

​Request fields

​Idempotency

​The client secret

​Retrieve a Payment Intent

​Response fields

​Statuses

Create a Payment Intent

Request fields

Idempotency

The client secret

Retrieve a Payment Intent

Response fields

Statuses