CommonApiVersion 1.0.1

Query Order Status

GEThttps://pay.globepay.co/api/v1.0/gateway/partners/{partner_code}/orders/{order_id}

Including QR Code orders, JSAPI orders and Retail orders

FieldDescription
Accept

application/json

Path Variable

FieldTypeDescription
partner_codeString

Required, Partner code

order_idString

Required, Partner order id

Query Params

FieldTypeDescription
timeLong

Required, UTC timestamp in milliseconds

nonce_strString

Required, Random string

signString

Required, Sign

Success 200

FieldTypeDescription
return_codeString

Execution result

result_codeString
  • PAYING: Waiting for payment
  • CREATE_FAIL: Fail to create order
  • CLOSED: Order closed
  • PAY_FAIL: Payment failed
  • PAY_SUCCESS: Payment succeeded
  • PARTIAL_REFUND: Partial refunded
  • Full_REFUND: Full refunded

Use the same order id to call create order API can renew the order. PAYING, PAY_SUCCESS orders cannot be renewed.

order_idString

Order id in GlobePay, which is also WeChat order id. The final order id which is paid may be different from this one

partner_order_idString

Partner order id

total_feeint

Order amount, which uses the base unit of current currency

real_feeint

Actual paid amount.(Equal to total fee at the moment. After coupon feature is finished, this value may be different. )

rateDouble

Exchange Rate used while trading. 0.01 GBP=?CNY

customer_idString

Customer ID

pay_timeString

Time when order is paid(yyyy-MM-dd HH:mm:ss, UTC+10)

create_timeString

Time when order is created(according to the latest order)(yyyy-MM-dd HH:mm:ss, UTC+10)

currencyString

Currency. Default value is GBP.

channelString

Channel. Alipay,Wechat.

Error Code

NameDescription
ORDER_NOT_EXIST

Order does not exist

ORDER_MISMATCH

Order is not belong to this partner

SYSTEMERROR

Exception inside system

INVALID_SHORT_ID

Partner code is invalid or there is no partner associated with this code

SIGN_TIMEOUT

Sign expired, the difference between time and the server time is more than 5 minutes

INVALID_SIGN

Invalid sign

PARAM_INVALID

Parameters are invalid. See return_msg for more details.

NOT_PERMITTED

Gateway payment permission has not been enabled for this partner

INVALID_CHANNEL

Channel name is not available, check the Capitalize

ERROR

NameDescription
return_code

Error Code

return_msg

Error Description

PCI DSS Compliant

Security & Compliance

  • PCI DSSPayment Card Industry Data Security Standard compliant
  • TLS 1.2+API accepts TLS 1.2 / 1.3 encrypted connections only
  • SHA-256Every API request must carry a SHA-256 signature

On this page