Update a payment link

Updates a payment link’s fields, its status, or both. Send only the fields that should change.

Deactivating or reactivating a link (status: ACTIVE ↔ DISABLED) is always permitted. Editing any other field is rejected with 400 once the link has been used — that is, it has a successful payment or a payment currently in flight — so terms cannot change under a customer mid-checkout.

mode, merchant_reference_id and max_uses cannot be changed after creation.

PATCH

https://api.lite.sa/api/v1

payment-links

{link_id}

Update a payment link

curl --request PATCH \
  --url https://api.lite.sa/api/v1/payment-links/{link_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "status": "DISABLED",
  "redirect_urls": {
    "success": "https://merchant.example.com/success",
    "failure": "https://merchant.example.com/failure"
  },
  "three_ds_required": true,
  "description": "Invoice",
  "customer": {
    "id": "cus_8f1e2a4b",
    "first_name": "Sara",
    "last_name": "Al-Harbi",
    "email": "sara@example.com",
    "phone_country_code": "+966",
    "phone_number": "512345678",
    "billing_address": {
      "line1": "123 High St.",
      "line2": "Apartment 5B",
      "city": "Riyadh",
      "state": "Riyadh Province",
      "postal_code": "11564",
      "country": "SA"
    }
  },
  "metadata": {
    "invoice_id": "INV-4471",
    "sales_rep": "rep_88"
  },
  "channel_id": "3d1f9c60-5a72-4e18-b0c4-9a6d2f5e7b13",
  "expires_at": "2026-12-31T23:59:59Z",
  "amount": 12500,
  "currency": "SAR"
}
'

import requests

url = "https://api.lite.sa/api/v1/payment-links/{link_id}"

payload = {
    "status": "DISABLED",
    "redirect_urls": {
        "success": "https://merchant.example.com/success",
        "failure": "https://merchant.example.com/failure"
    },
    "three_ds_required": True,
    "description": "Invoice",
    "customer": {
        "id": "cus_8f1e2a4b",
        "first_name": "Sara",
        "last_name": "Al-Harbi",
        "email": "sara@example.com",
        "phone_country_code": "+966",
        "phone_number": "512345678",
        "billing_address": {
            "line1": "123 High St.",
            "line2": "Apartment 5B",
            "city": "Riyadh",
            "state": "Riyadh Province",
            "postal_code": "11564",
            "country": "SA"
        }
    },
    "metadata": {
        "invoice_id": "INV-4471",
        "sales_rep": "rep_88"
    },
    "channel_id": "3d1f9c60-5a72-4e18-b0c4-9a6d2f5e7b13",
    "expires_at": "2026-12-31T23:59:59Z",
    "amount": 12500,
    "currency": "SAR"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    status: 'DISABLED',
    redirect_urls: {
      success: 'https://merchant.example.com/success',
      failure: 'https://merchant.example.com/failure'
    },
    three_ds_required: true,
    description: 'Invoice',
    customer: {
      id: 'cus_8f1e2a4b',
      first_name: 'Sara',
      last_name: 'Al-Harbi',
      email: 'sara@example.com',
      phone_country_code: '+966',
      phone_number: '512345678',
      billing_address: {
        line1: '123 High St.',
        line2: 'Apartment 5B',
        city: 'Riyadh',
        state: 'Riyadh Province',
        postal_code: '11564',
        country: 'SA'
      }
    },
    metadata: {invoice_id: 'INV-4471', sales_rep: 'rep_88'},
    channel_id: '3d1f9c60-5a72-4e18-b0c4-9a6d2f5e7b13',
    expires_at: '2026-12-31T23:59:59Z',
    amount: 12500,
    currency: 'SAR'
  })
};

fetch('https://api.lite.sa/api/v1/payment-links/{link_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    status: 'DISABLED',
    redirect_urls: {
      success: 'https://merchant.example.com/success',
      failure: 'https://merchant.example.com/failure'
    },
    three_ds_required: true,
    description: 'Invoice',
    customer: {
      id: 'cus_8f1e2a4b',
      first_name: 'Sara',
      last_name: 'Al-Harbi',
      email: 'sara@example.com',
      phone_country_code: '+966',
      phone_number: '512345678',
      billing_address: {
        line1: '123 High St.',
        line2: 'Apartment 5B',
        city: 'Riyadh',
        state: 'Riyadh Province',
        postal_code: '11564',
        country: 'SA'
      }
    },
    metadata: {invoice_id: 'INV-4471', sales_rep: 'rep_88'},
    channel_id: '3d1f9c60-5a72-4e18-b0c4-9a6d2f5e7b13',
    expires_at: '2026-12-31T23:59:59Z',
    amount: 12500,
    currency: 'SAR'
  })
};

