API Only (Non-Hosted Mode)

About 168 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

threeDSRequestDataStringConditional
3DS verification request parameters. See 3DS Integration Guide for details
- executeThreeDStringConditional
  3DS verification execution policy:">
  Y - Enforce 3DS verification and use PingPongCheckout's 3DS
  depends - Whether to perform 3DS verification is decided by PingPongCheckout's risk control decision
  external - 3DS verification is required, but 3DS parameters are collected by the merchant and executed by PingPong. Note: This option is not applicable for the checkout
- authenticationValueStringConditional
  A unique identifier generated by the issuing bank for Visa, American Express, JCB, Diners Club, and Discover transactions after customer identity verification. The raw data is in base64 units. Needs to convert the value into the format.
- acsTransactionIdStringConditional
  A unique transaction identifier assigned by the ACS to identify an individual transaction.
- veresEnrolledStringConditional
  The result of the enrollment check. This field can contain one of the following values:">
  Y - Card is enrolled or can be enrolled; you must authenticate. Liability shift.
  N - Unregistered card; proceed with authorization. No liability shift.
  U - Unable to authenticate for any reason. No liability shift
- specificationVersionStringConditional
  This field contains the 3D Secure version used to process the transaction. For example, 1.0.2 or 2.0.0.
- directoryServerTransactionIdStringConditional
  The Directory Server Transaction ID is generated by the Mastercard Directory Server during the authentication transaction and is passed back to the merchant along with the authentication result.
- threeDSServerTransactionIdStringConditional
  A unique transaction identifier assigned by the 3DS server to identify an individual transaction.
- paresStatusStringConditional
  The original result of the authentication check. This field can contain one of the following values:">
  A - Proof of an authentication attempt has been generated.
  N - Customer authentication failed or was canceled. The transaction was declined.
  U - Authentication did not complete for any reason.
  Y - The customer was successfully authenticated.
- eciStringConditional
  For authentication, only for Visa, American Express, JCB, Diners Club, and Discover transactions, the digital e-commerce indicator (ECI) is returned. The field is missing in case of authentication failure. This field contains one of the following values:
  01 - Attempted authentication (Mastercard)
  02 - Successful authentication (Mastercard)
  05 - Successful authentication (Visa, American Express, JCB, UNION PAY, Diners Club, and Discover)
  06 - Attempted authentication (Visa, American Express, JCB, Diners Club, and Discover)
paymentMethodObjectRequired
The type and required details of the payment method to be used.
- typeString(32)Required
  Payment methods:
  scheme International credit card payment
  Local payment options, optional values: Non-Hosted Supported APMs
  Fixed input: networkToken, mandatory if using a card group's token
- scanCodeIdStringConditional
  Payment code generated by the customer's mobile wallet client. Usually displayed in the form of a barcode or QR code. The merchant terminal scans the customer's phone screen to obtain the code
- cardInfoObjectConditional
  Cardholder information, mandatory for credit card payments that do not use card binding
  - numberString(64)Required
    International credit card number
  - pinString(2)Optional
    First two digits of the local card password
  - holderFirstNameStringRequired
    Cardholder first name, character type, no special symbols
  - holderLastNameStringRequired
    Cardholder last name, character type, no special symbols
  - expireMonthString(2)Required
    Expiration month, 2 digits
  - expireYearString(4)Required
    Expiration year, 4 digits
  - cvvString(4)Required
    Credit card CVV, the CVV length for Visa/MasterCard/JCB/Discover/Diners club is 3 characters, while for American Express it may be 4 characters
  - schemeTokenValueString(255)Conditional
    Card group's token, mandatory if using a card group's token
  - paymentBrandString(24)Conditional
    Card brand, mandatory if using a card group's token, selectable values are visa/MasterCard
  - tokenCryptogramString(255)Conditional
    An encrypted numeric string used to verify transaction data between the card and the terminal. Mandatory if using a card group's token
- ibanStringOptional
  Mandatory for specific payment methods, international bank account number for payment
