Skip to content

Changelog ​

2026-11-13 ​

  • Restructure V2 Get User Card Overview as shared fund account → card account limits → product → card. Individual cards directly carry balance and limit query results.
  • Replace the overview's former top-level sharedCardGroups and cardAccounts; overview limits no longer repeat the evidence card or account identifiers. Trial overview integrations must update their response paths.
  • Retain cards when a balance or limit query fails and never replace unknown amounts with zero. Existing list, details, balance, and standalone account limit contracts remain unchanged.

2026-11-10 ​

  • Add V2 Get User Card Overview: GET /openapi/v2/cards/overview, returning all held cards, shared fund accounts, individual card balances, and card account limits, with account associations and partial query failures documented.
  • Add V2 Get Card Account Limits: GET /openapi/v2/cards/account-limits, including limit fields, account types, nullable amounts, and the distinction between limits and fund balances.
  • Update Chinese and English endpoint pages, V2 indexes, and sidebars. Existing card list, card details, and balance API contracts remain unchanged.

2026-11-04 16:54 CST +0800 ​

  • Document V1/V2 Get KYC Supplement Information: GET /openapi/v1/users/kyc/supplement/context and GET /openapi/v2/users/kyc/supplement/context, including eligibility, original details, and locked fields.
  • Document supplement submission through the existing KYC endpoint, with required requestNo, originalRecordNo, and expectedVersion, complete request/response examples, and rules for reusing the original fee versus starting a new application after failure.

2026-10-30 10:00 CST +0800 ​

  • Adds support for the Mastercard Global USD virtual card, retains existing Mastercard Hong Kong USD card capabilities, and provides independent V2 API paths and a documentation version entry.

  • Requires memberId for KYC submission and verifies that the member exists in the current tenant and matches email. KYC status queries require only email and cardTypeId.

  • Clarifies product-specific KYC documentation and card issuance device information requirements, including support for permanently valid identity documents.

  • Card product queries expose user eligibility. Transaction simulation adds optional merchant context fields.

  • Adds a transaction-process query API covering authorization, posting, voiding, related refunds, and fee processing records.

  • Add card verification email update endpoints: POST /openapi/v1/cards/{cardId}/3ds-contact/email and POST /openapi/v2/cards/{cardId}/3ds-contact/email. Submissions are idempotent; acceptance does not mean the update is effective. Use Get Card Verification Contacts to check masked contacts and operation status.

  • Add card verification phone update endpoints: POST /openapi/v1/cards/{cardId}/3ds-contact/phone and POST /openapi/v2/cards/{cardId}/3ds-contact/phone. Submit the country calling code and phone number separately. Submissions are idempotent; acceptance does not mean the update is effective. Use Get Card Verification Contacts to check masked contacts and operation status.

  • Complete KYC submissionStatus, V1 channelStatus, NOT_SUBMITTED, and V2 query-only channelKycStatuses. Clarify aggregate versus per-channel approval.

  • Add accountPrincipalAmount and accountCurrency to V1/V2 transaction responses; keep original amount, account principal and actual debit distinct.

2026-09-22 23:45 CST +0800 ​

  • Card transaction queries and consumption webhooks use the same amount definitions: amount is the purchase principal excluding fees; the new chargedAmount is the total actual debit, including principal and charged provider, platform, and tenant fees, or null when debit facts are incomplete.
  • totalFee is the sum of platform and tenant additional fee order amounts. It excludes provider fees and does not imply successful charging. It is zero when no additional fee orders exist, or null when order amounts are missing or currencies cannot be reconciled. Do not use amount + totalFee in place of the actual debit.
  • Fee orders add chargeStatus to report the debit result independently. Clarified prevention of double counting, 1:1 USD/USDT normalization, and the distinction between webhook event snapshots and the latest query state. Historical events may omit chargedAmount; a missing value must not be treated as zero.
  • Added English documentation and language switching between corresponding pages. The home page selects Chinese or English using a saved language choice or browser language preferences.

2026-08-18 21:37 CST +0800 ​

  • Synchronized fields, enums, constraints, and status descriptions for all 25 current APIs with sandbox OpenAPI 5.6.1.
  • Added subStatus and cardAccountId to KYC responses and clarified the five allowed annualIncome ranges.
  • Added fpCardAccountId and per-account, per-asset balance structures to card balance responses, retaining documentation for single-asset compatibility fields.
  • Corrected user, KYC, card, transaction, recharge, and activation status values, as well as the health check's string response.

2026-08-05 12:20 CST +0800 ​

  • Card transaction responses now use countryCode for the purchase country or region, and include nullable merchantName and merchantCategoryCode fields.
  • Added a dedicated merchant webhook guide covering console configuration, signatures, event payloads, eventNo idempotency, delivery retries, and legacy event compatibility.

