Skip to main content

API Overview

All APIs use the POST method and define the following request headers in the file. The signature generation method and signing rules are subject to the agreement with the integration party; this document provides field names and types only.

Request HeadersTypeDescription
X-API-KeystringApplication access identifier
X-TimestampintegerRequest timestamp
X-NoncestringRequest nonce
X-SignaturestringRequest signature
Content-Typestringapplication/json

The file does not define unified securitySchemes or servers configurations. Therefore, this document describes only the request headers actually declared by each API and does not infer any additional authentication flow.

API List​

ModuleMethodAPI PathDescription
Primary AccountPOST/abc/v1/account/detailGet Primary Account Details
Primary AccountPOST/abc/v1/account/transferPrimary Account Management: Account Transfer
Primary AccountPOST/abc/v1/account/recharge-addressGet Recharge Address
Primary AccountPOST/abc/v1/account/flow/queryQuery Primary Account Fund Flows
Primary AccountPOST/abc/v1/account/recharge/queryQuery Recharge Details
Sub AccountPOST/abc/v1/sub-account/createCreate Sub Account
Sub AccountPOST/abc/v1/sub-account/queryQuery Sub Accounts
Sub AccountPOST/abc/v1/sub-account/detailSub Account Details
Sub AccountPOST/abc/v1/sub-account/update-statusEnable or Disable Sub Account
Sub AccountPOST/abc/v1/sub-account/update-nameUpdate Sub Account Name
Sub AccountPOST/abc/v1/sub-account/flow/queryQuery Sub Account Fund Flows
Sub AccountPOST/abc/v1/sub-account/switch-providerSwitch Sub Account Card Provider
BudgetPOST/abc/v1/budget/createCreate Budget
BudgetPOST/abc/v1/budget/queryQuery Budget List
BudgetPOST/abc/v1/budget/updateAdjust Budget Limit
BudgetPOST/abc/v1/budget/detailBudget Details
Card ManagementPOST/abc/v1/card/createCreate a Single Virtual Card Synchronously (Card Information Returned Synchronously)
Card ManagementPOST/abc/v1/card/queryQuery Card List
Card ManagementPOST/abc/v1/card/editUpdate Card (Name / Type / Limit)
Card ManagementPOST/abc/v1/card/update-statusUpdate Virtual Card Status (Enable / Disable)
Card ManagementPOST/abc/v1/card/detailGet Card Details
Card ManagementPOST/abc/v1/card/cancelCard Management: Delete Card
Card ManagementPOST/abc/v1/card/bin/queryQuery Card BIN
TransactionPOST/abc/v1/transaction/queryQuery Card Transaction Flows (Paginated)
TransactionPOST/abc/v1/transaction/detailGet a Single Transaction Details by Transaction Number
TransactionPOST/abc/v1/3ds-challenge/challengeSubmit a 3DS Challenge Decision (Check the Status Before Submitting)
WebhookPOST/open-api/v1/webhook/registerCreate Webhook
WebhookPOST/open-api/v1/webhook/queryQuery Webhook Configuration (Signing Secret Masked)
WebhookPOST/open-api/v1/webhook/disabledisable Webhook
WebhookPOST/abc/v1/webhook/registerCreate Webhook
WebhookPOST/abc/v1/webhook/queryQuery Webhook Configuration (Signing Secret Masked)
WebhookPOST/abc/v1/webhook/disabledisable Webhook