- ovoIdStringOptional
  Wallet ID
- customerKanjiFirstNameStringOptional
  Customer's first name, represented in Chinese characters
- customerKanjiLastNameStringOptional
  Customer's last name, represented in Chinese characters
- customerKatakanaFirstNameStringOptional
  Customer's first name, represented in Katakana
- customerKatakanaLastNameStringOptional
  Customer's last name, represented in Katakana
- companyNameStringOptional
  Company name
- applePayObjectConditional
  Mandatory when the selected payment method type is ApplePay
  - applePayTokenDataObjectConditional
    Encrypted parameters, the paymentToken returned from the applePay transaction
    versionStringRequired
    Version information, indicating the version of the encryption protocol, e.g., "EC_v1"
    dataStringRequired
    Base64 encoded encrypted data, containing the actual payment information
    signatureStringRequired
    Base64 encoded signature, used to verify the integrity and authenticity of the payment data source
    headerObjectRequired
    Contains metadata related to encryption
    ephemeralPublicKeyStringRequired
    Base64 encoded temporary public key, used for encrypting transaction information
    publicKeyHashStringRequired
    Base64 encoded public key hash, used to verify the merchant's public key
    transactionIdStringRequired
    A unique transaction identifier, used to identify the payment transaction
  - applePayTokenDecryptionDataObjectConditional
    Decryption parameters, the paymentToken returned from the applePay transaction
    cardTokenStringRequired
    applepay decrypted virtual card number - applicationPrimaryAccountNumber
    expirationDateStringRequired
    Expiration date YYMMDD - applicationExpirationDate
    cardholderNameStringOptional
    Cardholder name - cardholderName
    paymentDataTypeStringRequired
    Enumeration: EMV, 3DSecure
    paymentDataObjectRequired
    applePay transaction returned paymentToken
    onlinePaymentCryptogramStringOptional
    paymentDataType: 3DSecure - paymentData.onlinePaymentCryptogram (mandatory when paymentDataType is 3DSecure)
    eciIndicatorStringOptional
    3ds eci - paymentDataType: 3DSecure paymentData.eciIndicator (mandatory when paymentDataType is 3DSecure)
    emvDataStringOptional
    paymentDataType: emv - paymentData.emvData (mandatory when paymentDataType is emv)
    encryptedPINDataStringOptional
    paymentDataType: emv - paymentData.encryptedPINData (mandatory when paymentDataType is emv)
- googlePayObjectConditional
  Mandatory when the selected payment method type is GooglePay
  - googleEncryptTokenObjectConditional
    GooglePay obtained encrypted card information
  - googlePayTokenDecryptionDataObjectConditional
    GooglePay decrypted card information
    gatewayMerchantIdStringOptional
    gatewayMerchantId in the decrypted message body from google
    messageIdStringOptional
    messageId in the decrypted message body from google
    paymentMethodStringOptional
    paymentMethod in the decrypted message body from google
    paymentMethodDetailsObjectRequired
    paymentMethodDetails in the decrypted message body from google
    authMethodStringRequired
    authMethod in the decrypted message body from google
    expirationMonthStringRequired
    expirationMonth in the decrypted message body from google
    expirationYearStringRequired
    expirationYear in the decrypted message body from google
    panStringRequired
    pan in the decrypted message body from google
    assuranceDetailsObjectOptional
    assuranceDetails in the decrypted message body from google
    accountVerifiedStringRequired
    accountVerified in the decrypted message body from google
    cardHolderAuthenticatedStringRequired
    cardHolderAuthenticated in the decrypted message body from google
- wxOpenIdStringConditional
  Unique identifier in WeChat Open Platform
- wxAppIdStringConditional
  WeChat Mini Program ID
customerObjectConditional
Customer information. Not required for the virtual entertainment industry
- firstNameString(24)Conditional
  User's first name
- lastNameString(24)Conditional
  User's last name
- emailString(128)Conditional
  User's email
