RetailPayVersion 1.0.2

Create Retail Passive Payment Order

PUThttps://pay.globepay.co/api/v1.0/micropay/partners/{partner_code}/orders/{order_id}

Retail Passive Payment is used for cashier terminals which can scan BarCode or QRCode. Shop staff input the payment amount and ask customers for their payment code, then system send price and payment code to server and finish the payment. Retail Passive Payment now support both Alipay and WeChat

Path Variable

FieldTypeDescription
partner_codeString

Required, Partner code

order_idString

Required, Partner order id

JSON keys

FieldTypeDescription
descriptionString

Required, Order description

priceint

Required, Price of the order. Use the base unit of the currency.

currencyString

currency

Default value: GBP

Allowed values: GBP, CNY

device_idString

Required, ID of the device which sends the request

auth_codeString

Required, The Payment QR Code scanned from customer's WeChat Wallet.

notify_urlString

System will call the notify url if provided when the payment succeeds.

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

Order status

  • PAYING:Waiting for payment
  • CREATE_FAIL:Fail to create order
  • CLOSED:Order closed
  • PAY_FAIL:Payment failed
  • PAY_SUCCESS:Payment succeeded
order_idString

Order id in GlobePay, which is also WeChat order id.

partner_order_idString

Partner order id

total_feeint

Order amount, which uses the base unit of current currency

real_feeint

Actual paid amount.(The same as total fee at the moment. After coupon feature is finished, this may be different.)

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

Currency. Channel. Alipay,Wechat.

Error Code

NameDescription
ORDER_MISMATCH

Order ID does not belongs to current partner.

ORDER_PAID

Order has already been paid

AUTHCODEEXPIRE

QR Code expired

NOTENOUGH

The customer does not have enough balance to finish the payment

NOTSUPORTCARD

Card type is not supported

AUTH_CODE_ERROR

Payment QR Code has been used twice

AUTH_CODE_INVALID

The submitted QR Code is not a WeChat Payment QR Code

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