2026-08-04 19:44 CST +0800 ​

  • Merchant webhook payloads upgraded to schemaVersion: 2. eventType identifies only the CARD_OPENING, CARD_RECHARGE, CARD_WITHDRAWAL, CARD_CONSUMPTION, or CARD_MONTHLY business scenario; status expresses the result.
  • Replays of historical PENDING/DEAD events preserve their original request bodies. Receivers must still support legacy status-based eventType values and the legacy card withdrawal format.

2026-08-03 19:13 CST +0800 ​

  • Added stable eventNo values to merchant webhook payloads and clarified at-least-once delivery. Retries and manual replays preserve the event number and request body.
  • Added X-FP-Timestamp, X-FP-Api-Key, X-FP-Signature, and X-FP-Body-Hash platform signature headers to merchant webhook requests.

2026-08-03 18:30 CST +0800 ​

  • Added cardStatus to card activation request responses, returning the actual card status from the provider's activation result.

2026-08-03 14:27 CST +0800 ​

  • Clarified that card details and user card list APIs return pending-activation, active, locked, lost, or inactive, and standardized merchant-facing status descriptions.

2026-08-01 18:28 CST +0800 ​

  • The user card list API supports querying by either email or memberId. Queries by memberId still return all cards associated with the user.
  • Added memberId to every card transaction response, returning the platform member ID.
  • Removed accountId and cardAccountId from registration responses because they are no longer returned.

2026-08-01 14:27 CST +0800 ​

  • Added memberId, dailyLimit, singleTransactionLimit, availableLimit, cardLimit, and cardEmail to the shared card response for card details, user card lists, user card issuance status, and card binding. Additional detail fields are empty when no data is available.
  • Corrected card status descriptions to reflect actual API return values rather than a fixed status enum.

2026-08-01 11:42 CST +0800 ​

  • Added nullable cardTypeId to card responses for card details, user card lists, user card issuance status, and card binding.

2026-07-31 14:54 CST +0800 ​

  • Removed invalid algorithm, iv, authTag, and ciphertext fields from the sensitive card information response, retaining only the card ID, card number, CVV, and expiry information.

2026-07-31 14:47 CST +0800 ​

  • Added card status descriptions to user card issuance status, card details, and user card list APIs.

2026-07-30 18:38 CST +0800 ​

  • Standardized sensitive card information, balance, transactions, lock, unlock, reactivate, report lost, and PIN update APIs on cardId; the legacy cardNo request parameter is no longer supported.
  • Standardized required-field and length validation messages for cardId in card activation requests to use the field name cardId.
  • Card binding continues to use the full cardNo as a card verification credential.

2026-07-29 15:36 CST +0800 ​

Corrected documentation request paths and shared guidance:

  • Added pageSize and total to the common pagination structure.
  • Clarified the relationship between the sandbox Base URL, full request paths, and the signing PATH to avoid prepending /openapi twice.
  • Clarified that the health check API still requires OpenAPI request signing.
  • Removed outdated group headings left in individual API pages.

2026-07-28 11:45 CST +0800 ​

Synchronized user registration documentation with the current implementation:

  • Added required externalId to POST /openapi/v1/users/createUser request parameters.
  • Corrected externalUserId to the currently returned memberId in POST /openapi/v1/users/createUser responses.
  • Added externalId to request parameters and list responses for GET /openapi/v1/users/list.

2026-07-27 17:37 CST +0800 ​

Synchronized OpenAPI documentation with the current APIs:

  • Added documentation for paginated tenant user queries at GET /openapi/v1/users/list.
  • Added links to paginated user queries in the OpenAPI overview and sidebar.
  • Removed filter options, card binding entry fields, and sorting/tag fields no longer returned by the available card types API.
  • Completed provider transaction information, merchant region, and fee order fields in card transaction responses.

2026-07-24 16:04 CST +0800 ​

Expanded status field documentation:

  • Clarified platform order status values for card issuance orders, card recharges, and card withdrawals.
  • Clarified card, KYC, activation, and transaction status values.
  • Standardized caller-facing status descriptions.

2026-07-24 14:27 CST +0800 ​

Expanded credential generation and configuration guidance:

  • Added OpenSSL commands for generating apiKey and merchantPrivateKey.
  • Clarified that merchants must securely manage merchantPrivateKey themselves.
  • Clarified that adding apiKey on the API Credentials page in the FuturePay merchant console returns futurePayPublicKey / FPAPIKey.

2026-07-23 17:54 CST +0800 ​

Corrected discrepancies between OpenAPI documentation and API code:

  • Corrected the card binding path from /openapi/v1/users/bindCard to /openapi/v1/cards/bindCard.
  • Moved card binding to the Card APIs group.
  • Added expiryMonth, expiryYear, and cvv to card binding parameters.
  • Corrected the cardNo description: at most 32 characters, allowing only digits, spaces, and hyphens.
  • Corrected the card activation request field from cardNo to cardId.