- phoneString(20)Conditional
  User's contact phone
- birthDateString(10)Conditional
  Date of birth, format YYYY-MM-DD
- identificationTypeString(20)Conditional
  User's ID document type (required for specific countries, such as Mexico)
- identificationIdString(20)Conditional
  User's ID document number (required for specific countries, such as Mexico)
- phoneCountryCodeString(20)Conditional
  Country code or international area code of the phone number (no special symbols needed)
- accountNumberStringConditional
  Bank account number
- domesticCardNumberStringConditional
  Domestic card number, example value: 9704198526191432198
- domesticCardIssuingDateStringConditional
  Domestic card issuing date, example value: 07/15
- domesticCardExpireMonthStringConditional
  Domestic card expiration month, example value: 10
- domesticCardExpireYearStringConditional
  Domestic card expiration year, example value: 25
goodsArrayRequired
Product information
- nameString(128)Required
  Product name
- descriptionString(255)Optional
  Product description
- skuString(255)Optional
  Product number, product SKU
- unitPriceString(12)Required
  Unit price of the product
- unitTaxAmountStringConditional
  Tax per item, mandatory when the total order amount includes tax
- taxRateStringOptional
  Tax rate, optional
- totalDiscountAmountStringConditional
  Total discount amount per item, mandatory when the total order amount involves discounts
- numberString(12)Required
  Quantity of the product purchased
- imgUrlString(255)Required
  Main image link of the product
- virtualProductString(1)Optional
  Whether it is a virtual product, virtual goods (Y/N)
- itemTypeString(1)Optional
  Product type, enumerated values: 1/2/3, corresponding meanings as follows:
  1, DIGITAL: Digital products
  2, PHYSICAL: Physical products
  3, SERVICE: Services
shippingAddressObjectConditional
Shipping address information, can be omitted for virtual products
- streetString(256)Required
  Recipient's street address
- postcodeString(16)Required
  Postal code
- cityString(50)Required
  Recipient's city
- stateString(128)Required
  Recipient's province, for US and Canada regions, use two-character codes, some areas without provinces can be left blank, see Country Codes for details
- countryString(64)Required
  Recipient's country, (ISO two-character code) see appendix Country Codes, mandatory for RMB withdrawal merchants
- districtStringConditional
  District/county of the recipient
- shippingFeeStringConditional
  Shipping cost
billingAddressObjectConditional
Billing information
- streetString(256)Required
  Biller's street address
- postcodeString(16)Required
  Postal code
- cityString(50)Required
  Biller's city
- stateString(128)Required
  Biller's province, for US and Canada regions, use two-character codes, some areas without provinces can be left blank
- districtStringConditional
  District/county of the biller
- countryString(64)Required
  Biller's country, (ISO two-character code) see appendix Country Codes
browserInfoObjectConditional
Browser information
- windowSizeString(64)Conditional
  Window size:">01-250x400
  02-390x400
  03-500x600
  04-600x400
  05 - Full screen
- acceptHeaderStringConditional
  HTTP response header information, example value: text/html, application/xhtml+xml, application/xml;q=0.9, image/webp, image/apng, *;q=0.8
- colorDepthString(16)Conditional
  Window color, get browser screen.colorDepth, example value: 32
- screenHeightintConditional
  Window height
- jetLagStringConditional
  Time difference in minutes between UTC and the cardholder's browser local time.
- userAgentStringConditional
  Browser user agent information, example value: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/72.0.3626.121 Safari/537.36
- screenWidthintConditional
  Screen width (unit: pixels)
- javaEnabledBooleanConditional
  Whether the cardholder's device can execute Java.
- javaScriptEnabledBooleanConditional
  Indicates whether the shopper's browser can execute JavaScript. If the field is absent, it is assumed to have the default value of true.
deviceObjectRequired
Device information, accessModel values, can be omitted
- orderTerminalString(2)Required
  01 - Mobile browser (app)
  02 - PC browser (pc)
  04 - SDK (ios)
  05 - SDK (Android)
  06 - WeChat Mini Program
  09 - QR Code
