Transaction Query

About 140 wordsLess than 1 minute

View as Markdown

2025-03-07

POST

📍How to choose a site? See API Endpoint Guide

Request Body Parameters

application/json

Common Request Parameters

bizContent

requestIdStringOptional
Payment request serial number; derived from the transaction asynchronous notification, it is the requestId in the parameters of the order and payment interface request; its purpose is to query the transaction information corresponding to that requestId
transactionIdStringConditional
PingPong transaction serial number, at least one of which must be provided with merchantTransactionId
merchantTransactionIdStringConditional
Merchant website transaction serial number, at least one of which must be provided with transactionId

Request Body Example

{
  "accId": "2018092714313010016291",
  "clientId": "2018092714313010016",
  "signType": "SHA256",
  "sign": "898A3CBE981B3E2BF4E2B8D1A817D7E23EF93BC4293993EE545E36F4C87F2E79",
  "version": "1.0",
  "bizContent": {
    "transactionId": "2023070750000647"
  }
}

Responses Body Parameters

application/json

Common Response Parameters

bizContent

issuerInfoObjectOptional
Bank return message
- issuerResultCodeStringOptional
  Bank return code
- issuerResultMsgStringOptional
  Bank return message description
- issuerNameStringConditional
  Issuer name. Returned only after a successful Qris payment, depending on channel capability
paymentMethodObjectOptional
The type and required details of the payment method to be used.
- typeString(32)Required
  Payment method:
  scheme International credit card payment
  Local payment options: Non-Hosted Supported APMs
- subTypeString(32)Optional
  Klarna order corresponding product type:
  Pay Now
  Pay in Part
cardInfoObjectOptional
Credit card information for payment
- cardLevelString(32)Required
  Card transaction - card level
- cardTypeStringRequired
  Card transaction - card type, enumeration values:
  DEBIT
  CREDIT
  CHARGE
  CARD
- firstNameStringRequired
  Cardholder name, character type, no special symbols
- lastNameStringRequired
  Cardholder surname, character type, no special symbols
- firstSixDigitsString(12)Required
  First 6 digits of the card number
- lastFourDigitsString(12)Required
  Last 4 digits of the card number
- ipCountryString(4)Required
  User transaction country
- isoCountryStringRequired
  Issuing bank country
- issuringBankStringRequired
  Issuing bank
- isoCountryA2StringConditional
  Two-letter country code, compliant with iso3166 standard
- paymentBrandStringRequired
  Card transaction - card brand: VISA / Mastercard / American Express / JCB / Discover
threeDSInfoObjectOptional
3ds parameters
- cavvStringOptional
  cavv
- authenticationResultStringOptional
  3DS verification result, enumeration values as follows:
  Y: Verification passed
  A: Cardholder did not participate, but a record of the attempt to authenticate has been logged
  N: Verification failed
- liabilityShiftStringOptional
  Liability shift
- eciStringOptional
  Only returned for Visa, American Express, ICB, Diners Club, and Discover transactions. This field is empty when authentication fails. It contains one of the following values:
  01: Attempted authentication (Mastercard) 01:
  02: Successful authentication (Mastercard)
  05: Successful authentication (Visa, American Express, JCB, Diners Club, and Discover)
  06: Attempted authentication (Visa, American Express, JCB, Diners Club, and Discover)
- authentication3DSecureStringRequired
  threeDSServerTransactionId / directoryServerTransactionId is not empty
- specificationVersionStringRequired
  3DS version
authenticationInfoObjectOptional
Authentication information
- avsResultStringOptional
  Enumeration values as follows:
  Y（AVS full match）
  A（AVS street address only）
  Z（AVS postal/zip code only）
  N（AVS nonmatch）
  R（AVS indeterminate outcome (retry)）
  U（AVS unable to verify）
- cvvResultStringOptional
  CVV verification result, Y/N.
- threeDSecureStringOptional
  Whether 3DS verification was performed, Y/N
