Skip to content

OpenAPI Overview ​

Start here to find APIs. Browse by business group, or search by API name, HTTP method, or request path.

See the Changelog for recent API documentation updates.

API URLs

Sandbox Base URL:https://sandbox-ucard-openapi.futurepay.cc

Production Base URL:https://card-openapi.futurepayapp.com

The API index and individual API pages show the full request PATH, such as /openapi/v1/cards/recharge.

The corresponding full request URL is https://sandbox-ucard-openapi.futurepay.cc/openapi/v1/cards/recharge.

Quick Lookup

Use your browser’s find function to locate an API path, such as /openapi/v1/cards/recharge. Local site search is also available.

Integration Order ​

  1. Read Signing and Authentication to understand request signing and response verification.
  2. Read Common Responses to understand the shared response envelope.
  3. Read Merchant Webhooks, configure your notification URL, and implement signature verification, event dispatch, and idempotency.
  4. Use the API index below to select an endpoint for your business scenario.

API Index ​

Health Check ​

APIMethodPath
Check Service HealthGET/openapi/v1/health

User APIs ​

APIMethodPath
Register UserPOST/openapi/v1/users/createUser
List Tenant UsersGET/openapi/v1/users/list
Upload KYC ImagePOST/openapi/v1/users/uploadKycImage
Get KYC Supplement InformationGET/openapi/v1/users/kyc/supplement/context
Submit User KYCPOST/openapi/v1/users/kyc
Get User KYC StatusGET/openapi/v1/users/kyc/status

Card APIs ​

APIMethodPath
Issue CardPOST/openapi/v1/cards/issueCard
List Available Card TypesGET/openapi/v1/cards/types
Bind CardPOST/openapi/v1/cards/bindCard
List Card Issuance OrdersGET/openapi/v1/cards/open-orders
Get Card Issuance OrderGET/openapi/v1/cards/open-orders/{cardOrderNo}
Get User Card Issuance StatusGET/openapi/v1/cards/status
Get Card DetailsGET/openapi/v1/cards
Get Card Verification ContactsGET/openapi/v1/cards/{cardId}/3ds-contact
Update Card Verification EmailPOST/openapi/v1/cards/{cardId}/3ds-contact/email
Update Card Verification PhonePOST/openapi/v1/cards/{cardId}/3ds-contact/phone
List User CardsGET/openapi/v1/cards/list
Get Sensitive Card InformationGET/openapi/v1/cards/sensitive
Get Card BalanceGET/openapi/v1/cards/balance
List Card TransactionsGET/openapi/v1/cards/transactions
Simulate Card TransactionPOST/openapi/v1/cards/transactions/simulate
Create Card Activation RequestPOST/openapi/v1/cards/activations
Lock CardPOST/openapi/v1/cards/lock
Unlock CardPOST/openapi/v1/cards/unlock
Reactivate CardPOST/openapi/v1/cards/reactivate
Report Card LostPOST/openapi/v1/cards/reportLost
Update PINPOST/openapi/v1/cards/pin
Recharge CardPOST/openapi/v1/cards/recharge

Fund APIs ​

APIMethodPath
Withdraw Card FundsPOST/openapi/v1/funds/cardWithdrawals