recurringInfoObjectConditional
Subscription information, currently applicable for Apple Pay subscription payments
- recurringPaymentStartDateStringRequired
  The date of the first recurring payment, which maps to Apple Pay's first payment date
- recurringPaymentIntervalUnitStringRequired
  The billing interval unit that maps to Apple Pay's calendar unit, such as day, month, or year
- recurringPaymentIntervalCountStringRequired
  The number of interval units that make up one full billing cycle
- recurringPaymentEndDateStringRequired
  The date of the final recurring payment, which maps to Apple Pay's final payment date
merchantRiskIndicatorObjectOptional
Merchant risk supplemental information object, used to provide pre-order or future-fulfillment transaction details
- preOrderPurchaseBooleanConditional
  Whether this is a pre-order or future-fulfillment transaction. Example value: true
- preOrderTypeString(64)Conditional
  Pre-order or future-fulfillment type. Required when preOrderPurchase=true. Example value: futureServiceBooking. Supported values:
  presaleBeforeRelease: Pre-sale before the official release
  madeToOrder: Production or stocking starts after the order is placed
  backorderRestock: Orders are accepted while out of stock and fulfilled after restocking
  crowdfundingFulfillment: Fulfillment happens after crowdfunding succeeds
  digitalDelayedDelivery: Digital goods or digital entitlements delivered in the future
  futureServiceBooking: Service booking to be fulfilled at a future date or time
- preOrderEstimatedDeliveryDateString(10)Conditional
  Merchant-promised estimated delivery date. Required when preOrderPurchase=true. Timestamp format, in seconds. Example value: 1683530496
