> ## Documentation Index
> Fetch the complete documentation index at: https://doc.haipay.net/llms.txt
> Use this file to discover all available pages before exploring further.

# Changelog

***

title: "Changelog"
description: "Product updates and announcements"
rss: true
---------

<Update label="August 12, 2026" description="Kora Africa Four-Country Payment Documentation Expansion" tags={["KES", "ZAR", "XAF", "TZS", "Kenya", "SouthAfrica", "Cameroon", "Tanzania", "PayIn", "PayOut"]}>
  Expanded Kora channel coverage to four African countries: added collection APIs for Kenya and South Africa, launched full payment documentation for Cameroon and Tanzania, and raised the ZAR disbursement limit.

  Recent updates:

  * Kenya (KES): added collection API supporting Mobile Money (EWALLET), covering M-Pesa (Safaricom), Airtel Money, Equitel, T-Kash, and Telcom Kenya, with a transaction limit of 1-100,000 KES
  * South Africa (ZAR): added collection API supporting Pay with Bank / Instant EFT (BANK\_TRANSFER), covering 8 banks including Standard Bank, Nedbank, FNB, and ABSA; disbursement limit raised to 1-10,000,000 ZAR
  * Cameroon (XAF): launched collection and disbursement API documentation supporting MTN Mobile Money and Orange Money, with a transaction limit of 1,000-5,000,000 XAF (integer amounts only, no decimal places)
  * Tanzania (TZS): launched collection and disbursement API documentation supporting Airtel Money, HaloPesa, Tigo Pesa, and Vodacom M-Pesa, with a transaction limit of 1,000-5,000,000 TZS
  * Added API Reference (OpenAPI interactive docs) for all four countries in both Chinese and English
</Update>

<Update label="August 4, 2026" description="Callback IP Whitelist Expansion and USD Wrapping Documentation Launch" tags={["USD", "Wrapping", "Whitelist", "Docs"]}>
  Two updates: the HaiPay callback IP whitelist has been expanded from 2 to 5 addresses; new USD Wrapping product documentation has been launched.

  Recent updates:

  * The callback IP whitelist has 3 new addresses, 5 in total. Please add all of them to your server whitelist to ensure callback functionality works correctly. See the [Onboarding Checklist](/docs/en/guide/onboarding_checklist) for details
  * Added [USD Wrapping](/docs/en/guide/usd_wrapping) product documentation: merchants price and settle in USD while users pay in their local currency, with HaiPay handling the currency conversion automatically
  * The documentation covers supported regions and USD payment codes, collection integration steps (`/usd/collect/apply`), exchange rate fields in async notifications, and FAQs
</Update>

<Update label="July 28, 2026" description="Egypt Payout Wallet Account Carrier Restriction" tags={["EGP", "Egypt", "PayOut", "EWALLET"]}>
  Added carrier restriction note for wallet account numbers in Egypt (EGP) payout API documentation.

  Recent updates:

  * Added carrier restriction to the `accountNo` field description in the payout apply API: wallet account phone numbers only support carriers prefixed with 010, 011, or 012
  * Updated both Chinese and English API documentation and API Reference (OpenAPI interactive docs)
</Update>

<Update label="July 27, 2026" description="Taiwan (TWD) Payout API Documentation Added" tags={["TWD", "Taiwan", "PayOut", "BankCode"]}>
  Added Taiwan (TWD) payout API documentation, supporting bank account transfer with coverage of 31 Taiwanese banks.

  Recent updates:

  * Added Taiwan (TWD) payout apply API `/twd/pay/apply`, supporting bank account (BANK\_ACCOUNT) transfers with a transaction limit of 1000-49999 TWD
  * Supports 31 Taiwanese banks, including Bank of Taiwan, Land Bank of Taiwan, Taiwan Cooperative Bank, Chunghwa Post, CTBC Bank, E.SUN Bank, Bank Sinopac, Taishin Bank, and more
  * Added payout query API and complete bank code list
  * Launched bilingual API documentation and API Reference (OpenAPI interactive docs)