transactionIdStringRequired
PingPong transaction number
merchantTransactionIdString(64)Required
Website transaction number
captureDelayHoursintConditional
- 0 indicates immediate capture
- -1 indicates manual capture, after successfully calling the unified order API, you also need to call Pre-Authorization Capture, not supported for local payments
currencyString(3)Required
Transaction currency, ISO 4217 three-letter code, see the attachment for specific supported currencies Transaction Currencies
amountString(12)Required
Transaction amount, the precision is related to the currency, please check the appendix Transaction Currencies
transactionTimeString(64)Required
Transaction initiation time, timestamp
transactionEndingTimeString(64)Required
Time when the transaction reaches its final state, timestamp
statusString(32)Required
Transaction status: Idempotent State
- INIT - Initial State
- PROCESSING - In Progress
- SUCCESS - Success
- FAILED - Failure
- AUTH_SUCCESS - Authorization Success
- CANCEL - Authorization Cancelled/Manual Review Rejected
- CLOSED - Order Closed
remarkString(255)Optional
Merchant extended field, can be used to specify certain parameters, will be returned as is in the response body
payResultUrlString(255)Conditional
Merchant-defined URL for receiving redirection results; for 3DS verification, bank online transfer or virtual wallet payment methods, finally needs to redirect to the merchant-specified page address
tokenString(64)Conditional
The payment credential returned after successfully saving the card, which can be used for subsequent token-based payment scenarios. If the first transaction was processed in `CardOnFile` mode, subsequent payments using this token must also continue to pass `bizType=CardOnFile`. See Saved Cards and CardOnFile Overview
threeDContinueString(32)Conditional
Whether 3DS is needed (for merchants using risk control plugins):
- true: Yes
- false: No
threeDUnionParamsObjectConditional
3DS verification parameter set, when the transaction requires 3DS verification, pass the return value of this parameter into the function specified by the js plugin provided by PingPong (for merchants using risk control plugins)
exchangedAmountStringOptional
Exchange amount
exchangedCurrencyStringOptional
Exchange currency
payerNameString(100)Conditional
Payer name. Whether it is returned is determined by the issuer
requestIdString(64)Required
Unique request number, globally unique
resultCodeString(6)Conditional
Status result code
resultDescriptionString(500)Conditional
Status result description

Request Body Example

{
  "accId": "2023060217493010231446",
  "bizContent": {
    "issuerInfo": {
      "issuerResultMsg": "Successful approval/completion or V .I.P .PIN\n verification is successful",
      "issuerResultCode": "00"
    },
    "threeDSecure": "",
    "resultCode": "000000",
    "transactionTime": "1693290395000",
    "requestId": "PMT-QNS10ZZ7O91693290394921",
    "merchantTransactionId": "PMT-QNS10ZZ7O91693290394921",
    "currency": "USD",
    "resultDescription": "Transaction succeeded",
    "amount": "200.000000",
    "authenticationInfo": {
      "avsResult": "Unknown",
      "cvvResult": "Y",
      "threeDSecure": "N"
    },
    "cardInfo": {
      "firstName": "James",
      "isoCountryA2": "RU",
      "lastName": "LeBron",
      "lastFourDigits": "1112",
      "cardLevel": "CLASSIC",
      "paymentBrand": "VISA",
      "cardType": "CREDIT",
      "issuringBank": "",
      "ipCountry": "HK",
      "firstSixDigits": "401200",
      "isoCountry": "RUSSIAN FEDERATION"
    },
    "transactionId": "2023082950003030",
    "token": "h3cov3regCvMuuQWbY",
    "captureDelayHours": 0,
    "status": "SUCCESS"
  },
  "clientId": "2023060217493010231",
  "code": "001000",
  "description": "Successful request",
  "sign": "940E744960C32C1040F831FEFD87258EEAD257784861E8EC8860489162AAD3E3",
  "signType": "SHA256"
}

Modifications

Query API

Transaction Query

Request Body Parameters

Request Body Example

Responses Body Parameters

Request Body Example