captureDelayHoursintRequired
- 0 indicates immediate capture
- -1 indicates manual capture, after successfully calling the unified order API, you still need to call Pre-Authorization Capture, local payment does not support this
timeExpireString(10)Optional
Order closure time. 3 minutes to 10 days (if less than 3 minutes, it defaults to 3 minutes; if more than 10 days, it defaults to 10 days). Timestamp format, unit: seconds, example value: 1683530496
amountString(12)Required
Transaction amount, the precision is related to the currency, please refer to the appendix Transaction Currencies
currencyString(3)Required
Transaction currency, ISO 4217 three-letter code, for specific supported currencies see appendix Transaction Currencies
merchantTransactionIdString(64)Required
Merchant website order serial number, a unique identifier for the order, can be used for subsequent order inquiries and reconciliation
payResultUrlString(255)Conditional
Custom redirect URL set by the merchant; for 3DS verification, bank online transfer, or virtual wallet payments, it finally needs to redirect to the specified page address by the merchant
merchantRequestBillDescriptorString(22)Optional
Merchant-defined dynamic billing descriptor, up to 22 characters. Only English letters, digits, whitespace, and these ASCII punctuation marks are allowed: , . ( ) - / :. Chinese characters and other special characters are not allowed. Different channels may apply appropriate truncation.
bizTypeString(12)Conditional
`CardOnFile` transaction mode identifier. Pass the fixed value `CardOnFile` when the first bind-and-pay transaction needs to be processed as `CardOnFile`; if this value was passed when the token was first created, it must also be passed in subsequent repeat purchases using that token. Do not pass this parameter for regular saved-card transactions or when only verifying card details (please contact technical support to use this value)
- CardOnFile: repeat purchase transactions with the bound card
- Recurring: subsequent MIT charges for subscription/recurring billing; must be used together with `primaryMerchantTransactionId`
primaryMerchantTransactionIdString(64)Conditional
The `merchantTransactionId` of the first successfully authorized transaction. Required for subsequent MIT charges when `bizType=Recurring`, used to link back to the initial authorization
merchantUserIdString(256)Conditional
Required for CardOnFile or CodeGrant mode
- CardOnFile: Cardholder ID on the merchant's website, globally unique, used to identify the cardholder and associate stored card information
- CodeGrant: Member ID, user's member ID on the merchant's website
createTokenString(1)Conditional
Y/N, whether to create a token. This field controls whether a reusable payment credential is generated after the current payment succeeds. In Non-Hosted mode, pass `Y` when the first saved-card payment needs to generate a payment credential. Do not pass this field again when making repeat purchases with an existing token
tokenString(255)Conditional
Business credential token. Pass the corresponding token value by type
- CardOnFile: The payment credential returned after successfully saving the card; if the first transaction was processed in `CardOnFile` mode, subsequent repeat purchases using this token must also continue to pass `bizType=CardOnFile`
- CodeGrant: The business credential token obtained after signing or authorization is completed
notificationUrlString(255)Optional
A custom address set by the merchant for notifying the transaction result. Once this parameter is filled, PingPongCheckout will asynchronously push the transaction result to this address via POST.
URL recommendation: use a complete URL with a publicly reachable domain name. Standard web ports are recommended (HTTPS defaults to 443 and HTTP defaults to 80). Ensure the URL can reliably receive PingPongCheckout asynchronous notifications.
closeNotificationUrlString(255)Optional
A custom address set by the merchant for notifying the order closure result. Once this parameter is filled, PingPongCheckout will asynchronously push the order closure result to this address via POST.
URL recommendation: use a complete URL with a publicly reachable domain name. Standard web ports are recommended (HTTPS defaults to 443 and HTTP defaults to 80). Ensure the URL can reliably receive PingPongCheckout asynchronous notifications.
requestIdString(64)Required
Unique request number, globally unique
remarkString(255)Optional
Merchant's extended fields, can be used to specify certain parameters, will be returned as is in the response body
tradeCountryString(2)Required
Used to specify the country of the PingPong checkout, by default takes the countries supported by PingPong
merchantSourceString(64)Conditional
Platform identification for site-building platforms, must be passed when integrating a site-building platform. It serves to identify which site-building platform initiated the transaction (Note: Non-site-building platforms do not need to submit this parameter, if you need to pass this parameter, please contact PP technical support for confirmation)
shopperIPString(64)Required
User's IP address for placing the order, supports IPv4 format
languageString(12)Optional
Used to specify the language of the PingPong checkout, defaults to en if not provided. See the appendix Checkout Supported Language List for details
jsGeneratedDataString(256)Conditional
Card payments must integrate the risk control component. Card payments need to pass this, if acquisition fails, an empty string can be passed, without blocking the payment process. By embedding the risk control component provided by pingpong, get the browser-related json string and pass it to this parameter. Used by merchants who interface with the risk control plugin, See 3DS Integration Guide for details

Other Parameters

Request Body Example

