# LiteCore API Reference

## Docs

- [Confirm 3DS challenge completion](https://docs.lite.sa/api-reference/3ds-authentication/confirm-3ds-challenge-completion.md): Confirms that the cardholder has completed the 3DS challenge. The authentication session must be in CHALLENGE_REQUIRED status.
- [Create a new 3DS Authentication session](https://docs.lite.sa/api-reference/3ds-authentication/create-a-new-3ds-authentication-session.md): Start a new 3DS authentication session to authenticate a payer
- [Get an authentication session](https://docs.lite.sa/api-reference/3ds-authentication/get-an-authentication-session.md): Retrieves a 3DS authentication session using the provided authentication id
- [Check session validity](https://docs.lite.sa/api-reference/hosted-checkout/check-session-validity.md): Checks whether a checkout session is still valid (not expired, cancelled, or completed).
- [Create a checkout session](https://docs.lite.sa/api-reference/hosted-checkout/create-a-checkout-session.md): Creates a new hosted checkout session and returns a payment link and client secret for use in the frontend SDK.
- [Get a checkout session](https://docs.lite.sa/api-reference/hosted-checkout/get-a-checkout-session.md): Retrieves a checkout session with full details including available payment methods, checkout configuration, and HATEOAS action links.
- [Update a checkout session](https://docs.lite.sa/api-reference/hosted-checkout/update-a-checkout-session.md): Updates configurable fields on an existing checkout session such as redirect URLs, 3DS requirement, customer details, metadata, and available payment methods.
- [Create a payment instrument](https://docs.lite.sa/api-reference/payment-instruments/create-a-payment-instrument.md): Creates a new payment instrument (card, IBAN, or digital wallet) for a merchant and holder. The instrument data can be provided as raw PAN data (pan_data), as an encrypted JWE token (data), or as a digital wallet token.
- [Get a single instrument by ID](https://docs.lite.sa/api-reference/payment-instruments/get-a-single-instrument-by-id.md): Retrieves a specific instrument by its ID with full details including status and display information.
- [Lookup instruments](https://docs.lite.sa/api-reference/payment-instruments/lookup-instruments.md): Retrieves instruments for a merchant, optionally filtered by holder ID. Returns a list of matching instruments with their current status.
- [Perform action on instrument(s)](https://docs.lite.sa/api-reference/payment-instruments/perform-action-on-instruments.md): Performs actions like block, activate, delete, or expire on specific instruments or on all instruments for a holder.
- [Capture an authorized payment](https://docs.lite.sa/api-reference/server-to-server-payments/capture-an-authorized-payment.md): Captures all or part of an authorized payment. If no amount is specified, the full authorized amount is captured.
- [Create a new payment](https://docs.lite.sa/api-reference/server-to-server-payments/create-a-new-payment.md): Initiates a payment request for processing. Returns immediately with an accepted response; the payment is processed asynchronously.
- [Get payment by ID](https://docs.lite.sa/api-reference/server-to-server-payments/get-payment-by-id.md): Returns payment details. Use query parameter `include=instrument,operations` to expand instrument and/or operations in the response.
- [Get payment by order ID](https://docs.lite.sa/api-reference/server-to-server-payments/get-payment-by-order-id.md): Returns payment details for a specific order. Use query parameter `include=instrument,operations` to expand instrument and/or operations in the response.
- [List merchant payments](https://docs.lite.sa/api-reference/server-to-server-payments/list-merchant-payments.md): Lists payment requests for the merchant. Supports pagination and filtering.
- [Refund a captured payment](https://docs.lite.sa/api-reference/server-to-server-payments/refund-a-captured-payment.md): Refunds all or part of a captured payment. If no amount is specified, the full remaining captured amount is refunded.
- [Void an authorized payment](https://docs.lite.sa/api-reference/server-to-server-payments/void-an-authorized-payment.md): Reverses an authorization before it has been captured.
- [3DS Authentication](https://docs.lite.sa/guides/3DS-authentication.md): Authenticate a cardholder with 3D Secure, then use the result to authorize a payment.
- [Apple Pay](https://docs.lite.sa/guides/apple-pay.md): apple pay web integration
- [Channel Configuration](https://docs.lite.sa/guides/channel-configuration.md): Create and configure the sales channels that scope how Lite processes your payments.
- [Accept payments with lite](https://docs.lite.sa/guides/get-started.md): Getting started with online payments, choose the integration that suits your business requirements.
- [Hosted Page](https://docs.lite.sa/guides/hosted-checkout-page.md): Redirect customers to a Lite-hosted checkout page and confirm payment with webhooks.
- [Payment Instruments & Tokenization](https://docs.lite.sa/guides/payment-instruments.md): Payment instruments creation and life-cycle
- [Payment Links](https://docs.lite.sa/guides/payment-links.md): Create a shareable link your customer can pay through, no integration required.
- [Payment Operations](https://docs.lite.sa/guides/payment-operations.md): lite's supported payment operations and their transitions.
- [Payments API](https://docs.lite.sa/guides/payments api.md): Charge a card directly from your backend: authorize, capture, void, and refund.
- [Samsung pay](https://docs.lite.sa/guides/samsung-pay.md)
- [Web sdk](https://docs.lite.sa/guides/web-sdk.md): How to integrate and manage payments via our web-sdk
- [FeeSummary](https://docs.lite.sa/schemas/account-settlement/FeeSummary.md): A fee applied to a transaction
- [PaginationData](https://docs.lite.sa/schemas/account-settlement/PaginationData.md): Pagination metadata for list responses
- [SettlementWindow](https://docs.lite.sa/schemas/account-settlement/SettlementWindow.md): A settlement window representing a merchant payout cycle
- [SettlementWindowSummary](https://docs.lite.sa/schemas/account-settlement/SettlementWindowSummary.md): Summary of settled amounts aggregated by settlement window status
- [SettlementWindowSummaryByCurrency](https://docs.lite.sa/schemas/account-settlement/SettlementWindowSummaryByCurrency.md): Settlement amount summary broken down by currency
- [Transaction](https://docs.lite.sa/schemas/account-settlement/Transaction.md): A settlement transaction record
- [Address](https://docs.lite.sa/schemas/payment-acceptance/Address.md): Address information
- [AuthenticationSession](https://docs.lite.sa/schemas/payment-acceptance/AuthenticationSession.md): AuthenticationSession data model
- [CaptureRequest](https://docs.lite.sa/schemas/payment-acceptance/CaptureRequest.md): Capture amount and metadata. If amount is omitted, the full authorized amount is captured.
- [CardConfig](https://docs.lite.sa/schemas/payment-acceptance/CardConfig.md): Card method configuration
- [CardMethod](https://docs.lite.sa/schemas/payment-acceptance/CardMethod.md): Card payment method with checkout configuration
- [CardNetworks](https://docs.lite.sa/schemas/payment-acceptance/CardNetworks.md): Supported card networks
- [CheckoutConfig](https://docs.lite.sa/schemas/payment-acceptance/CheckoutConfig.md): Checkout page configuration
- [CheckoutPaymentMethods](https://docs.lite.sa/schemas/payment-acceptance/CheckoutPaymentMethods.md): Available payment methods for the checkout session
- [CheckoutSessionDetails](https://docs.lite.sa/schemas/payment-acceptance/CheckoutSessionDetails.md): Full checkout session details
- [CheckoutSessionLinks](https://docs.lite.sa/schemas/payment-acceptance/CheckoutSessionLinks.md): HATEOAS links for checkout session actions
- [CheckoutSessionResponse](https://docs.lite.sa/schemas/payment-acceptance/CheckoutSessionResponse.md): Response returned after creating a checkout session
- [CreateAuthenticationRequest](https://docs.lite.sa/schemas/payment-acceptance/CreateAuthenticationRequest.md): CreateAuthenticationRequest data model
- [CreateCheckoutSessionRequest](https://docs.lite.sa/schemas/payment-acceptance/CreateCheckoutSessionRequest.md): Request body for creating a new checkout session
- [CreatePaymentRequest](https://docs.lite.sa/schemas/payment-acceptance/CreatePaymentRequest.md): CreatePaymentRequest data model
- [Customer](https://docs.lite.sa/schemas/payment-acceptance/Customer.md): Customer details
- [Device](https://docs.lite.sa/schemas/payment-acceptance/Device.md): Device information (required for 3DS and risk assessment)
- [InstrumentDisplay](https://docs.lite.sa/schemas/payment-acceptance/InstrumentDisplay.md): Card display information for stored instruments
- [Link](https://docs.lite.sa/schemas/payment-acceptance/Link.md): Link data model
- [Order](https://docs.lite.sa/schemas/payment-acceptance/Order.md): Order details
- [OrderItems](https://docs.lite.sa/schemas/payment-acceptance/OrderItems.md): Order line items
- [Payment](https://docs.lite.sa/schemas/payment-acceptance/Payment.md): Payment data model
- [PaymentListResponse](https://docs.lite.sa/schemas/payment-acceptance/PaymentListResponse.md): PaymentListResponse data model
- [Product](https://docs.lite.sa/schemas/payment-acceptance/Product.md): Product data model
- [RedirectUrls](https://docs.lite.sa/schemas/payment-acceptance/RedirectUrls.md): Redirect URLs for checkout session
- [RefundRequest](https://docs.lite.sa/schemas/payment-acceptance/RefundRequest.md): Refund amount, reason, and metadata. If amount is omitted, the full remaining captured amount is refunded.
- [StoredInstrument](https://docs.lite.sa/schemas/payment-acceptance/StoredInstrument.md): Stored payment instrument for quick checkout
- [UpdateCheckoutSessionRequest](https://docs.lite.sa/schemas/payment-acceptance/UpdateCheckoutSessionRequest.md): Request body for updating a checkout session
- [VoidRequest](https://docs.lite.sa/schemas/payment-acceptance/VoidRequest.md): Void reason and metadata.
- [WalletDependencies](https://docs.lite.sa/schemas/payment-acceptance/WalletDependencies.md): Wallet method dependencies
- [WalletMethod](https://docs.lite.sa/schemas/payment-acceptance/WalletMethod.md): Digital wallet payment method
- [Agreement](https://docs.lite.sa/schemas/tokenization/Agreement.md): Card-on-file agreement details for recurring or unscheduled transactions
- [AgreementConsent](https://docs.lite.sa/schemas/tokenization/AgreementConsent.md): Consent details for card-on-file agreement
- [CreateInstrumentRequest](https://docs.lite.sa/schemas/tokenization/CreateInstrumentRequest.md): Request body for creating a new payment instrument
- [CreateInstrumentResponse](https://docs.lite.sa/schemas/tokenization/CreateInstrumentResponse.md): Response returned after creating a new instrument
- [InstrumentActionRequest](https://docs.lite.sa/schemas/tokenization/InstrumentActionRequest.md): InstrumentActionRequest data model
- [InstrumentActionResponse](https://docs.lite.sa/schemas/tokenization/InstrumentActionResponse.md): Instrument action result
- [InstrumentDetailsResponse](https://docs.lite.sa/schemas/tokenization/InstrumentDetailsResponse.md): Instrument details response
- [InstrumentDisplay](https://docs.lite.sa/schemas/tokenization/InstrumentDisplay.md): Masked display information for card instruments
- [InstrumentListResponse](https://docs.lite.sa/schemas/tokenization/InstrumentListResponse.md): List of instruments with total count
- [InstrumentResponse](https://docs.lite.sa/schemas/tokenization/InstrumentResponse.md): Full instrument details
- [PanData](https://docs.lite.sa/schemas/tokenization/PanData.md): PAN (Primary Account Number) data for card tokenization

## OpenAPI Specs

- [payment-instruments](https://docs.lite.sa/openapi/payment-instruments.json)
- [payment-acceptance](https://docs.lite.sa/openapi/payment-acceptance.json)
- [account-settlement](https://docs.lite.sa/openapi/account-settlement.json)
- [openapi](https://docs.lite.sa/api-reference/openapi.json)