Payment

string<uuid>

required

Unique payment identifier

Example:

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

merchant_id

string<uuid>

required

Merchant ID

Example:

"f3baf375-1cac-4aa2-bd36-0d7ca49ef59b"

amount

integer

required

Payment amount in minor units

Example:

10000

currency

string

required

Currency code (ISO 4217)

Example:

"SAR"

status

required

Payment has been created and queued for processing

Allowed value: "CREATED"

Example:

"PENDING"

created_at

string<date-time>

required

Creation timestamp

Example:

"2026-04-08T20:53:45.517Z"

acting_business_account_id

string<uuid> | null

Business account that created the payment

Example:

"6c1a1b0e-4a7e-4d51-9a6f-2f5d3f9c1a44"

terminal_id

string<uuid> | null

Online terminal the payment was taken through (business accounts only). Null for legacy merchants and for payments made before terminals existed. Unrelated to the POS terminal on device.terminal_id.

Example:

"0b9d1c3e-6a51-4f6e-9a54-0f4f2b6e7d11"

splits

object[] | null

Transaction-level split allocations frozen at payment creation, in minor units. Null when the payment has no splits.

Show child attributes

processing_type

Standard one-time payment

Allowed value: "REGULAR"

Example:

"REGULAR"

capture_mode

Payment was captured immediately upon authorization

Allowed value: "INSTANT"

Example:

"MANUAL"

payment_instrument_id

string<uuid>

Payment instrument ID

Example:

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

payment_method

Credit or debit card payment

Allowed value: "CARD"

Example:

"CARD"

risk

object

Risk assessment data and result

Show child attributes

customer

object

Customer details

Show child attributes

order

object

Order details

Show child attributes

device

object

Device information (required for 3DS and risk assessment)

Show child attributes

threeds

object

3DS authentication data and result

Show child attributes

return_info

object

Return URLs

Show child attributes

metadata

object

Additional metadata

instrument

object

Payment instrument details (returned when include=instrument)

Show child attributes

operations

object[]

Payment operations (returned when include=operations)

Show child attributes

{
  "id": "baf6a8e2-0c89-46ef-9ca5-faa65b99bcd5",
  "merchant_id": "f3baf375-1cac-4aa2-bd36-0d7ca49ef59b",
  "amount": 10000,
  "currency": "SAR",
  "status": "PENDING",
  "created_at": "2026-04-08T20:53:45.517Z",
  "acting_business_account_id": "6c1a1b0e-4a7e-4d51-9a6f-2f5d3f9c1a44",
  "terminal_id": "0b9d1c3e-6a51-4f6e-9a54-0f4f2b6e7d11",
  "splits": [
    {
      "amount": 9000,
      "business_account_id": "019859f8-3149-7a55-8211-a8179675d269",
      "account_reference": "main"
    }
  ],
  "processing_type": "REGULAR",
  "capture_mode": "MANUAL",
  "payment_instrument_id": "baf6a8e2-0c89-46ef-9ca5-faa65b99bcd5",
  "payment_method": "CARD",
  "risk": {
    "data": {
      "enabled": true,
      "device_session_id": "sess_abc123"
    },
    "result": {
      "score": 75
    }
  },
  "customer": {
    "id": "cust_a1b2c3d4e5f6",
    "email": "john.doe@email.com",
    "first_name": "John",
    "last_name": "Doe",
    "phone_country_code": "+966",
    "phone_number": "555123456"
  },
  "threeds": {
    "data": {
      "authentication_value": "<string>",
      "eci": "<string>",
      "version": "<string>",
      "ds_transaction_id": "<string>",
      "trans_status": "<string>",
      "xid": "<string>"
    },
    "result": {
      "authentication_status": "Y",
      "challenge_required": true,
      "eci": "05",
      "authentication_value": "<string>",
      "xid": "<string>",
      "version": "<string>",
      "ds_trans_id": "550e8400-e29b-41d4-a716-446655440000",
      "acs_trans_id": "<string>"
    },
    "attempts": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "status": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "eci": "05",
        "trans_status": "Y"
      }
    ]
  },
  "return_info": {
    "success": "https://example.com/success",
    "cancel": "https://example.com/cancel",
    "error": "https://example.com/error"
  },
  "metadata": {},
  "instrument": {
    "id": "<string>",
    "type": "<string>",
    "last_four_digits": "1111",
    "brand": "mada",
    "expiry_month": 12,
    "expiry_year": 27,
    "cardholder_name": "<string>",
    "fingerprint": "<string>",
    "future_usage": "unscheduled_card_on_file",
    "agreement_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z"
  },
  "operations": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "operation_type": "CAPTURE",
      "status": "SUCCESS",
      "amount": 10000,
      "currency": "SAR",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "idempotency_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "reason": "<string>",
      "initiated_by": "<string>",
      "acting_business_account_id": "6c1a1b0e-4a7e-4d51-9a6f-2f5d3f9c1a44",
      "connector_type": "<string>",
      "connector_response_code": "<string>",
      "connector_response_message": "<string>",
      "connector_transaction_id": "<string>",
      "http_status_code": 123,
      "processing_duration_ms": 123,
      "retry_count": 123,
      "max_retries": 123,
      "next_retry_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Account Settlement

Payment Acceptance

Tokenization