Pay

API Target

{api_domain}/upay/v2/pay

Request Paramters

Description of goods_details in request parameters

Response Parameters

All following parameters refer to the fields in biz_response

Details of payment_list

Response Example - Success

{
       "result_code": "200",
       "biz_response": {
         "result_code": "PAY_SUCCESS",
         "data": {
           "sn": "7893259247405832",
           "client_sn": "w145206259311176",
           "client_tsn": "w145206259311176",
           "ctime": "1492506701411",
           "status": "SUCCESS",
           "payway": "3",
           "sub_payway": "1",
           "order_status": "PAID",
           "payer_login": "oyBevtwYm70JVPTFyGlvmKW3IO9U",
           "payer_uid": "oSTAxt7Rkjr7Jtk0vtf-cFWiHjcs",
           "trade_no": "4003262001201704187463804544",
           "total_amount": "101",
           "net_amount": "101",
           "finish_time": "1492506702864",
           "channel_finish_time": "1492506702000",
           "subject": "Apple iPhone 6s plus (A1699) 16G 玫瑰金色 移动联通电信4G手机",
           "store_id": "100ed809-af9a-11e5-9ec3-00163e00625b",
           "operator": "test",
           "payment_list": [
             {
               "type": "BANKCARD_DEBIT",
               "amount_total": "1"
             },
             {
               "type": "DISCOUNT_CHANNEL_MCH",
               "amount_total": "100"
             }
           ]
         }
       }
}

Response Example - In progress

{
        "result_code": "200",
        "biz_response": {
            "result_code": "PAY_IN_PROGRESS",
            "data": {
                "sn": "789200393929142",
                "client_sn": "230202l2-2-2002",
                "trade_no": "0019101002020384822248",
                "ctime": "2015-11-01 18:01:00",
                "status": "IN_PROG",
                "order_status": "CREATED",
                "total_amount ": "1000"
            }
        }
}

Response Example - Pay Failed

{
        "result_code": "200",
        "biz_response": {
            "result_code": "PAY_FAIL",
            "error_code": "EXPIRED_BARCODE",
            "error_message": "过期的支付条码",
            "data": {
                "sn": "7894259244067344",
                "client_sn": "12345677767776",
                "status": "FAIL_CANCELED",
                "payway": "3",
                "sub_payway": "1",
                "order_status": "PAY_CANCELED",
                "total_amount": "1",
                "net_amount": "1",
                "finish_time": "1449569494595"
            }
        }
 }

Response Example - Failed

{
    "result_code": "400",
    "error_code": "INVALID_PARAMS",
    "error_message": "total_amount金额为整数，长度不超过10位，以分为单位"
}

Client Pseudo-code Example

Sub pay(request, timeout):
  Try:
    response = POST (pay_url, request)
  Except NetworkConnectError ex:
    raise ("Network error", ex)
  Except NetworkIOError ex:
    return poll (request.client_sn, timeout)
  handle_response_error(response)
  biz_response = response.biz_response
  if biz_response.result_code == "PAY_SUCCESS":
    return ("Payment received", response)
  elif biz_response.result_code == "PAY_FAIL":
    return ("Payment failed and refunded, please retry", response)
  elif biz_response.result_code == "PAY_FAIL_ERROR":
    raise ("Payment error, please contact Upay customer service", response)
  elif biz_response.result_code == "FAIL":
    raise ("Payment failed and no transaction was made", response)
  else:
    return poll(request.client_sn, timeout)

Sub poll(client_sn, remaining_time):
  if remaining_time < 0:
    Try:
      response = POST(cancel_url, client_sn)
    Except NetworkError ex:
      raise "Order cancellation failed due to network error, please contact Upay customer service", ex
    handle_response_error(response)
    result_code = response.biz_response.result_code
    error_code = response.biz_response.error_code
    if result_code == "CANCEL_SUCCESS" or 
       result_code == "CANCEL_ABORT_SUCCESS":
      return ("Order expired and has been canceled", response)
    elif result_code == "FAIL" and error_code == "UPAY_ORDER_NOT_EXISTS":
      return ("Order expired and does not require cancellcation", response)
    else:
      raise ("Order cancellation error, please contact Upay customer service", response)
  else:
    stopwatch.start()
    Try
      response = POST(query_url, client_sn)
    Except NetworkError ex:
      sleep(5)
      return poll(client_sn, remaining_time – stopwatch.reading())
    handle_reponse_error(response)
    biz_response = response.biz_response
    if biz_response.result_code == "FAIL" and
       biz_response.error_code == "UPAY_ORDER_NOT_EXISTS":
      return ("Order payment failed and does not require cancellcation", response)
    elif biz_response.result_code == "SUCCESS":
      if biz_response.data.order_status == "CREATED":
        sleep(5)
        return poll(client_sn, remaining_time – stopwatch.reading())
      elif biz_response.data.order_status == "PAID":
        return ("Payment received", response)
      elif biz_response.data.order_status == "PAY_CANCELED":
        return ("Payment failed and refunded, please retry", response)
      elif biz_response.data.order_status == "PAY_ERROR":
        return ("Payment error, please contact Upay customer service", response)

Sub handle_response_error(response):
  if response.result_code == "400":
    raise ("Please contact terminal manufacturer", response.error_message)
  elif response.result_code == "500":
    raise ("Payment error, please contact Upay customer service", response.error_message)

Questions & Answers

1.It will prompt timeout if there is no password to enter after the query time, then the terminal needs to issue a new payment to retry. Please consult technical support team for this best practice.

2. If you don't get the final order status of a successful payment(check it with order_status), then use query to get it.

There are the final status of each transaction:

• PAID
• PAY_CANCELED
• REFUNDED
• PARTIAL_REFUNDED
• CANCELED

3.Suggest to add a query button in error message to manually process unilateral orders situation.

If consumers pay successfully, but the terminal display a failed payment or unclear status. Then it is suggested that to add Query button(to use Query interface to obtain the order status from Upay), then cashier can manually click the button to re-check the order status. If it is still not responded, then cashier needs to contact to WOSAI customer service.