{
  "accId": "2018092714313010016291",
  "clientId": "2018092714313010016",
  "signType": "SHA256",
  "sign": "898A3CBE981B3E2BF4E2B8D1A817D7E23EF93BC4293993EE545E36F4C87F2E79",
  "version": "1.0",
  "bizContent": {
    "timeExpire": "",
    "paymentMethod": {
      "type": "scheme"
    },
    "tradeCountry": "",
    "threeDSRequestData": {
      "executeThreeD": "",
      "authenticationValue": "",
      "acsTransactionId": "",
      "veresEnrolled": "",
      "specificationVersion": "",
      "directoryServerTransactionId": "",
      "threeDSServerTransactionId": "",
      "paresStatus": "",
      "eci": ""
    },
    "browserInfo": {
      "acceptHeader": "content-type=application/x-www-form-urlencoded;accept=*/*;cache-control=no-cache;postman-token=cf489264-5378-4d5d-a86c-72c86a408c03;accept-encoding=gzip, deflate;content-length=588;connection=keep-alive;",
      "colorDepth": "32",
      "jetLag": "480",
      "screenHeight": "1980",
      "screenWidth": "1080",
      "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_0) AppleWebKit/537.36 Chrome/72.0.3626.121 Safari/537.36",
      "windowSize": "05",
      "javaEnabled": "true",
      "javaScriptEnabled": "true"
    },
    "device": {
      "fingerprintId": "",
      "orderTerminal": "01"
    },
    "jsGeneratedData": {
      "fingerprintId": "2018092714313010016549_PP20210608151727OB",
      "forterSiteId": "e088dda90c4e",
      "forterTokenCookie": "c3402ed6f84d4c50add3458a1ce51d60_1623137756842_87_UDF43_11ck",
      "orderTerminal": "03",
      "threeDSServerTransID": ""
    },
    "shopperIP": "222.126.52.24",
    "captureDelayHours": 0,
    "language": "en",
    "airline": {
      "adultsNumber": "1",
      "aircraftCabinType": "FIRST CLASS",
      "airlineCompanyID": "CA006",
      "airlinePnr": "{dhsalh}",
      "arrivalCity": "Adm",
      "arrivalCountry": "DK",
      "arrivalTime": "201912012010",
      "arrivalTimezone": "UTC+8",
      "babyNumber": "0",
      "bestFare": "Y",
      "bookChannel": "Y",
      "changedTakeoffTime": "",
      "childrenNumber": "0",
      "connectingCity": "",
      "connectionTicket": "N",
      "contactEmail": "123456@gmail.com",
      "contactName": "James LeBron",
      "contactPhone": "3055787342",
      "flightNumber": "CA006122",
      "freeChange": "Y",
      "frequentFlyerNumber": "CA00612254651B",
      "haveChanged": "N",
      "hotel": {
        "bookNumber": "1",
        "bookRange": "2",
        "checkInDate": "201912010020",
        "city": "Adm",
        "country": "DK",
        "customerName": "James LeBron",
        "name": "AdmHotel",
        "refundPolicy": "FREE CANCELLATION",
        "star": "5"
      },
      "ifConnectingFlight": "N",
      "ifRoundtripFlight": "Y",
      "insurance": "Y",
      "leaveRange": "Y",
      "passengers": [
        {
          "birthday": "1991120",
          "firstName": "James",
          "identificationId": "331081199112012361",
          "identificationType": "ID",
          "lastName": "LeBron",
          "nationality": "US",
          "phone": "3055787342"
        }
      ],
      "productType": "TICKET",
      "routeType": "SINGLE",
      "takeoffCity": "Birmingham",
      "takeoffCountry": "US",
      "takeoffTime": "201912012010",
      "takeoffTimezone": "UTC+8",
      "thirdPartyBook": "N",
      "tripType": "SINGLE",
      "valueAdded": "N"
    },
    "amount": "100",
    "billingAddress": {
      "city": "Birmingham",
      "country": "US",
      "postcode": "35222",
      "state": "AL",
      "street": "1986 Broad Street"
    },
    "carRental": {
      "childrenNumber": "1",
      "discountAmount": "120",
      "discountType": "15%",
      "email": "t_email",
      "firstName": "James",
      "identificationId": "331081199112012361",
      "identificationType": "ID",
      "insuranceLimit": "8000",
      "insuranceType": "RS",
      "lastName": "Lebron",
      "model": "SUV",
      "nationality": "US",
      "personNumber": "3",
      "phone": "3055787342",
      "purchasedInsurance": "Y",
      "rentCity": "Birmingham",
      "rentCountry": "US",
      "rentTime": "201912200320",
      "rentalCompany": "US",
      "returnCity": "Birmingham",
      "returnCountry": "US",
      "returnTime": "201201200320"
    },
    "currency": "USD",
    "customer": {
      "email": "t_email",
      "firstName": "James",
      "lastName": "LeBron",
      "identificationId": "",
      "identificationType": "ID",
      "phone": "3055787343",
      "birthDate": ""
    },
    "eCommerce": {
      "freeShipping": "N",
      "shippingMethod": "SEA",
      "shippingFee": ""
    },
    "goods": [
      {
        "description": "short legs",
        "imgUrl": "http://pic.bizhi360.com/bpic/30/5230.jpg",
        "name": "corgi",
        "number": "1",
        "sku": "20230524001",
        "unitPrice": "22",
        "virtualProduct": "N"
      },
      {
        "description": "stupid nerd",
        "imgUrl": "http://d.paper.i4.cn/max/2016/12/08/11/1481166973148_375716.jpg",
        "name": "husky",
        "number": "1",
        "sku": "20230524002",
        "unitPrice": "22",
        "virtualProduct": "N"
      }
    ],
    "merchantTransactionId": "t_merchantno",
    "merchantUserId": "12604896051315",
    "merchantRiskIndicator": {
      "preOrderPurchase": true,
      "preOrderType": "futureServiceBooking",
      "preOrderEstimatedDeliveryDate": "1683530496"
    },
    "notificationUrl": "https://test-acquirer-payment.pingpongx.com/qa/notify",
    "payCancelUrl": "https://test-acquirerpay.pingpongx.com/qa/cancel.html",
    "payResultUrl": "https://test-acquirerpay.pingpongx.com/qa/result.html",
    "reCharge": {
      "accountId": "775330",
      "accountName": "von",
      "gameCategory": "OTHERS",
      "gameName": "Over Watched",
      "gameTerminal": "PC",
      "platformCategory": "N",
      "serverCountry": "US",
      "type": "GAME RECHARGE"
    },
    "remark": "Remark customer defined txt",
    "requestId": "t_merchantno",
    "shippingAddress": {
      "city": "Miami",
      "country": "US",
      "postcode": "33131",
      "state": "FL",
      "street": "701 Brickell Avenue, Suite 2700"
    }
  }
}

