Marketplaces API Only (Non-Hosted Mode)

About 86 wordsLess than 1 minute

View as Markdown

2025-07-01

Caution

Card payments under API Only mode must integrate risk control components

POST

📍How to choose a site? See API Endpoint Guide

Request Body Parameters

application/json

Common Request Parameters

bizContent

threeDSRequestDataStringConditional
3DS验证请求参数。详见3DS集成指南
- executeThreeDStringConditional
  3ds验证执行策：
  Y-强制进行3ds验证，并且使用PingPongCheckout的3ds
  depends-是否进行3ds验证交由PingPongCheckout的风控决策决定
  external-需要进行3ds验证，但3ds参数有商户自行收集，交由PingPong执行。备注：此选项不适用于收银台
- authenticationValueStringConditional
  发卡行在客户身份验证后为Visa、American Express、JCB、Diners Club和Discover交易生成的唯一标识符。原始数据以base64为单位。需要将值转换为格式。
- acsTransactionIdStringConditional
  由ACS分配的唯一事务标识符，用于标识单个事务。
- veresEnrolledStringConditional
  注册检查的结果。此字段可以包含以下值之一：
  Y-卡已注册或可注册；您必须进行身份验证。责任转移。
  N-未登记卡；进行授权。责任转移。
  U-无论何种原因，都无法进行身份验证。没有责任转移
- specificationVersionStringConditional
  此字段包含用于处理事务的3D Secure版本。例如，1.0.2或2.0.0。
- directoryServerTransactionIdStringConditional
  目录服务器交易ID由万事达目录服务器在认证交易期间生成，并与认证结果一起传递回商家。
- threeDSServerTransactionIdStringConditional
  3DS服务器分配的唯一事务标识符，用于标识单个事务。
- paresStatusStringConditional
  身份验证检查的原始结果。此字段可以包含以下值之一：
  A-已生成身份验证尝试的证明。
  N-客户身份验证失败或取消。交易被拒绝。
  U-无论何种原因，身份验证都未完成。
  Y-客户已成功通过身份验证。
- eciStringConditional
  对于验证，仅为Visa、American Express、JCB返回数字电子商务指示符（ECI）Diners Club和Discover交易。身份验证失败时缺少字段。此字段包含以下值之一：
  01-尝试身份验证（万事达卡）
  02-认证成功（万事达卡）
  05-Successful authentication (Visa, American Express, JCB, UNION PAY, Diners Club, and Discover)
  06-尝试身份验证（Visa、American Express、JCB、Diners Club和Discover）
paymentMethodObjectRequired
要使用的付款方式的类型和所需的详细信息。
- typeString(32)Required
  付款方式：
  scheme 国际信用卡支付
  本地支付方式可选值：Non-Hosted支持的APM
  固定传入：networkToken，如果用卡组的token必传
- scanCodeIdStringConditional
  付款代码客户手机钱包客户端生成的支付代码。通常以条形码或QR码的形式显示。商户终端扫描客户的手机屏幕获取代码
- cardInfoObjectConditional
  持卡人信息，信用卡支付，并且不使用绑卡情况必填
  - numberString(64)Required
    国际信用卡卡号
  - pinString(2)Optional
    本地卡密码前两位
  - holderFirstNameStringRequired
    持卡人名，字符类型，不含特殊符号
  - holderLastNameStringRequired
    持卡人姓，字符类型，不含特殊符号
  - expireMonthString(2)Required
    有效期-月，2位数字
  - expireYearString(4)Required
    有效期-年，4位数字
  - cvvString(4)Required
    信用卡CVV，Visa/MasterCard/JCB/Discover/Diners club的cvv字符长度均为三位，American Express的cvv字符长度可能为四位
  - schemeTokenValueString(255)Conditional
    卡组的token，如果用卡组的token必传
  - paymentBrandString(24)Conditional
    卡品牌，如果用卡组的token必传，可选值为visa/MasterCard
  - tokenCryptogramString(255)Conditional
    加密的数值字符串，用于验证卡片和终端之间的交易数据。如果用卡组的token必传
