POST

📍How to choose a site? See API Endpoint Guide

OpenAPI Viewer

Request Body Parameters

application/json

Common Request Parameters

bizContent

• merchantSubscriptionIdString(64)Conditional

  Merchant-defined unique subscription plan ID. At least one of merchantSubscriptionId, subscriptionId, or merchantTransactionId is required.
• subscriptionIdString(64)Conditional

  PingPong subscription ID. At least one query condition is required.
• merchantTransactionIdString(64)Conditional

  Merchant transaction ID for a subscription payment. At least one query condition is required.
• requestIdString(64)Required

  Merchant request ID.

Request Body Example

{
  "clientId": "2024061100000000001",
  "accId": "20240611000000000010001",
  "signType": "SHA256",
  "sign": "SIGN_VALUE",
  "version": "1.0",
  "bizContent": {
    "merchantSubscriptionId": "SUB_M_202606110001",
    "subscriptionId": "PP_SUB_001",
    "merchantTransactionId": "SUB_M_202606110001_1",
    "requestId": "REQ_SUB_PAYMENT_QUERY_001"
  }
}

Responses Body Parameters

application/json

Common Response Parameters

bizContent

• paymentRecordsArrayOptional

  Subscription payment record list.

  • periodIntegerRequired

    Subscription period number.
  • merchantTransactionIdString(64)Required

    Merchant transaction ID.
  • transactionIdString(64)Required

    PingPong transaction ID.
  • requestIdString(64)Required

    Original payment request ID.
  • amountString(12)Required

    Payment amount.
  • originalAmountString(12)Conditional

    Original amount due before applying a subscription discount. Returned in subscription discount scenarios.
  • discountAmountString(12)Conditional

    Discount amount actually applied in the current subscription discount scenario.
  • discountAppliedBooleanConditional

    Whether a discount was actually applied to the current payment in a subscription discount scenario.
  • currencyString(3)Required

    Payment currency.
  • statusString(32)Required

    Payment status.
  • transactionTimeString(10)Required

    Transaction initiation time.
  • transactionEndingTimeString(10)Optional

    Transaction final-state time.
  • paymentMethodObjectOptional

    Payment method details.

    • typeStringOptional

      Payment method type.
    • cardInfoObjectOptional

      Masked card details.

      • firstNameStringOptional

        Cardholder first name.
      • lastNameStringOptional

        Cardholder last name.
      • firstSixDigitsStringOptional

        First six digits.
      • lastFourDigitsStringOptional

        Last four digits.
      • countryCodeStringOptional

        Country code.
      • brandStringOptional

        Card brand.
• merchantSubscriptionIdString(64)Required

  Merchant-defined unique subscription plan ID.
• subscriptionIdString(64)Required

  PingPong subscription ID.
• requestIdString(64)Required

  Merchant request ID.
• resultCodeStringRequired

  Business result code.
• resultMessageStringRequired

  Business result message.

Request Body Example

{
  "clientId": "2025050971820281024",
  "accId": "2025050971820281024001",
  "signType": "MD5",
  "sign": "SIGN_VALUE",
  "version": "1.0",
  "bizContent": {
    "merchantSubscriptionId": "SUB_MER_001",
    "subscriptionId": "SUB-1234567890abcdef",
    "requestId": "REQ_SUB_PAYMENT_QUERY_001",
    "paymentRecords": [
      {
        "period": 1,
        "merchantTransactionId": "SUB-1234567890abcdef_P1",
        "transactionId": "PAY-ORDER-1234567890",
        "requestId": "SPAY-1234567890",
        "amount": "9.99",
        "originalAmount": "10.99",
        "discountAmount": "1.00",
        "discountApplied": true,
        "currency": "USD",
        "status": "SUCCESS",
        "transactionTime": "1785152760",
        "transactionEndingTime": "1785152860",
        "paymentMethod": {
          "type": "CARD",
          "cardInfo": {
            "firstName": "James",
            "lastName": "Lebron",
            "firstSixDigits": "411111",
            "lastFourDigits": "1111",
            "countryCode": "US",
            "brand": "VISA"
          }
        }
      }
    ],
    "resultCode": "000000",
    "resultMessage": "SUCCESS"
  },
  "code": "000000",
  "description": "SUCCESS"
}

Previous pageQuery Subscription

Next pageOverview