POST

📍How to choose a site? See API Endpoint Guide

OpenAPI Viewer

Request Body Parameters

application/json

Common Request Parameters

bizContent

• addressObjectOptional

  Address object.

  • countryString(2)Optional

    Two-letter country code, ISO 3166.
  • stateString(128)Optional

    State or province.
  • cityString(50)Optional

    City.
  • postalCodeString(16)Optional

    Postal code.
  • line1String(256)Optional

    Address line 1.
  • line2String(256)Optional

    Address line 2.
• requestIdString(64)Required

  Unique request ID, globally unique.
• partnerCustomerIdString(64)Required

  Merchant-side customer identifier, i.e. the user's member ID on the merchant's website. Unique within the same store.
• firstNameString(64)Optional

  First name.
• lastNameString(64)Optional

  Last name.
• companyNameString(128)Optional

  Company name.
• emailString(128)Optional

  Email address.
• phoneString(20)Optional

  Phone number.
• languageString(12)Optional

  Preferred language and locale.
• metadataString(512)Optional

  Merchant-defined custom string.

Request Body Example

{
  "clientId": "20250101123456",
  "accId": "ACC001",
  "signType": "MD5",
  "sign": "SIGN_VALUE",
  "version": "4.0",
  "bizContent": {
    "requestId": "req_20260507_0001",
    "partnerCustomerId": "USER_001",
    "firstName": "James",
    "lastName": "LeBron",
    "companyName": "Example Inc.",
    "email": "james@example.com",
    "phone": "13800138000",
    "address": {
      "country": "US",
      "state": "CA",
      "city": "San Jose",
      "postalCode": "95113",
      "line1": "101 First Street",
      "line2": "Suite 200"
    },
    "language": "en",
    "metadata": "vip-user"
  }
}

Responses Body Parameters

application/json

Common Response Parameters

bizContent

• addressObjectOptional

  Address object, same structure as the request address.

  • countryString(2)Optional

    Two-letter country code, ISO 3166.
  • stateString(128)Optional

    State or province.
  • cityString(50)Optional

    City.
  • postalCodeString(16)Optional

    Postal code.
  • line1String(256)Optional

    Address line 1.
  • line2String(256)Optional

    Address line 2.
• requestIdString(64)Required

  Unique request ID, echoed from the request.
• customerIdString(64)Required

  PingPong customer ID.
• partnerCustomerIdString(64)Required

  Merchant-side customer identifier, i.e. the user's member ID on the merchant's website. Unique within the same store.
• firstNameString(64)Optional

  First name.
• lastNameString(64)Optional

  Last name.
• companyNameString(128)Optional

  Company name.
• emailString(128)Optional

  Email address.
• phoneString(20)Optional

  Phone number.
• languageString(12)Optional

  Preferred language and locale.
• metadataString(512)Optional

  Merchant-defined custom string.
• createdAtString(10)Required

  Creation time as a 10-digit second-level timestamp string.
• updatedAtString(10)Required

  Last update time as a 10-digit second-level timestamp string.

Request Body Example

{
  "clientId": "20250101123456",
  "accId": "ACC001",
  "signType": "MD5",
  "sign": "SIGN_VALUE",
  "code": "000000",
  "description": "SUCCESS",
  "bizContent": {
    "requestId": "req_20260507_0001",
    "customerId": "CUS-260507100000000001",
    "partnerCustomerId": "USER_001",
    "firstName": "James",
    "lastName": "LeBron",
    "email": "james@example.com",
    "language": "en",
    "createdAt": "2026-05-07T00:00:00Z",
    "updatedAt": "2026-05-07T00:00:00Z"
  }
}

Previous pageOverview

Next pageUpdate Customer