- ibanStringOptional
  特定支付方式必传，国际银行支付账号
- ovoIdStringOptional
  钱包ID
- customerKanjiFirstNameStringOptional
  客户的名字，以汉字表示
- customerKanjiLastNameStringOptional
  客户的姓氏，以汉字表示
- customerKatakanaFirstNameStringOptional
  客户的名字，以片假名表示
- customerKatakanaLastNameStringOptional
  客户的姓氏，以片假名表示
- companyNameStringOptional
  公司名称
- applePayObjectConditional
  当选择支付方式 type 为 ApplePay 的情况下必传
  - applePayTokenDataObjectConditional
    加密参数，applePay 交易返回的 paymentToken
    versionStringRequired
    版本信息，表示加密协议的版本。例如 "EC_v1"
    dataStringRequired
    基于 Base64 编码的加密数据，包含实际的支付信息
    signatureStringRequired
    基于 Base64 编码的签名，用于验证支付数据的完整性和来源的真实性
    headerObjectRequired
    包含与加密相关的元数据
    ephemeralPublicKeyStringRequired
    基于 Base64 编码的临时公钥，用于加密交易信息
    publicKeyHashStringRequired
    基于 Base64 编码的公钥哈希，用于验证商户的公钥
    transactionIdStringRequired
    唯一的交易标识符，用于标识该支付交易
  - applePayTokenDecryptionDataObjectConditional
    解密参数，applePay 交易返回的 paymentToken
    cardTokenStringRequired
    applepay解密后的虚拟卡号-applicationPrimaryAccountNumber
    expirationDateStringRequired
    过期时间 YYMMDD-applicationExpirationDate
    cardholderNameStringOptional
    持卡人姓名-cardholderName
    paymentDataTypeStringRequired
    枚举： EMV 、 3DSecure
    paymentDataObjectRequired
    applePay 交易返回的 paymentToken
    onlinePaymentCryptogramStringOptional
    paymentDataType：3DSecure时 -paymentData.onlinePaymentCryptogram（paymentDataType：3DSecure时必填）
    eciIndicatorStringOptional
    3ds eci-- paymentDataType：3DSecure时 paymentData.eciIndicator（paymentDataType：3DSecure时必填）
    emvDataStringOptional
    paymentDataType：emv时- paymentData.emvData（paymentDataType：emv时必填）
    encryptedPINDataStringOptional
    paymentDataType：emv时- paymentData.encryptedPINData（paymentDataType：emv时必填）
- googlePayObjectConditional
  当选择支付方式 type 为 GooglePay 的情况下必传
  - googleEncryptTokenObjectConditional
    googlepay获取到的加密卡信息
  - googlePayTokenDecryptionDataObjectConditional
    googlepay解密的卡信息
    gatewayMerchantIdStringOptional
    google 解密后消息体中的gatewayMerchantId
    messageIdStringOptional
    google 解密后消息体中的messageId
    messageIdStringOptional
    google 解密后消息体中的messageId
    paymentMethodStringOptional
    google 解密后消息体中的paymentMethod
    paymentMethodDetailsObjectRequired
    google 解密后消息体中的paymentMethodDetails
    authMethodStringRequired
    google 解密后消息体中的authMethod
    expirationMonthStringRequired
    google 解密后消息体中的expirationMonth
    expirationYearStringRequired
    google 解密后消息体中的expirationYear
    panStringRequired
    google 解密后消息体中的pan
    assuranceDetailsObjectOptional
    google 解密后消息体中的assuranceDetails
    accountVerifiedStringRequired
    google 解密后消息体中的accountVerified
    cardHolderAuthenticatedStringRequired
    google 解密后消息体中的cardHolderAuthenticated
customerObjectConditional
客户信息。虚拟数娱行业非必传
- firstNameString(24)Conditional
  用户名称
- lastNameString(24)Conditional
  用户姓氏
- emailString(128)Conditional
  用户邮箱
- phoneString(20)Conditional
  用户联系电话
- birthDateString(10)Conditional
  出生日期，格式为YYYY-MM-DD
