1. Notification
VM_API
English
  • 简体中文
  • English
  • Integration Guide
  • Environment Configuration
  • Global Error Codes
  • Transaction Type Description
  • Card Status Description
  • VM Card operation V1 (only for accounts with a merchant public key configured before 2026-10-30)
    • Webhook Signature Verification
    • Get Account Balance
      POST
    • Get Card Product Code
      POST
    • Apply for Card
      POST
    • Card Details
      POST
    • Modify Card Limit(For credit line cards only)
      POST
    • Freeze/Unfreeze Card
      POST
    • Card Top-up(For prepaid cards only)
      POST
    • Card Refund(For prepaid cards only)
      POST
    • Transaction Records
      POST
    • Delete Card
      POST
    • Card List
      POST
    • Card Flow
      POST
  • VM Card operation V2 (available to all accounts, recommended)
    • Get Account Balance
      POST
    • Get Card Product Code
      POST
    • Apply for Card
      POST
    • Card Details
      POST
    • Modify Card Limit(For credit line cards only)
      POST
    • Freeze/Unfreeze Card
      POST
    • Card Top-up(For prepaid cards only)
      POST
    • Card Refund(For prepaid cards only)
      POST
    • Transaction Records
      POST
    • Delete Card
      POST
    • Card List
      POST
    • Card Flow
      POST
  • Notification
    • WebHook
    • Card 3DS Notification
  • Change Log
    • Change Log
  • FAQ
    • FAQ
  • Get accessToken
    GET
  • 数据模型
    • 示例数据模型
      • Pet
      • Category
      • Tag
  1. Notification

WebHook

Brief Description#
Function Description: When webhook notification is enabled, card transaction data is pushed to you via webhook.
How to Set Up: For accounts with API access, go to the user console Personal Center -- Developer menu, find the webhook URL setting at the bottom of the page and save it. After that, card transaction data will be pushed to the webhook URL in real time.
Security Verification: Each push carries a signature in the X-VM-SIGN request header. Please verify it according to Webhook Signature Verification before processing. The same applies to v1 and v2 users.
Request Method#
POST
Parameters#
ParameterTypeDescription
auth_idstringTransaction ID
card_idstringCard ID (card_id will be deprecated; vm_card_id is recommended)
vm_card_idstringVM card ID
auth_timestringAuthorization time
auth_amountdoubleAuthorized amount
auth_currencystringAuthorization currency
settle_amountdoubleSettlement amount
settle_currencystringSettlement currency
statusstringTransaction status
typestringTransaction type
merchant_namestringMerchant name
create_timestringCreation time
descriptionstringTransaction details (failure info)
Request Example#
{
    "auth_id": "545645*****",
    "card_id": "card4156132878******",
    "vm_card_id": "v4Qg*************HHSfg",
    "auth_time": "2024-12-03 15:55:20",
    "auth_amount": 0.32,
    "auth_currency": "USD",
    "settle_amount": 0.32,
    "settle_currency": "USD",
    "status": "COMPLETE",
    "type": "Authorization",
    "merchant_name": "FACEBK *WJJQCG4BC2    ",
    "create_time": "",
    "description": ""
}
Response Example Explanation (To confirm successful receipt, a response must be returned; if no response is received, the webhook will retry sending up to three times by default.)#
{
   "code":0,
   "msg":"ok"
}
Remarks#
For more error codes, please refer to the error code descriptions on the homepage.
修改于 2026-11-04 08:31:57
上一页
Card Flow
下一页
Card 3DS Notification
Built with