POST

📍How to choose a site? See API Endpoint Guide

Request Body Parameters

application/json

Common Request Parameters

bizContent

• summaryObjectOptional

  Summary query parameters, required when cmdType=Summary

  • skipSettleConfirmString(3)Conditional

    Skip settlement confirmation; effectiveness depends on channel capability.
    Values: Y/N
    Default: Y
    If channel does not support password input, any value will be processed
  • printTransactionString(3)Conditional

    Y-Print; N-No print
    Values: Y/N
    Default: Y
    If channel does not support password input, any value will be processed
  • needPasswordString(3)Conditional

    Need password for settlement confirmation on POS; Y-Yes; N-No
    Values: Y/N
    Default: N
    If channel does not support password input, any value will be processed
• settlementObjectOptional

  Settlement parameters, required when cmdType=Settlement

  • skipSettleConfirmString(3)Conditional

    Skip settlement confirmation; effectiveness depends on channel capability.
    Values: Y/N
    Default: Y
    If channel does not support password input, any value will be processed
  • printTransactionString(3)Conditional

    Y-Print; N-No print
    Values: Y/N
    Default: Y
    If channel does not support password input, any value will be processed
  • needPasswordString(3)Conditional

    Need password for settlement confirmation on POS; Y-Yes; N-No
    Values: Y/N
    Default: N
    If channel does not support password input, any value will be processed
• printObjectOptional

  Print parameters, required when cmdType=PrintLast

  • printCopyOptionString(32)Conditional

    Print copy option, default: DEFAULT
• requestIdString(64)Required

  Unique request ID, globally unique for merchant
• requestTimeString(13)Required

  Merchant-side request time. Timestamp, in milliseconds
• deviceSnString(64)Required

  Device serial number, used to specify target POS machine
• deviceModelString(64)Required

  Device model, used to specify target POS machine
• cmdTypeString(32)Required

  Command type:

  1. Summary - Summary settlement
  2. Settlement - Settlement
  3. PrintLast - Print last transaction

请求报文示例

{
  "accId": "SP1234567890",
  "clientId": "P100001",
  "signType": "SHA256",
  "sign": "SIGNATURE_VALUE",
  "version": "1.0",
  "bizContent": {
    "requestId": "REQ20241101002",
    "requestTime": "1698912345678",
    "deviceSn": "POS001",
    "deviceModel": "M30",
    "cmdType": "Settlement",
    "settlement": {
      "skipSettleConfirm": "N",
      "printTransaction": "Y",
      "needPassword": "Y"
    }
  }
}

Responses Body Parameters

application/json

Common Response Parameters

bizContent

• requestIdString(64)Required

  Merchant request ID
• cmdIdString(64)Required

  Command ID
• cmdTypeString(32)Required

  Command type:

  1. Summary - Summary settlement
  2. Settlement - Settlement
  3. PrintLast - Print last transaction
• statusString(64)Required

  Command processing status:

  1. PROCESSING - Processing
  2. FAILED - Failed
  3. SUCCESS - Successful

响应报文示例

{
  "accId": "SP1234567890",
  "clientId": "P100001",
  "signType": "SHA256",
  "sign": "SIGNATURE_VALUE",
  "code": "001000",
  "description": "Successful request",
  "bizContent": {
    "requestId": "REQ20241101002",
    "cmdId": "CMD12346",
    "cmdType": "Settlement",
    "status": "PROCESSING"
  }
}

Previous pageOrder Cancel

Next pageHeartbeat API