Skip to main content
POST
/
instruments
curl --request POST \
  --url https://api.lite.sa/v1/instruments \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "holder_id": "06463cf8-c156-4ff6-bf02-5d559b738718",
  "payment_method": "card",
  "holder_type": "CUSTOMER"
}
'
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "created_at": "2024-01-01T00:00:00.000Z",
  "merchant_id": "merch_123456789",
  "holder_id": "holder_123456789",
  "payment_method": "card",
  "holder_type": "CUSTOMER"
}
{
  "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"

Body

application/json

Instrument creation data

Request body for creating a new payment instrument

​
holder_id
string
required

Holder ID (customer or beneficiary)

Example:

"holder_123456789"

​
payment_method
required

Credit or debit card

Allowed value: "card"
Example:

"card"

​
holder_type
required

End customer

Allowed value: "CUSTOMER"
Example:

"CUSTOMER"

​
pan_data
object

PAN (Primary Account Number) data for card tokenization

​
data
string

Additional data (e.g., encrypted JWE token or device payment token)

Example:

"{\"version\":\"EC_v1\",\"data\":\"...\",\"signature\":\"...\",\"header\":{...}}"

​
agreement
object

Card-on-file agreement details for recurring or unscheduled transactions

​
future_usage

Unscheduled recurring card-on-file transaction

Allowed value: "unscheduled_card_on_file"
Example:

"unscheduled_card_on_file"

Response

Instrument created successfully.

Response returned after creating a new instrument

​
id
string<uuid>
required

Unique instrument identifier

Example:

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

​
created_at
string<date-time>
required

Timestamp when the instrument was created

Example:

"2024-01-01T00:00:00.000Z"

​
merchant_id
string
required

Merchant that owns the instrument

Example:

"merch_123456789"

​
holder_id
string
required

Holder ID associated with the instrument

Example:

"holder_123456789"

​
payment_method
required

Credit or debit card

Allowed value: "card"
Example:

"card"

​
holder_type
required

End customer

Allowed value: "CUSTOMER"
Example:

"CUSTOMER"