API Reference
中文

OrderPayment

Event Type: order_payment

  • order_id[* String]: Order ID
  • payment[* Object Payment]: Payment Information
    • payment_id[* String]: Payment Serial Number
    • method[* String]: Payment Method, enumeration
      • card
      • ewallet
      • bank_transfer
      • cash_on_delivery
      • bnpl
      • other
    • channel[* String]: Payment Channel, example: worldpay、credorax、airwallex、apple_pay、checkout、ebanx、adyen、stripe、paypal、pacypay、alipay、wechat_pay、other
    • amount[* Object Amount]: Payment Amount
      • currency[* String]: Local Currency Type, 3-letter code according to ISO 4217
      • amount_local[* Double]: Amount ( Local Currency )
      • amount_usd[Double]: Amount ( USD ), The USD amount is converted from the original amount by the exchange rate, (required when not access to China Server)
      • amount_cny[Double]: Amount ( CNY ), The CNY amount is converted from the original amount by the exchange rate, (required when accessing a China Server)
    • card[Object Card]: Payment Card, required when paying by card
      • card_bin[* String]: Card Bin
      • last_four_digits[* String]: Last Four Digits of the Card Number
      • card_number_length[* Integer]: Card Number Length
      • holder_name[Object Name]: Cardholder Name
        • first_name[String]: First Name
        • middle_name[String]: Middle Name
        • last_name[String]: Last Name
        • nickname[String]: Nickname
      • debit_or_credit[String]: Card Type, enumeration
        • debit
        • credit
      • issuer_region[String]: Issuer Region, 2-letter country code according to ISO 3166
      • expiration_date[String]: Expiration Date, format: YYYY-MM, example: 1998-01
    • is_coupon_used[Boolean]: Coupons Used or not, enumeration
      • true
      • false
    • coupons[Array Coupon]: List of Coupons Used
      • coupon_id[* String]: Coupon ID
      • coupon_name[* String]: Coupon Name
      • coupon_count[* Integer]: Coupon Count
      • begin_time[* Long]: Begin Time, timestamp (milliseconds), UTC, Jan 1, 1970
      • expire_time[* Long]: Expire Time, timestamp (milliseconds), UTC, Jan 1, 1970
      • coupon_type[String]: Coupon Type, enumeration
        • fixed_discount
        • discount
        • threshold
        • other
      • coupon_rate[Double]: Coupon Discount Rate, Range: 0 - 1.00, example: 90% off: 0.9
      • coupon_threshold[String]: Coupon Threshold
      • cash_back_amount[Object Amount]: Cash_back Amount
        • currency[* String]: Local Currency Type, 3-letter code according to ISO 4217
        • amount_local[* Double]: Amount ( Local Currency )
        • amount_usd[Double]: Amount ( USD ), The USD amount is converted from the original amount by the exchange rate, (required when not access to China Server)
        • amount_cny[Double]: Amount ( CNY ), The CNY amount is converted from the original amount by the exchange rate, (required when accessing a China Server)
  • billing[Object Billing]: Billing Information
    • address[* Object Address]: Billing Address
      • country[* String]: Country, 2-letter country code according to ISO 3166
      • region[* String]: Region
      • city[* String]: City
      • district[String]: District
      • detail[String]: Detailed Address
      • zip_code[String]: Zip Code
    • phone[* Object Phone]: Billing Phone
      • country_code[* Integer]: Country Code, Compliant with ITU E.164 standard, without '+ sign', without prefix 0, example: 86
      • phone_number[* String]: Phone Number, without '+ sign'
    • email[String]: Billing Email
    • recipient[* Object Name]: Billing Recipient
      • first_name[String]: First Name
      • middle_name[String]: Middle Name
      • last_name[String]: Last Name
      • nickname[String]: Nickname
{
    "order_id": "NX348566DIHD",
    "payment": {
        "payment_id": "NHF8736274",
        "method": "card",
        "channel": "paypal",
        "amount": {
            "currency": "USD",
            "amount_local": 68,
            "amount_usd": 10,
            "amount_cny": 68
        },
        "card": {
            "card_bin": "622207",
            "last_four_digits": "1234",
            "card_number_length": 16,
            "holder_name": {
                "first_name": "Pierre",
                "middle_name": "",
                "last_name": "Laurent",
                "nickname": "Snochy"
            },
            "debit_or_credit": "credit",
            "issuer_region": "CN",
            "expiration_date": "1998-01-01"
        },
        "is_coupon_used": true,
        "coupons": [
            {
                "coupon_id": "NOHF08938",
                "coupon_name": "Limited Time Discount Coupon",
                "coupon_count": 1,
                "begin_time": 1596358039000,
                "expire_time": 1616358039000,
                "coupon_type": "discount",
                "coupon_rate": 0.85,
                "coupon_threshold": "10",
                "cash_back_amount": {
                    "currency": "USD",
                    "amount_local": 6.8,
                    "amount_usd": 1,
                    "amount_cny": 6.8
                }
            }
        ]
    },
    "billing": {
        "address": {
            "country": "FR",
            "region": "Grand Est",
            "city": "Strasbourg City",
            "district": "Ketali Lorem",
            "detail": "3213 Building,lorem Street",
            "zip_code": "310000"
        },
        "phone": {
            "country_code": 1,
            "phone_number": "18700001112"
        },
        "email": "[email protected]",
        "recipient": {
            "first_name": "Pierre",
            "middle_name": "",
            "last_name": "Laurent",
            "nickname": "Snochy"
        }
    }
}