Payment Order Query(Pro Edition) - SparkPay OpenAPI Docs

Request

Path Params

merchant_no

string

required

Merchant customer number

request_no

string

required

Merchant payment request number, unique identifier for the merchant platform order

Header Params

User-Agent

string

required

Content cannot be empty.

Sparkpay-App-Id

string

required

Merchant Application ID

Sparkpay-Signature

string

required

Request for Signature

Sparkpay-Timestamp

string

required

Request timestamp, timestamp (accurate to the second)

Sparkpay-Nonce

string

required

Request random string

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200成功

application/json

Body

code

number

required

message

string

required

data

object

required

payment_order_no

string

Payment platform system order number

required

order_time

number

Payment order creation time

required

pay_time

number

Payment time

optional

completed_time

number

Order completion time

optional

closed_time

number

Order closing time

optional

pay_status

string

Order payment status

required

Payment Status UNPAID；COMPLETED; CLOSED

pricing_amount

string

Order amount

required

For large units, the smallest decimal precision is 6 places.

pricing_currency

string

Payment Currency Symbol

required

See Network and Currency

merchant_customer_no

string

Merchant Customer Number

required

merchant_order_no

string

Merchant original order number

required

merchant_application_user_id

string

Merchant application user ID

required

request_no

string

Merchant payment request number

required

Unique identifier for merchant platform orders

merchant_order_time

number

Merchant platform order time

required

merchant_order_timeout

number

Merchant platform order payment timeout duration. Unit: Timestamp(s)

required

merchant_order_desc

string

Order description, which will be displayed on the checkout page when the user makes the payment.

required

goods_info

string

Product information

required

business_info

string

Industry-specific special attributes

required

divide_detail

object

Revenue-sharing information

optional

If it's a revenue-sharing order, then every field in this item must not be empty.

notify_url

string

Asynchronous notification URL for payment results

required

redirect_url

string

required

The callback URL for the payment success page.

extension

string

Used to expand request parameters

required

app_id

string

merchant app_id

required

available_payment_currency_networks

array [object {2}]

required

pay_network_info

object

Payment network information

optional

Example

{
  "code": 0,
  "message": "string",
  "data": {
    "payment_order_no": "string",
    "order_time": 0,
    "pay_time": 0,
    "completed_time": 0,
    "closed_time": 0,
    "pay_status": "string",
    "pricing_amount": "string",
    "pricing_currency": "string",
    "merchant_customer_no": "string",
    "merchant_order_no": "string",
    "merchant_application_user_id": "string",
    "request_no": "string",
    "merchant_order_time": 0,
    "merchant_order_timeout": 0,
    "merchant_order_desc": "string",
    "goods_info": "string",
    "business_info": "string",
    "divide_detail": {
      "seller_amount": "string",
      "seller_addr": "string",
      "merchant_amount": "string",
      "other_details": [
        {
          "receiver_addr": "string",
          "amount": "string"
        }
      ]
    },
    "notify_url": "string",
    "redirect_url": "string",
    "extension": "string",
    "app_id": "string",
    "available_payment_currency_networks": [
      {
        "currency": "string",
        "networks": [
          0
        ]
      }
    ],
    "pay_network_info": {
      "payer_addr": "string",
      "merchant_ca_addr": "string",
      "merchant_recv_account": "string",
      "tx_hash": "string",
      "pay_network": 0,
      "payment_divide_detail": {
        "seller_amount": "string",
        "seller_addr": "string",
        "merchant_amount": "string",
        "other_details": [
          {
            "receiver_addr": "string",
            "amount": "string"
          }
        ]
      }
    }
  }
}