Responses Body Parameters

application/json

Common Response Parameters

bizContent

issuerInfoObjectOptional
Bank return information
- issuerResultCodeStringOptional
  Bank return code
- issuerResultMsgStringOptional
  Bank return message description
paymentMethodObjectRequired
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
actionObjectRequired
Type and required details of the payment method to be used.
- typeString(32)Required
  Local payment method · Result type:
  QR_CODE - QR code string, needs to be manually converted to a QR code
  QR_URL - Image HTTP protocol URL or base64 image
  PAYMENT_REDIRECT_URL - Redirect link
- qrCodeString(32)Optional
  Local payment method · QR code string, needs to be manually converted to a QR code
- qrUrlStringOptional
  Local payment method · May be an image HTTP protocol URL or a base64 image
- paymentRedirectUrlStringOptional
  Local payment method · Payment transaction redirect link
cardInfoObjectOptional
Payment credit card information
- cardLevelString(64)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's transaction country
- isoCountryStringRequired
  Issuing bank country
- issuringBankStringRequired
  Issuing bank
- isoCountryA2StringConditional
  Two-letter country code, compliant with ISO 3166 standard
- paymentBrandStringRequired
  Card transaction - Card brand: VISA / Mastercard / American Express / JCB / Discover
extraParamObjectConditional
Extended parameter object containing payment method specific parameters
- wxTimeStampStringOptional
  Timestamp in seconds since 1970-01-01 00:00:00, representing the current time
  📱 WeChat Mini Program: Only returned when device.orderTerminal=06 and WeChat Mini Program payment is used
- wxNonceStrString(32)Optional
  Random string, length should be 32 characters or less
  📱 WeChat Mini Program: Only returned when device.orderTerminal=06 and WeChat Mini Program payment is used
- wxPackageStringOptional
  The prepay_id parameter returned by the unified order interface, format: prepay_id=***
  📱 WeChat Mini Program: Only returned when device.orderTerminal=06 and WeChat Mini Program payment is used
- wxSignTypeStringOptional
  Signature algorithm, default is RSA
  📱 WeChat Mini Program: Only returned when device.orderTerminal=06 and WeChat Mini Program payment is used
