# Kyren Pay ## Documentation ### Start Here - [Introduction](https://docs.kyrenpay.com/introduction.md): Accept payments from customers worldwide with Kyren Pay - [Start Here](https://docs.kyrenpay.com/start-here.md): Choose the fastest path for your Kyren Pay setup - [Quickstart](https://docs.kyrenpay.com/quickstart.md): Accept your first payment in 5 minutes - [Collect Your First Payment](https://docs.kyrenpay.com/guides/collect-first-payment.md): End-to-end guide to accepting a payment with Kyren Pay - [Go-live checklist](https://docs.kyrenpay.com/go-live-checklist.md): Review your Kyren Pay setup before accepting production traffic ### Dashboard Guide - [Dashboard overview](https://docs.kyrenpay.com/dashboard/overview.md): Find the main merchant dashboard areas in Kyren Pay - [Products](https://docs.kyrenpay.com/dashboard/products.md): Create and manage products in the Kyren Pay dashboard - [Checkout links and hosted checkout](https://docs.kyrenpay.com/dashboard/checkouts.md): Understand how customers complete payment through Kyren Pay checkout - [Orders](https://docs.kyrenpay.com/dashboard/orders.md): Review Kyren Pay orders and reconcile payment status - [Order refunds](https://docs.kyrenpay.com/dashboard/order-refunds.md): Request refunds from the order detail page and track review, execution, and Webhook updates - [Payment methods](https://docs.kyrenpay.com/dashboard/payment-methods.md): Enable bound payment methods and configure customer fee sharing - [Disputes](https://docs.kyrenpay.com/dashboard/disputes.md): Review dispute cases, deadlines, timelines and their recorded financial impact - [Funds](https://docs.kyrenpay.com/dashboard/funds.md): Review balances, transactions, settlements, and settlement accounts - [KYC](https://docs.kyrenpay.com/dashboard/kyc.md): Submit and review personal verification information - [KYB](https://docs.kyrenpay.com/dashboard/kyb.md): Submit and review business verification information - [Merchant agreement](https://docs.kyrenpay.com/dashboard/merchant-agreement.md): Accept the merchant services agreement during verification or a signing reminder - [Developer settings](https://docs.kyrenpay.com/dashboard/developer-settings.md): Manage API keys, Webhooks, and integration settings - [Personal settings](https://docs.kyrenpay.com/dashboard/personal-settings.md): Manage profile details, account security, password, and 2FA ### Webhooks - [Webhook Overview](https://docs.kyrenpay.com/webhooks/overview.md): Receive real-time payment notifications via webhooks - [Webhook Events](https://docs.kyrenpay.com/webhooks/events.md): All webhook event types and their payloads - [Webhook Signatures](https://docs.kyrenpay.com/webhooks/signatures.md): Verify the authenticity of webhook requests - [Webhook Retries](https://docs.kyrenpay.com/webhooks/retries.md): How Kyren Pay retries failed webhook deliveries ### Troubleshooting - [API request returns 401](https://docs.kyrenpay.com/troubleshooting/api-401.md): Diagnose Kyren Pay API authentication failures. - [Checkout session creation fails](https://docs.kyrenpay.com/troubleshooting/checkout-session-fails.md): Fix validation and configuration errors when creating checkout sessions. - [Customer paid but was not credited](https://docs.kyrenpay.com/troubleshooting/paid-but-not-credited.md): Reconcile paid orders that were not fulfilled in your system. - [Webhook not received](https://docs.kyrenpay.com/troubleshooting/webhook-not-received.md): Find why your server did not receive a Kyren Pay Webhook event. - [Webhook signature verification fails](https://docs.kyrenpay.com/troubleshooting/webhook-signature-fails.md): Fix common Kyren Pay Webhook signature verification errors. - [Order status does not match expectation](https://docs.kyrenpay.com/troubleshooting/order-status.md): Understand Kyren Pay order statuses and reconciliation checks. - [Amount, currency, or timestamp validation fails](https://docs.kyrenpay.com/troubleshooting/amount-currency-timestamp.md): Fix common formatting errors for amounts, currencies, and timestamps. - [Settlement eligibility is not met](https://docs.kyrenpay.com/troubleshooting/settlement-eligibility.md): Understand why a merchant account may not yet be eligible for settlement. ### Epay Migration - [Epay-compatible migration](https://docs.kyrenpay.com/epay-migration/overview.md): Migrate an existing Epay-style integration to Kyren Pay compatibility endpoints. - [Epay MD5 signature](https://docs.kyrenpay.com/epay-migration/signature.md): Build and verify Epay-compatible MD5 signatures for Kyren Pay migration endpoints. - [submit.php redirect checkout](https://docs.kyrenpay.com/epay-migration/submit-php.md): Use the Epay-compatible submit.php endpoint for browser redirect checkout. - [mapi.php direct payment creation](https://docs.kyrenpay.com/epay-migration/mapi-php.md): Use the Epay-compatible mapi.php endpoint for server-to-server payment creation. - [api.php order query and refund compatibility](https://docs.kyrenpay.com/epay-migration/api-php.md): Use Epay-compatible api.php order query and understand refund compatibility behavior. - [Epay migration checklist](https://docs.kyrenpay.com/epay-migration/migration-checklist.md): Checklist for moving an Epay-style integration to Kyren Pay compatibility endpoints. ### System Integrations - [Configure sub2api](https://docs.kyrenpay.com/integrations/sub2api.md): Connect sub2api balance top-ups to Kyren Pay through its built-in EasyPay provider. - [Configure new-api](https://docs.kyrenpay.com/integrations/new-api.md): Connect new-api balance top-ups to Kyren Pay through Epay settings. ### FAQ - [Common merchant questions](https://docs.kyrenpay.com/faq/common-questions.md): Short answers to frequent Kyren Pay merchant questions with links to canonical docs. ### References - [Authentication](https://docs.kyrenpay.com/authentication.md): Authenticate your API requests with API keys - [Errors](https://docs.kyrenpay.com/errors.md): Understanding API error responses - [Testing](https://docs.kyrenpay.com/testing.md): Test your Kyren Pay integration before going live - [Code Examples](https://docs.kyrenpay.com/guides/code-examples.md): Integration examples in cURL, Python, Node.js, and Go ## API Reference ### Config - [Get supported currencies](https://docs.kyrenpay.com/api-reference/config/get-supported-currencies.md): Returns the list of currencies supported by the platform and the default currency. Use this when creating products or configuring pricing to ensure you use a supported currency. - [Get settlement configuration](https://docs.kyrenpay.com/api-reference/config/get-settlement-configuration.md): Returns the platform-wide settlement period in business days. Individual orders may use their channel's period captured at creation. Use order `settleDateTime` for the expected eligibility time and `settledAt` for actual settlement. This configuration does not guarantee payout timing. - [Get legal configuration](https://docs.kyrenpay.com/api-reference/config/get-legal-configuration.md): Returns the current legal terms version and public document URLs. Reading these documents does not record merchant agreement acceptance. - [Get current merchant services agreement](https://docs.kyrenpay.com/api-reference/config/get-current-merchant-services-agreement.md): Returns the current rendered agreement, its version, effective date, hashes, and public URL. Retrieve it without an API key. Complete acceptance in the merchant dashboard; downloading this document does not sign it or change the account's agreement status. - [Get historical merchant services agreement](https://docs.kyrenpay.com/api-reference/config/get-historical-merchant-services-agreement.md): Returns the agreement for an explicit version and effective date. Reading a historical document does not complete acceptance of the current agreement. ### Products - [List all products](https://docs.kyrenpay.com/api-reference/products/list-all-products.md): Returns a paginated list of your products. - [Create a product](https://docs.kyrenpay.com/api-reference/products/create-a-product.md): Creates a new product. Products represent the goods or services you sell. - [Retrieve a product](https://docs.kyrenpay.com/api-reference/products/retrieve-a-product.md): Retrieves the details of an existing product. - [Archive a product](https://docs.kyrenpay.com/api-reference/products/archive-a-product.md): Archives a product. Archived products cannot be used to create new checkout sessions. - [Update a product](https://docs.kyrenpay.com/api-reference/products/update-a-product.md): Updates an existing product. Only the provided fields will be updated. ### Checkouts - [Create a checkout session](https://docs.kyrenpay.com/api-reference/checkouts/create-a-checkout-session.md): Creates a new checkout session for a product. Returns a URL where you can redirect your customer to complete the payment. Checkout sessions expire after 24 hours. - [Retrieve a checkout session](https://docs.kyrenpay.com/api-reference/checkouts/retrieve-a-checkout-session.md): Retrieves the details of an existing checkout session. ### Orders - [List all orders](https://docs.kyrenpay.com/api-reference/orders/list-all-orders.md): Returns a paginated list of your orders. An order may exist before payment completes; use its status to decide whether to fulfill. - [Retrieve an order](https://docs.kyrenpay.com/api-reference/orders/retrieve-an-order.md): Retrieves merchant-visible order details, including original and payable amounts, fee sharing, refund status, and rolling reserve information. - [Export orders as CSV](https://docs.kyrenpay.com/api-reference/orders/export-orders-as-csv.md): Exports orders within the specified date range as a CSV file. Use Unix timestamps (milliseconds) for startDate and endDate. ### Refunds - [Create a refund](https://docs.kyrenpay.com/api-reference/refunds/create-a-refund.md): Creates a full or partial refund for an eligible paid order created through the native Kyren API. Epay-source orders must be refunded through the Epay compatibility API. - [Retrieve a refund](https://docs.kyrenpay.com/api-reference/refunds/retrieve-a-refund.md): Retrieves a refund created for one of your orders. ### Balance - [Retrieve account balance](https://docs.kyrenpay.com/api-reference/balance/retrieve-account-balance.md): Returns the current balance of your merchant account. - [List balance transactions](https://docs.kyrenpay.com/api-reference/balance/list-balance-transactions.md): Returns a paginated list of balance transactions showing all changes to your account balance. ### Epay Compatibility - [submit.php (redirect checkout compatibility endpoint)](https://docs.kyrenpay.com/api-reference/epay-compatibility/submitphp-redirect-checkout-compatibility-endpoint.md): Creates (or reuses) an Epay-compatible payment and returns HTTP 302 redirect to the hosted payment page. This endpoint also accepts GET with the same parameters. - [mapi.php (direct create payment compatibility endpoint)](https://docs.kyrenpay.com/api-reference/epay-compatibility/mapiphp-direct-create-payment-compatibility-endpoint.md): Creates (or reuses) an order directly and returns Epay-style response fields. For QR-style channels, response includes `qrcode` and `img`. For redirect-style channels, response includes `payurl`. - [api.php (order query/refund compatibility endpoint)](https://docs.kyrenpay.com/api-reference/epay-compatibility/apiphp-order-queryrefund-compatibility-endpoint.md): Executes compatibility operations with `act`. - `act=order`: query order status/result. - `act=refund`: submit a refund for an eligible Epay-source order. ## OpenAPI Specs - [openapi](/openapi.yaml) > The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages. ## Indexes - [Chinese (65 pages)](https://docs.kyrenpay.com/_llms/zh.md): Documentation for Chinese. - [Traditional Chinese (65 pages)](https://docs.kyrenpay.com/_llms/zh-hant.md): Documentation for Traditional Chinese. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.