</Update>

<Update label="July 22, 2026" description="Credit Card Supported Regions List" tags={["CreditCard", "ApplePay", "GooglePay"]}>
  Added a dedicated page listing all countries and regions supported by credit card, Apple Pay, and Google Pay payments, with a one-click JSON copy feature for quick integration.

  Recent updates:

  * Added the Credit Card Supported Regions page, covering 61 countries and regions
  * Provided a one-click copy button to export the full regions list as JSON for programmatic use
  * Available in both English and Chinese documentation
</Update>

<Update label="July 16, 2026" description="Added cancelUrl to collection apply APIs" tags={["Collect", "API", "OpenAPI", "Docs"]}>
  Added the `cancelUrl` field to collection apply APIs, allowing merchants to redirect users to a specified page after payment cancellation.

  Recent updates:

  * Added the `cancelUrl` request parameter to Global Cashier and regional collection apply APIs
  * `cancelUrl` specifies the redirect URL after the user cancels payment on the payment page
  * Updated both Chinese and English API Reference versioned documentation
</Update>

<Update label="July 09, 2026" description="Credit Card Integration Documentation Upgrade" tags={["Payments", "CreditCard", "Front-End Component", "Payment Link", "Subscription", "ApplePay", "GooglePay"]}>
  Released a brand-new set of credit card integration documentation with clearer integration options and improved testing support.

  Recent updates:

  * Added two integration methods: Front-End Component and Payment Link — merchants can choose the best fit for their business
  * Legacy JS SDK integration is now officially deprecated; migration to Front-End Component is recommended for a better payment experience
  * Added test card numbers for VISA / MasterCard / JCB / DINERS / DISCOVER / AMEX to facilitate integration testing
  * Simplified subscription payment documentation by removing deprecated integration methods and keeping only the recommended approach
</Update>

<Update label="July 03, 2026" description="Kenya Bank and E-Wallet Code Update" tags={["KES", "Kenya", "BankCode", "EWALLET"]}>
  Kenya (KES) bank codes and e-wallet codes have been fully upgraded to letter-based codes.

  Recent updates:

  * Kenya bank payment (BANK\_ACCOUNT) codes updated from numeric codes (e.g., 0001, 0002) to letter codes (e.g., KCB, SCB, ABK), covering 46 banks sorted alphabetically by name
  * Kenya e-wallet (EWALLET) codes updated from numeric codes (0001, 0002, 0003, 63907, 97) to letter codes: SAFARICOM, AIRTEL, EQUITEL, TK, TKe
  * Updated disbursement apply request examples to use the new letter-based bankCode values
</Update>

<Update label="July 02, 2026" description="Common API Documentation Added" tags={["Common", "API", "Docs", "OpenAPI"]}>
  Added Common API OpenAPI interactive documentation, bringing existing shared capabilities into the API Playground.

  Recent updates:

  * Added Common API OpenAPI specification (`common.openapi.json`) with full API Playground support
  * Added interactive documentation for 4 endpoints: Account Query, Payout Voucher, Voucher PDF/ZIP, and Merchant Payment Config
  * Added bilingual navigation entries under the "Common API" group in the "API Reference" tab
</Update>

<Update label="June 25, 2026" description="Custom Combined Mode Parameter & Event Update" tags={["Payments", "Component", "CreditCard", "Subscription"]}>
  New configuration parameter and event callback added to the Custom Combined Mode component.

  Recent updates:

  * Added `cardPosition` parameter to control credit card form placement, default `bottom`, options: `top`
  * Added `paymentMethodType` event callback to listen for payment method type changes
</Update>