- identificationTypeString(20)Conditional
  用户身份证件类型(特定国家需要，如墨西哥)
- identificationIdString(20)Conditional
  用户身份证件号码(特定国家需要，如墨西哥)
- phoneCountryCodeString(20)Conditional
  电话号码的国家代码或国际区号（不需要加特殊符号）
shippingAddressObjectConditional
送货地址信息，虚拟商品可以不填
- streetString(256)Required
  收货人街道地址
- postcodeString(16)Required
  邮政编码
- cityString(50)Required
  收货人城市
- stateString(128)Required
  收货人省份,美国加拿大地区传二字码，部分地区没有省份可以不填，详见《国家代码》
- countryString(64)Required
  收货人国家,(ISO二字码)⻅附录《国家代码》，人⺠币提现商户必填
- districtStringConditional
  收货人所属区/县
- shippingFeeStringConditional
  运费
billingAddressObjectRequired
账单信息
- streetString(256)Required
  账单人街道地址
- postcodeString(16)Required
  邮政编码
- cityString(50)Required
  账单人城市
- stateString(128)Required
  账单人省份，美国加拿大地区传二字码，部分地区没有省份可以不填
- districtStringConditional
  账单人所属区/县
- countryString(64)Required
  账单人国家, (ISO 二字码)⻅附录《国家代码》
browserInfoObjectConditional
Browser information, required for card payments.
- windowSizeString(64)Conditional
  窗口大小： 01-250x400 02-390x400 03-500x600 04-600x400 05 - Full screen
- acceptHeaderStringConditional
  http响应头信息，示例值: text/html, application/xhtml+xml, application/xml;q=0.9, image/webp, image/apng, *;q=0.8
- colorDepthString(16)Conditional
  窗口颜色, 获取浏览器screen.colorDepth 示例值: 32
- screenHeightintConditional
  窗口高度
- jetLagStringConditional
  UTC时间和持卡人浏览器本地时间之间的时差，以分钟为单位。
- userAgentStringConditional
  浏览器用户代理信息示例值：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
  屏幕宽度（单位：像素）
- javaEnabledBooleanConditional
  持卡人终端是否能够执行Java。
- javaScriptEnabledBooleanConditional
  指示购物者的浏览器是否能够执行JavaScript。如果字段不存在，则假定为默认的 true 值。
deviceObjectRequired
设备信息，accessModel取值，可以不填
- orderTerminalString(2)Required
  01-移动端浏览器(app)
  02-PC端浏览器(pc)
  04-SDK(ios)
  05-SDK(Android)
subOrderListArrayConditional
子商户信息明细
- subMerchantIdString(64)Required
  商户平台的子商户号
- subMerchantTransactionIdString(64)Required
  子商户订单号，子订单唯一标识
- amountString(12)Required
  子订单金额
- subMerchantNameString(255)Optional
  子商户主体名称
- businessIdentityNumberString(64)Optional
  子商户营业执照编号
- subMerchantStoreUrlString(255)Required
  店铺链接
- subMerchantCountryString(64)Required
  子商户主体所属国家
- subMerchantAddressString(255)Optional
  子商户主体地址
- subMerchantMccString(4)Required
  商户经营主类目，MCC编码
- subMerchantBrandString(64)Optional
  商户经营品牌
- goodsArrayRequired
  商品信息
  - nameString(128)Required
    商品名称
  - unitPriceString(12)Required
    商品单价
  - quantityString(12)Required
    商品数量
  - imgUrlString(255)Optional
    商品主图链接
  - mccString(4)Optional
    商品类别，MCC编码
  - virtualProductString(1)Optional
    是否是虚拟产品，虚拟商品（Y/N)