- wxPaySignStringOptional
  Signature, refer to WeChat Pay documentation for details
  📱 WeChat Mini Program: Only returned when device.orderTerminal=06 and WeChat Mini Program payment is used
transactionIdStringRequired
PingPong transaction ID
merchantTransactionIdString(64)Required
Website transaction ID
amountString(12)Required
Transaction amount, the precision and currency depend on the specific currency. Please refer to the appendix Trading Currencies
transactionTimeString(64)Required
Time of transaction initiation, timestamp
transactionEndingTimeString(64)Required
Time when the transaction reaches its final state, timestamp
currencyString(3)Required
Transaction currency, ISO 4217 three-letter code. For supported currencies, see the attachment Trading Currencies
statusString(32)Required
Transaction status: Idempotent Status
- SUCCESS - Success
- FAILED - Failure
- PROCESSING - In progress
remarkString(255)Optional
Merchant extended field, can be used to specify certain parameters, will be returned as is in the response body
requestIdString(64)Required
Unique request number, globally unique
exchangedAmountStringOptional
Currency exchange amount
exchangedCurrencyStringOptional
Currency for exchange
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
captureDelayHoursintConditional
- 0 indicates immediate capture
- -1 indicates manual capture. After successfully calling the unified order API, you also need to call Pre-Authorization Capture. Local payments do not support this.
payResultUrlString(255)Conditional
Merchant-defined URL for receiving redirected result; for 3DS verification, bank online transfer, or virtual wallet payment methods, it finally needs to redirect to the merchant-specified page address
threeDContinueString(32)Conditional
Whether 3DS (verification processing using risk control plugin) is required:
- true: Yes
- false: No
threeDUnionParamsObjectConditional
3DS verification parameter set, when the transaction requires 3DS verification processing, pass the return value of this parameter into the specified function of the js plugin provided by PingPong (used by merchants connected via a risk control plugin)

Request Body Example

{
  "accId": "2023082916070710253541",
  "bizContent": {
    "issuerInfo": {
      "issuerResultMsg": "Approved or completed successfully",
      "issuerResultCode": "00"
    },
    "remark": "Remark customer defined txt",
    "transactionTime": "1714978654000",
    "requestId": "PMT-LUC4VOQM381714978651450",
    "merchantTransactionId": "PMT-LUC4VOQM381714978651450",
    "currency": "USD",
    "exchangedAmount": "100",
    "exchangedCurrency": "USD",
    "amount": "100.000000",
    "authenticationInfo": {
      "avsResult": "Unknown",
      "cvvResult": "Y",
      "threeDSecure": "N"
    },
    "cardInfo": {
      "firstName": "James",
      "isoCountryA2": "BE",
      "lastName": "LeBron",
      "lastFourDigits": "1002",
      "cardLevel": "",
      "paymentBrand": "MASTERCARD",
      "cardType": "CREDIT",
      "issuringBank": "",
      "firstSixDigits": "520474",
      "isoCountry": "BELGIUM"
    },
    "transactionEndingTime": "1714978655669",
    "threeDUnionParams": {
      "threeDContinue": "false"
    },
    "transactionId": "2024050650046394",
    "threeDContinue": "false",
    "paymentMethod": {
      "type": "scheme"
    },
    "captureDelayHours": 0,
    "status": "SUCCESS",
    "extraParam": {
      "wxTimeStamp": "1695182276",
      "wxNonceStr": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
      "wxPackage": "prepay_id=wx20230920123456789012345",
      "wxSignType": "RSA",
      "wxPaySign": "ABC123DEF456GHI789JKL012MNO345PQR"
    }
  },
  "clientId": "2023082916070710253",
  "code": "000000",
  "description": "Transaction succeeded",
  "sign": "EFDF7C80DAD9EBB13C29E38D7A5BD57899E7C0B7C7414A45F718240381299B56",
  "signType": "SHA256"
}

Modifications

Query API

API Only (Non-Hosted Mode)

Request Body Parameters

Request Body Example

Responses Body Parameters

Request Body Example