<Update label="June 23, 2026" description="Kenya and South Africa Regional Payment Documentation Launch" tags={["KES", "ZAR", "Kenya", "SouthAfrica", "PayOut", "BankCode", "EWALLET"]}>
  Added disbursement API documentation for Kenya (KES) and South Africa (ZAR), expanding payment capabilities in the African market.

  Recent updates:

  * Added Kenya (KES) disbursement API documentation, supporting mobile payment (EWALLET) methods including M-Pesa (Safaricom), Airtel Money, Equitel, T-Kash, and Telcom Kenya, with a transaction limit of 10-999,999 KES
  * Bank payment (BANK\_ACCOUNT) for Kenya is now available, supporting 40 banks including Kenya Commercial Bank, Standard Chartered Bank, ABSA Bank Kenya, Equity Bank, and more
  * Added South Africa (ZAR) disbursement API documentation, supporting bank transfer (BANK\_ACCOUNT) methods covering 20 banks including Standard Bank, Nedbank, FNB, ABSA, and Capitec Bank, with a transaction limit of 2-1,000,000 ZAR
  * Added KES and ZAR API Reference pages and OpenAPI definition files
</Update>

<Update label="May 28, 2026" description="Custom Combined Mode Parameter Update & Deprecated Component Docs Cleanup" tags={["Payments", "Component", "Deprecation", "ApplePay", "GooglePay", "Token"]}>
  New configuration parameter added to the Custom Combined Mode component, and cleaned up documentation for deprecated payment components.

  Recent updates:

  * Added `showPayButton` parameter to Custom Combined Mode, allowing control over whether the credit card submit button is displayed. Default: `false` (hidden)
  * Removed the Apple Pay / Google Pay `token` parameter retrieval instructions (the `How to get?` link) from the Credit Card API documentation. The standalone Apple Pay / Google Pay components have been deprecated; migration to the "Custom Combined Mode" is recommended.
</Update>

<Update label="May 21, 2026" description="JS CDN Component Update" tags={["Payments"]}>
  Added Custom Combined Mode; legacy components will be deprecated soon.

  Recent updates:

  * Added "Custom Combined Mode" component (`composite-component`), supporting switching between one-time payment and subscription payment via the `mode` parameter;
  * Apple Pay / Google Pay, Credit Card are marked as "Deprecated Soon". Please migrate to "Custom Combined Mode".
</Update>

<Update label="May 14, 2026" description="Turkey Payment Method Update" tags={["TRY", "PayIn","PayOut", "BankCode"]}>
  Updated the available payment methods for TRY.

  Recent Updates:

  * Some payment methods have become unavailable due to changes in local payment regulations in Turkey. Relevant documentation has been updated accordingly.
</Update>

<Update label="May 9, 2026" description="USD Payout Method Update" tags={["USD", "PayOut", "BankCode"]}>
  Updated the USD API integration documentation.

  Recent updates:

  * Deleted additional e-wallets supported for payout
</Update>

<Update label="May 7, 2026" description="AI Skills Documentation Launch" tags={["AI", "Skills", "Integration", "Docs"]}>
  Added HaiPay AI Skills documentation, providing merchants with an AI-driven integration acceleration solution.

  Recent updates:

  * Added AI Skills for HaiPay Integration documentation (bilingual Chinese and English), introducing how to use Skills to help AI agents follow best practices for payment integration
  * Supported one-click installation of HaiPay Skills into projects via npx
  * Introduced the use of AI-assisted development platforms in HaiPay integration
  * Provided the official HaiPay Skills catalog access URL
</Update>

<Update label="May 6, 2026" description="MYR Payout Method Update" tags={["MYR", "PayOut", "BankCode"]}>
  Updated the Malaysia API integration documentation.

  Recent updates:

  * Added additional e-wallets supported for payout
</Update>

<Update label="April 28, 2026" description="Documentation and Experience Update" tags={["Refund", "USD", "API", "refundAmount"]}>
  Updated the refund API integration documentation.

  Recent updates:

  * Refunds support specifying a refund amount, allowing partial refunds.
</Update>

<Update label="April 24, 2026" description="Documentation and Experience Update" tags={["Docs", "AI", "API"]}>
  Updated the API integration documentation for Nigeria.

  Recent updates:

  * Updated bank name mappings, removed invalid bank codes, and added new bank data.
</Update>