captureDelayHoursintRequired
- 0表示立即capture
- -1表示手动capture，调用统一下单API成功之后还需要调用下预授权请款 ,本地支付不支持
timeExpireString(10)Optional
关单时间。3分钟到10天（低于3分钟默认取3分钟，高于10天默认取10天）时间戳格式，单位：秒，示例值：1683530496
amountString(12)Required
交易金额，精确位数和币种有关，请查询附录交易币种。根据交易合规需要，该金额需等于商品金额总和
currencyString(3)Required
交易币种，ISO 4217 三位币种，具体支持币种⻅附录交易币种
merchantTransactionIdString(64)Required
商户网站订单流水号，订单唯一标识，可用于后续订单查询和对账
payResultUrlString(255)Conditional
商户自定义接收重定向的结果URL;3DS验证，银行在线转账或虚拟钱包之类支付方式时，最后需要重定向到商户指定的⻚面地址
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)
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. Pass `null` for guest mode or if it doesn't exist
- CodeGrant: Member ID, the 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 extension field, can be used to specify specific parameters, will be returned as is in the response body
tradeCountryString(2)Optional
Used to specify the PingPong checkout counter country, defaults to the countries supported by PingPong
merchantSourceString(64)Conditional
Website platform identifier, required for website platform access. Its purpose is to identify which website platform initiated this transaction (Note: Non-website platforms do not need to send this parameter. If this parameter needs to be sent, please contact PP technical support for confirmation)
shopperIPString(64)Required
User's order IP, supports IPv4 format
languageString(12)Optional
Used to specify the PingPong checkout language, defaults to en if not passed. See appendix Supported Checkout Languages List
merchantUserIdString(256)Conditional
Member ID, the user's member ID on the merchant's website, applicable to fast payment scenarios. Can be omitted for guest users
jsGeneratedDataString(256)Conditional
卡支付必须接入风控组件, 卡支付需要传, 若获取失败，可传空字符串，不阻塞支付流程。通过嵌入pingpong提供的风控组件，获取浏览器相关信息的json字符串，传到这个参数中。使用⻛控插件对接的商户使用，详见3DS集成指南

Other Parameters

Request Body Example

{
  "accId": "2018092714313010016291",
  "clientId": "2018092714313010016",
  "signType": "SHA256",
  "sign": "898A3CBE981B3E2BF4E2B8D1A817D7E23EF93BC4293993EE545E36F4C87F2E79",
  "version": "1.0",
  "bizContent": {
    "timeExpire": "",
    "tradeCountry": "",
    "paymentMethods": [],
    "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",
    "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 result type:
  QR_CODE - QR code string, needs to be manually converted into a QR code
  QR_URL - Image HTTP protocol URL or base64 image
  PAYMENT_REDIRECT_URL - Redirect link
- qrCodeString(32)Optional
  Local payment QR code string, needs to be manually converted into a QR code
- qrUrlStringOptional
  Local payment may be an image HTTP protocol URL or base64 image
- paymentRedirectUrlStringOptional
  Local payment transaction redirect link
cardInfoObjectOptional
Credit card information for payment
- 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 iso3166 standard
- paymentBrandStringRequired
  Card transaction - card brand: VISA / Mastercard / American Express/ JCB / Discover
transactionIdStringRequired
PingPong transaction number
merchantTransactionIdString(64)Required
Website transaction number
amountString(12)Required
Transaction amount, the precision and currency type are related, please refer to the appendix Transaction Currencies
transactionTimeString(64)Required
Transaction initiation time, 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 attachment Transaction Currencies
statusString(32)Required
Transaction status: Idempotent Status
- SUCCESS - Success
- FAILED - Failed
- PROCESSING - In progress
remarkString(255)Optional
Merchant extended fields, can be used to specify specific parameters, will be returned as is in the response body
requestIdString(64)Required
Unique request number, globally unique
exchangedAmountStringOptional
Exchange amount
exchangedCurrencyStringOptional
Exchange currency
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 redirect results; 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, pass the return value of this parameter into the function specified by the PingPong provided plugin js (used by merchants using the 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"
  },
  "clientId": "2023082916070710253",
  "code": "000000",
  "description": "Transaction succeeded",
  "sign": "EFDF7C80DAD9EBB13C29E38D7A5BD57899E7C0B7C7414A45F718240381299B56",
  "signType": "SHA256"
}

MODIFY PAYMENTS

KYB API

Marketplaces API Only (Non-Hosted Mode)

Request Body Parameters

Request Body Example

Responses Body Parameters

Request Body Example