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
- Read Signing and Authentication to understand request signing and response verification.
- Read Common Responses to understand the shared response envelope.
- Read Merchant Webhooks, configure your notification URL, and implement signature verification, event dispatch, and idempotency.
- Use the API index below to select an endpoint for your business scenario.
API Index
Health Check
| API | Method | Path |
|---|---|---|
| Check Service Health | GET | /openapi/v1/health |
User APIs
| API | Method | Path |
|---|---|---|
| Register User | POST | /openapi/v1/users/createUser |
| List Tenant Users | GET | /openapi/v1/users/list |
| Upload KYC Image | POST | /openapi/v1/users/uploadKycImage |
| Submit User KYC | POST | /openapi/v1/users/kyc |
| Get User KYC Status | GET | /openapi/v1/users/kyc/status |
Card APIs
| API | Method | Path |
|---|---|---|
| Issue Card | POST | /openapi/v1/cards/issueCard |
| List Available Card Types | GET | /openapi/v1/cards/types |
| Bind Card | POST | /openapi/v1/cards/bindCard |
| List Card Issuance Orders | GET | /openapi/v1/cards/open-orders |
| Get Card Issuance Order | GET | /openapi/v1/cards/open-orders/{cardOrderNo} |
| Get User Card Issuance Status | GET | /openapi/v1/cards/status |
| Get Card Details | GET | /openapi/v1/cards |
| List User Cards | GET | /openapi/v1/cards/list |
| Get Sensitive Card Information | GET | /openapi/v1/cards/sensitive |
| Get Card Balance | GET | /openapi/v1/cards/balance |
| List Card Transactions | GET | /openapi/v1/cards/transactions |
| Create Card Activation Request | POST | /openapi/v1/cards/activations |
| Lock Card | POST | /openapi/v1/cards/lock |
| Unlock Card | POST | /openapi/v1/cards/unlock |
| Reactivate Card | POST | /openapi/v1/cards/reactivate |
| Report Card Lost | POST | /openapi/v1/cards/reportLost |
| Update PIN | POST | /openapi/v1/cards/pin |
| Recharge Card | POST | /openapi/v1/cards/recharge |
Fund APIs
| API | Method | Path |
|---|---|---|
| Withdraw Card Funds | POST | /openapi/v1/funds/cardWithdrawals |