fetch('https://api.lite.sa/api/v1/payment-links/{link_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.lite.sa/api/v1/payment-links/{link_id}"

	payload := strings.NewReader("{\n  \"status\": \"DISABLED\",\n  \"redirect_urls\": {\n    \"success\": \"https://merchant.example.com/success\",\n    \"failure\": \"https://merchant.example.com/failure\"\n  },\n  \"three_ds_required\": true,\n  \"description\": \"Invoice\",\n  \"customer\": {\n    \"id\": \"cus_8f1e2a4b\",\n    \"first_name\": \"Sara\",\n    \"last_name\": \"Al-Harbi\",\n    \"email\": \"sara@example.com\",\n    \"phone_country_code\": \"+966\",\n    \"phone_number\": \"512345678\",\n    \"billing_address\": {\n      \"line1\": \"123 High St.\",\n      \"line2\": \"Apartment 5B\",\n      \"city\": \"Riyadh\",\n      \"state\": \"Riyadh Province\",\n      \"postal_code\": \"11564\",\n      \"country\": \"SA\"\n    }\n  },\n  \"metadata\": {\n    \"invoice_id\": \"INV-4471\",\n    \"sales_rep\": \"rep_88\"\n  },\n  \"channel_id\": \"3d1f9c60-5a72-4e18-b0c4-9a6d2f5e7b13\",\n  \"expires_at\": \"2026-12-31T23:59:59Z\",\n  \"amount\": 12500,\n  \"currency\": \"SAR\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.lite.sa/api/v1/payment-links/{link_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'status' => 'DISABLED',
    'redirect_urls' => [
        'success' => 'https://merchant.example.com/success',
        'failure' => 'https://merchant.example.com/failure'
    ],
    'three_ds_required' => true,
    'description' => 'Invoice',
    'customer' => [
        'id' => 'cus_8f1e2a4b',
        'first_name' => 'Sara',
        'last_name' => 'Al-Harbi',
        'email' => 'sara@example.com',
        'phone_country_code' => '+966',
        'phone_number' => '512345678',
        'billing_address' => [
                'line1' => '123 High St.',
                'line2' => 'Apartment 5B',
                'city' => 'Riyadh',
                'state' => 'Riyadh Province',
                'postal_code' => '11564',
                'country' => 'SA'
        ]
    ],
    'metadata' => [
        'invoice_id' => 'INV-4471',
        'sales_rep' => 'rep_88'
    ],
    'channel_id' => '3d1f9c60-5a72-4e18-b0c4-9a6d2f5e7b13',
    'expires_at' => '2026-12-31T23:59:59Z',
    'amount' => 12500,
    'currency' => 'SAR'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "publicToken": "plive_7c9f2a1b8e4d6035",
  "hostedUrl": "https://pay.lite.sa/pay/plive_7c9f2a1b8e4d6035",
  "merchantId": "7f3c8b21-0d4e-4a92-9f65-2b8e1c7a4d30",
  "mode": "SINGLE_USE",
  "status": "ACTIVE",
  "amount": 10000,
  "currency": "SAR",
  "usedCount": 2,
  "paidCount": 2,
  "failedCount": 1,
  "createdAt": "2026-06-01T10:30:00.000Z",
  "updatedAt": "2026-06-04T09:12:44.000Z",
  "merchantReferenceId": "order-2026-0042",
  "redirectUrls": {
    "success": "https://merchant.example.com/success",
    "failure": "https://merchant.example.com/failure"
  },
  "threeDsRequired": true,
  "description": "Invoice",
  "customer": {
    "id": "cus_8f1e2a4b",
    "firstName": "Sara",
    "lastName": "Al-Harbi",
    "email": "sara@example.com",
    "phoneCountryCode": "+966",
    "phoneNumber": "512345678",
    "billingAddress": {
      "line1": "123 High St.",
      "line2": "Apartment 5B",
      "city": "Riyadh",
      "state": "Riyadh Province",
      "postalCode": "11564",
      "country": "SA"
    }
  },
  "metadata": {
    "invoice_id": "INV-4471",
    "sales_rep": "rep_88"
  },
  "channelId": "3d1f9c60-5a72-4e18-b0c4-9a6d2f5e7b13",
  "expiresAt": "2026-12-31T23:59:59.000Z",
  "maxUses": 1,
  "lastPaidAt": "2026-06-04T09:12:44.000Z"
}

{
  "error": {
    "code": "PAYMENT_DETAILS_MISMATCH",
    "message": "The request was invalid or malformed",
    "timestamp": "2024-12-16T10:30:00.000Z",
    "details": {},
    "correlationId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

{
  "error": {
    "code": "PAYMENT_DETAILS_MISMATCH",
    "message": "The request was invalid or malformed",
    "timestamp": "2024-12-16T10:30:00.000Z",
    "details": {},
    "correlationId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

{
  "error": {
    "code": "PAYMENT_DETAILS_MISMATCH",
    "message": "The request was invalid or malformed",
    "timestamp": "2024-12-16T10:30:00.000Z",
    "details": {},
    "correlationId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

{
  "error": {
    "code": "PAYMENT_DETAILS_MISMATCH",
    "message": "The request was invalid or malformed",
    "timestamp": "2024-12-16T10:30:00.000Z",
    "details": {},
    "correlationId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

{
  "error": {
    "code": "PAYMENT_DETAILS_MISMATCH",
    "message": "The request was invalid or malformed",
    "timestamp": "2024-12-16T10:30:00.000Z",
    "details": {},
    "correlationId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

Authorizations

x-api-key

string

header

required

API key for service-to-service or merchant authentication.

Headers

x-correlation-id

string<uuid>

Unique identifier for request tracing. Generated by the client or server if not provided.

Example:

"550e8400-e29b-41d4-a716-446655440000"

x-idempotency-key

string<uuid>

Unique key for idempotent request processing. Duplicate requests with the same key are safely ignored.

Example:

"baf6a8e2-0c89-46ef-9ca5-faa65b99bcd5"

Path Parameters

link_id

string<uuid>

required

Unique identifier of the payment link

Example:

"550e8400-e29b-41d4-a716-446655440000"

Body

application/json

Request body for updating a payment link. Every field is optional; send only what should change.

Two kinds of update are supported, and they can be combined in one request:

Status flip — send status to deactivate or reactivate the link. Permitted at any time, including on links that have already been paid.
Field edits — any other field. Rejected with 400 once the link has been used (it has a successful payment or a payment in flight), so a customer can never see terms change mid-flow.

mode, merchant_reference_id and max_uses are immutable after creation.

status

enum<string>

Target status. Only ACTIVE ↔ DISABLED is settable here, so this enum is deliberately narrower than the PaymentLinkStatus returned on responses: EXPIRED and PAID are server-controlled and requesting either returns 400. Sending the link's current status is a no-op.

Available options:

ACTIVE,

DISABLED

Example:

"DISABLED"

redirect_urls

object

Where the customer's browser is sent after the hosted checkout completes. Propagated onto every checkout session spawned by this link.

Both URLs must be https:// — the hosted checkout returns the customer to them after a payment, so plaintext destinations are not accepted.

Show child attributes

three_ds_required

boolean

Force 3DS authentication for payments made through this link

Example:

true

description

string

Free-form description shown to the customer on the hosted checkout page

Example:

"Invoice"

customer

object

Customer details prefilled on the hosted checkout page. Every field is optional — omit the object entirely to have the customer enter their own details at checkout.

Show child attributes

metadata

object

Replaces the stored metadata object wholesale

Example:

{
  "invoice_id": "INV-4471",
  "sales_rep": "rep_88"
}

channel_id

string

Channel to attribute the link to

Example:

"3d1f9c60-5a72-4e18-b0c4-9a6d2f5e7b13"

expires_at

string<date-time>

ISO 8601 timestamp after which the link stops being payable

Example:

"2026-12-31T23:59:59Z"

amount

integer

Amount in the currency's minor units

Required range: x >= 1

Example:

12500

currency

string

ISO 4217 currency code

Example:

"SAR"

Response

Payment link updated successfully.

A shareable payment link. Sending a customer to hostedUrl spawns a checkout session and redirects them to the hosted checkout page.

Casing note: this response uses camelCase property names, while the create and update request bodies accept snake_case. This is a known divergence from the rest of the Lite API surface, which is snake_case in both directions. The contract documented here is what the service returns today — integrate against camelCase on the response.

string<uuid>

required

Unique payment link identifier

Example:

"550e8400-e29b-41d4-a716-446655440000"

publicToken

string

required

Opaque token embedded in hostedUrl. Safe to share with customers — it carries no merchant or amount information.

Example:

"plive_7c9f2a1b8e4d6035"

hostedUrl

string<uri>

required

The customer-facing URL. Opening it consumes a slot on the link, creates a checkout session and redirects the browser to the hosted checkout page. Share this URL directly with customers.

Example:

"https://pay.lite.sa/pay/plive_7c9f2a1b8e4d6035"

merchantId

string<uuid>

required

Merchant that owns the link

Example:

"7f3c8b21-0d4e-4a92-9f65-2b8e1c7a4d30"

mode

enum<string>

required

How many times the link may be paid.

SINGLE_USE — exactly one successful payment. The link is promoted to PAID as soon as a payment reaches a terminal successful status.

Available options:

SINGLE_USE

Example:

"SINGLE_USE"

status

enum<string>

required

Lifecycle status of the payment link.

ACTIVE — payable.
DISABLED — deactivated by the merchant. Reversible via the update endpoint.
EXPIRED — expires_at has passed. Applied automatically when the link is read or listed; not settable by the caller.
PAID — the usage ceiling has been reached, i.e. the SINGLE_USE link has been paid. Not settable by the caller.

Only ACTIVE ↔ DISABLED transitions are accepted on the update endpoint.

Available options:

ACTIVE,

DISABLED,

EXPIRED,

PAID

Example:

"ACTIVE"

amount

integer

required

Amount in the currency's minor units (e.g. 10000 = 100.00 SAR)

Required range: x >= 1

Example:

10000

currency

string

required

ISO 4217 currency code

Example:

"SAR"

usedCount

integer

required

Number of successful payments. Mirrors paidCount.

Example:

2

paidCount

integer

required

Number of payments through this link that reached a successful terminal status

Example:

2

failedCount

integer

required

Number of payments through this link that reached a failed terminal status

Example:

1

createdAt

string<date-time>

required

Timestamp when the link was created

Example:

"2026-06-01T10:30:00.000Z"

updatedAt

string<date-time>

required

Timestamp when the link was last updated

Example:

"2026-06-04T09:12:44.000Z"

merchantReferenceId

string | null

Merchant-supplied reference. Unique per merchant — a second create with the same value is rejected with 409, which prevents duplicate links for one order.

Example:

"order-2026-0042"

redirectUrls

object | null

Post-checkout redirect targets, or null if none were configured

Show child attributes

threeDsRequired

boolean | null

Whether 3DS authentication is forced for payments made through this link

Example:

true

description

string | null

Free-form description shown to the customer on the hosted checkout page

Example:

"Invoice"

customer

object | null

Prefilled customer details, or null if none were configured

Show child attributes

metadata

object | null

Arbitrary merchant metadata, propagated onto every checkout session spawned by this link

Example:

{
  "invoice_id": "INV-4471",
  "sales_rep": "rep_88"
}

channelId

string | null

Channel the link is attributed to

Example:

"3d1f9c60-5a72-4e18-b0c4-9a6d2f5e7b13"

expiresAt

string<date-time> | null

When the link stops being payable. Once passed, the link is promoted to EXPIRED on the next read. null means the link never expires.

Example:

"2026-12-31T23:59:59.000Z"

maxUses

integer | null

Ceiling on successful payments. null unless the caller set it explicitly; either way a SINGLE_USE link allows exactly one successful payment.

Example:

1

lastPaidAt

string<date-time> | null

Timestamp of the most recent successful payment, or null if never paid

Example:

"2026-06-04T09:12:44.000Z"

Update a payment link

curl --request PATCH \
  --url https://api.lite.sa/api/v1/payment-links/{link_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "status": "DISABLED",
  "redirect_urls": {
    "success": "https://merchant.example.com/success",
    "failure": "https://merchant.example.com/failure"
  },
  "three_ds_required": true,
  "description": "Invoice",
  "customer": {
    "id": "cus_8f1e2a4b",
    "first_name": "Sara",
    "last_name": "Al-Harbi",
    "email": "sara@example.com",
    "phone_country_code": "+966",
    "phone_number": "512345678",
    "billing_address": {
      "line1": "123 High St.",
      "line2": "Apartment 5B",
      "city": "Riyadh",
      "state": "Riyadh Province",
      "postal_code": "11564",
      "country": "SA"
    }
  },
  "metadata": {
    "invoice_id": "INV-4471",
    "sales_rep": "rep_88"
  },
  "channel_id": "3d1f9c60-5a72-4e18-b0c4-9a6d2f5e7b13",
  "expires_at": "2026-12-31T23:59:59Z",
  "amount": 12500,
  "currency": "SAR"
}
'

import requests

url = "https://api.lite.sa/api/v1/payment-links/{link_id}"

payload = {
    "status": "DISABLED",
    "redirect_urls": {
        "success": "https://merchant.example.com/success",
        "failure": "https://merchant.example.com/failure"
    },
    "three_ds_required": True,
    "description": "Invoice",
    "customer": {
        "id": "cus_8f1e2a4b",
        "first_name": "Sara",
        "last_name": "Al-Harbi",
        "email": "sara@example.com",
        "phone_country_code": "+966",
        "phone_number": "512345678",
        "billing_address": {
            "line1": "123 High St.",
            "line2": "Apartment 5B",
            "city": "Riyadh",
            "state": "Riyadh Province",
            "postal_code": "11564",
            "country": "SA"
        }
    },
    "metadata": {
        "invoice_id": "INV-4471",
        "sales_rep": "rep_88"
    },
    "channel_id": "3d1f9c60-5a72-4e18-b0c4-9a6d2f5e7b13",
    "expires_at": "2026-12-31T23:59:59Z",
    "amount": 12500,
    "currency": "SAR"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    status: 'DISABLED',
    redirect_urls: {
      success: 'https://merchant.example.com/success',
      failure: 'https://merchant.example.com/failure'
    },
    three_ds_required: true,
    description: 'Invoice',
    customer: {
      id: 'cus_8f1e2a4b',
      first_name: 'Sara',
      last_name: 'Al-Harbi',
      email: 'sara@example.com',
      phone_country_code: '+966',
      phone_number: '512345678',
      billing_address: {
        line1: '123 High St.',
        line2: 'Apartment 5B',
        city: 'Riyadh',
        state: 'Riyadh Province',
        postal_code: '11564',
        country: 'SA'
      }
    },
    metadata: {invoice_id: 'INV-4471', sales_rep: 'rep_88'},
    channel_id: '3d1f9c60-5a72-4e18-b0c4-9a6d2f5e7b13',
    expires_at: '2026-12-31T23:59:59Z',
    amount: 12500,
    currency: 'SAR'
  })
};

fetch('https://api.lite.sa/api/v1/payment-links/{link_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    status: 'DISABLED',
    redirect_urls: {
      success: 'https://merchant.example.com/success',
      failure: 'https://merchant.example.com/failure'
    },
    three_ds_required: true,
    description: 'Invoice',
    customer: {
      id: 'cus_8f1e2a4b',
      first_name: 'Sara',
      last_name: 'Al-Harbi',
      email: 'sara@example.com',
      phone_country_code: '+966',
      phone_number: '512345678',
      billing_address: {
        line1: '123 High St.',
        line2: 'Apartment 5B',
        city: 'Riyadh',
        state: 'Riyadh Province',
        postal_code: '11564',
        country: 'SA'
      }
    },
    metadata: {invoice_id: 'INV-4471', sales_rep: 'rep_88'},
    channel_id: '3d1f9c60-5a72-4e18-b0c4-9a6d2f5e7b13',
    expires_at: '2026-12-31T23:59:59Z',
    amount: 12500,
    currency: 'SAR'
  })
};

fetch('https://api.lite.sa/api/v1/payment-links/{link_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.lite.sa/api/v1/payment-links/{link_id}"

	payload := strings.NewReader("{\n  \"status\": \"DISABLED\",\n  \"redirect_urls\": {\n    \"success\": \"https://merchant.example.com/success\",\n    \"failure\": \"https://merchant.example.com/failure\"\n  },\n  \"three_ds_required\": true,\n  \"description\": \"Invoice\",\n  \"customer\": {\n    \"id\": \"cus_8f1e2a4b\",\n    \"first_name\": \"Sara\",\n    \"last_name\": \"Al-Harbi\",\n    \"email\": \"sara@example.com\",\n    \"phone_country_code\": \"+966\",\n    \"phone_number\": \"512345678\",\n    \"billing_address\": {\n      \"line1\": \"123 High St.\",\n      \"line2\": \"Apartment 5B\",\n      \"city\": \"Riyadh\",\n      \"state\": \"Riyadh Province\",\n      \"postal_code\": \"11564\",\n      \"country\": \"SA\"\n    }\n  },\n  \"metadata\": {\n    \"invoice_id\": \"INV-4471\",\n    \"sales_rep\": \"rep_88\"\n  },\n  \"channel_id\": \"3d1f9c60-5a72-4e18-b0c4-9a6d2f5e7b13\",\n  \"expires_at\": \"2026-12-31T23:59:59Z\",\n  \"amount\": 12500,\n  \"currency\": \"SAR\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.lite.sa/api/v1/payment-links/{link_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'status' => 'DISABLED',
    'redirect_urls' => [
        'success' => 'https://merchant.example.com/success',
        'failure' => 'https://merchant.example.com/failure'
    ],
    'three_ds_required' => true,
    'description' => 'Invoice',
    'customer' => [
        'id' => 'cus_8f1e2a4b',
        'first_name' => 'Sara',
        'last_name' => 'Al-Harbi',
        'email' => 'sara@example.com',
        'phone_country_code' => '+966',
        'phone_number' => '512345678',
        'billing_address' => [
                'line1' => '123 High St.',
                'line2' => 'Apartment 5B',
                'city' => 'Riyadh',
                'state' => 'Riyadh Province',
                'postal_code' => '11564',
                'country' => 'SA'
        ]
    ],
    'metadata' => [
        'invoice_id' => 'INV-4471',
        'sales_rep' => 'rep_88'
    ],
    'channel_id' => '3d1f9c60-5a72-4e18-b0c4-9a6d2f5e7b13',
    'expires_at' => '2026-12-31T23:59:59Z',
    'amount' => 12500,
    'currency' => 'SAR'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "publicToken": "plive_7c9f2a1b8e4d6035",
  "hostedUrl": "https://pay.lite.sa/pay/plive_7c9f2a1b8e4d6035",
  "merchantId": "7f3c8b21-0d4e-4a92-9f65-2b8e1c7a4d30",
  "mode": "SINGLE_USE",
  "status": "ACTIVE",
  "amount": 10000,
  "currency": "SAR",
  "usedCount": 2,
  "paidCount": 2,
  "failedCount": 1,
  "createdAt": "2026-06-01T10:30:00.000Z",
  "updatedAt": "2026-06-04T09:12:44.000Z",
  "merchantReferenceId": "order-2026-0042",
  "redirectUrls": {
    "success": "https://merchant.example.com/success",
    "failure": "https://merchant.example.com/failure"
  },
  "threeDsRequired": true,
  "description": "Invoice",
  "customer": {
    "id": "cus_8f1e2a4b",
    "firstName": "Sara",
    "lastName": "Al-Harbi",
    "email": "sara@example.com",
    "phoneCountryCode": "+966",
    "phoneNumber": "512345678",
    "billingAddress": {
      "line1": "123 High St.",
      "line2": "Apartment 5B",
      "city": "Riyadh",
      "state": "Riyadh Province",
      "postalCode": "11564",
      "country": "SA"
    }
  },
  "metadata": {
    "invoice_id": "INV-4471",
    "sales_rep": "rep_88"
  },
  "channelId": "3d1f9c60-5a72-4e18-b0c4-9a6d2f5e7b13",
  "expiresAt": "2026-12-31T23:59:59.000Z",
  "maxUses": 1,
  "lastPaidAt": "2026-06-04T09:12:44.000Z"
}

{
  "error": {
    "code": "PAYMENT_DETAILS_MISMATCH",
    "message": "The request was invalid or malformed",
    "timestamp": "2024-12-16T10:30:00.000Z",
    "details": {},
    "correlationId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

{
  "error": {
    "code": "PAYMENT_DETAILS_MISMATCH",
    "message": "The request was invalid or malformed",
    "timestamp": "2024-12-16T10:30:00.000Z",
    "details": {},
    "correlationId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

{
  "error": {
    "code": "PAYMENT_DETAILS_MISMATCH",
    "message": "The request was invalid or malformed",
    "timestamp": "2024-12-16T10:30:00.000Z",
    "details": {},
    "correlationId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

{
  "error": {
    "code": "PAYMENT_DETAILS_MISMATCH",
    "message": "The request was invalid or malformed",
    "timestamp": "2024-12-16T10:30:00.000Z",
    "details": {},
    "correlationId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

{
  "error": {
    "code": "PAYMENT_DETAILS_MISMATCH",
    "message": "The request was invalid or malformed",
    "timestamp": "2024-12-16T10:30:00.000Z",
    "details": {},
    "correlationId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

Payment Acceptance

Tokenization

Account Settlement

Update a payment link

Authorizations

Headers

Path Parameters

Body

Response