<Update label="April 21, 2026" description="Documentation and Experience Update" tags={["Docs", "AI", "API"]}>
  The available payment methods for USD have been adjusted - ECASHAPP.

  Recent updates:

  * Adjusted the available payment method ECASHAPP for USD, with the payment type being EWALLET.
  * Modified the sample bank account for Nigeria in Africa.
</Update>

<Update label="April 18, 2026" description="Documentation and Experience Update" tags={["Docs", "AI", "API"]}>
  Added the API integration documentation for Nigeria (Africa) and updated the Singapore API integration documentation.

  Recent updates:

  * Expanded African regional support by adding API documentation and activating disbursement services for Nigeria.
  * Changed the collection payment method from E-Wallet to QR.
</Update>

<Update label="April 17, 2026" description="MCP Tool Integration" tags={["AI", "Integration", "Docs"]}>
  Added HaiPay MCP (Model Context Protocol) tool integration documentation to help merchants integrate payments more efficiently with AI assistants.

  Recent updates:

  * Added MCP tools and plugins connection guide, explaining how to connect AI assistants directly to the HaiPay knowledge base via MCP protocol
  * Provided MCP usage scenarios, including quick payment integration, API parameter lookup, and troubleshooting guidance
  * Enabled AI assistants to access HaiPay API docs, signature rules, error codes, and best practices in real time
  * Reduced integration overhead by minimizing manual documentation lookup and improving developer efficiency
</Update>

<Update label="April 16, 2026" description="Documentation and Experience Update" tags={["Docs", "AI", "API"]}>
  This combined update improves the API discovery experience and page-level AI assistance while incorporating the latest synced changes from the main branch, with a focus on clearer entry points, better AI workflows, and more readable payment documentation.

  Recent updates:

  * Added bilingual API overview pages, including `/docs/zh/api-reference/overview` and the matching English route, to help developers understand capability coverage, reading order, and core API groups before diving into endpoints
  * Redesigned the bilingual payment API documentation list pages into card-based navigation hubs so users can browse by product capability or region instead of scanning raw link lists
  * Expanded contextual AI options with experimental Kimi and GLM entries, fixed the extra prefix issue in the Qwen prompt, and adjusted the ordering of the China-focused AI options
  * Added legacy guide redirects and a `.mintignore` file to reduce broken historical links and build noise
  * Refined the RSA key-generation guidance by removing the HaiPay-hosted generator link and switching to a more general online generation reference
  * Converted the Europe payment-method page and the bilingual bank-code lists from embedded HTML tables into Markdown tables for better readability and maintainability
</Update>

<Update label="April 15, 2026" description="Documentation Update" tags={["Docs", "Navigation", "API"]}>
  Refined the HaiPay documentation experience across both Chinese and English merchant docs to make onboarding and API discovery easier.

  Recent updates:

  * Reworked the homepage and guide entry pages around the merchant integration journey, with clearer onboarding, configuration, testing, and launch paths
  * Updated site metadata, redirects, search prompt, and page descriptions to improve SEO coverage and content discoverability
  * Cleaned up API documentation lists and route links, including broken double-slash paths and related reference jumps
  * Added related endpoint recommendations across a wide set of API reference pages to improve cross-page navigation during integration
</Update>

<Update label="April 14, 2026" description="v1.0.0" tags={["Mintlify", "Migration"]}>
  HaiPay has successfully completed the full documentation migration from VuePress to Mintlify. This marks the starting point of the new documentation experience.

  Recent updates:

  * Reorganized the bilingual Chinese and English documentation structure
  * Restructured navigation around real user journeys and core entry points
  * Upgraded the merchant guide landing pages into navigation cards for faster discovery
  * Removed unrelated sample content and unified the changelog format
</Update>

## Related Topics

* [HaiPay API Reference Overview](/docs/en/api-reference/overview)
* [HaiPay Integration Steps Guide](/docs/en/guide/integration_guide)
* [HaiPay API Description and Common Rules](/docs/en/guide/api_description_guide)
