New Card Transaction Notification

This API is used to notify new card transactions

  • URL (Set in the management system)

  • Method: POST

  • Content-Type

    application/json

  • Headers

Key
Type
Required
Comments

authorization

string

YES

Authorization Header

  • Body

Key
Type
Required
Comments

api_key

string

YES

api key

request_id

string

YES

Unique id; the shortest is 20 characters, the longest is 64 characters

timestamp

string

YES

13-digit; Valid for plus or minus 30 seconds

sign

string

YES

sign: MD5(api_key+timestamp+secret+request_id) lowercase hex

transactions

Transaction list

object details

Key
Type
Comments

kit_number

string

The card kit_number

timestamp

number

timestamp

amount

string

Transaction amount. e.g "+10.23" "-102.32"

category

string

Transaction category.CR have positive "+" amounts.DR have negative "-" amounts Appendix I: Transaction Category Example

detail

string

Transaction detail

transaction_id

string

Unique transaction id

transaction_status

number

Transaction status. 1:approved(most transactions are approved) 2:voided(transactions that are stopped by merchants). The transaction status may change from approved to voided.

origin_type

number

Transaction type. 1: Primary transaction made on any terminal or e-commerce; 2: Subsequent transaction made(fees/tax/commission) following a primary transaction

origin_id

string

The primary transaction id that triggered the subsequent transaction

txn_date

string

Transaction date

  • Example

    {
      api_key: 'ac97c403062e94a094131aa332df6458',
      request_id: '926a1b796b574d3898b57188d100b16d',
      timestamp: '1701686571977',
      sign: '3a48beadb69702da46dbd4169197f7f6',
      transactions: [
        {
          kit_number: '2000001791317913',
          timestamp: 1701686571884,
          amount: '-114.20',
          category: 'DR FEE',
          detail: 'CLAIMS INVESTIGATION( /21222)',
          transaction_id: 'e12f59ec4a3a4f99ab982004fc05e962',
          transaction_status: 1,
          origin_type: 2,
          origin_id: 'c9e5b4fb257641bdbd632ec42647c5e6',
          txn_date: '2023-12-04'
        }
      ]
    }

    signature example:MD5(ac97c403062e94a094131aa332df64581701686571977a446b6660552582e08b043b84634e1fe926a1b796b574d3898b57188d100b16d)

  • Response

    {
      "code": 10200,
      "msg": "ok"
    }

Last updated