Alipay, China's leading third-party online payment solutionAlipay, China's leading third-party online payment solution

      alipay.commerce.qrcode.modifyStatus

      Call this interface to modify the status of the QR code.

      #Request

      #Service address

      EnvironmentHTTPS request URL
      Production environment

      Priority: https://globalmapi.alipay.com/gateway.do

      Backup: https://intlmapi.alipay.com/gateway.do

      Test environmenthttps://mapi.alipaydev.com/gateway.do

      Note:

      If you use POST method, please specify _input_charset in the request URL.

      For example: https://mapi.alipaydev.com/gateway.do?_input_charset=UTF-8

      #Request parameters

      ParameterDescription
      Basic parameter

      service

      String Required

      Interface name 

      Example:alipay.commerce.qrcode.modifyStatus

      partner

      String(16) Required

      The partner ID that is assigned by Alipay to identify an Alipay account. The partner ID is composed of 16 digits and begins with 2088. 

      Example:2088*********662

      _input_charset

      String Required

      The charset with which the request data are encoded. UTF-8 is supported. 

      Example:UTF-8

      sign_type

      String Required

      Sign type. RSA, RSA2 and MD5 are supported. Use uppercase.

      Example:MD5

      sign

      String Required

      Sign value

      Example:5d479b28fac070e8e5a935685a3b7611

      timestamp

      String Required

      The time when the merchant server sends the request. The time is in GMT+8, with a format of yyyy-MM-dd HH:mm:ss. By default, the request expires in 30 minutes.

      Example:2012-12-21 17:11:16

      notify_url

      URL(200)

      The URL for receiving asynchronous notifications after the payment is completed.

      Example:https://www.test.com/alipay/notify_url.php

      Business parameter

      biz_type

      String Required

      Business type that is defined by Alipay, with a value of OVERSEASHOPQRCODE 

      Example:OVERSEASHOPQRCODE

      qrcode

      String Required

      The returned QR code value after the code is generated successfully. 

      Example:https://qr.alipay.com/ocx07358e3pxwresfpqpzed

      status

      String Required

      QR code status. The value can be one of the following items:

      • STOP: QR code stopped. If the user scans the stopped QR code, the user is to be notified that the QR code is invalid.
      • RESTART: QR code restarted. The QR code can be used after being restarted.
      • DELETE: QR code deleted. If the user scans the deleted QR code, the user is to be notified that the QR code is invalid. The QR code cannot be restarted after being deleted.

      Example:STOP

      #Response

      #Synchronous response

      ParameterDescription
      Basic parameter

      is_success

      String Required

      Indicates whether the request succeeds or not, with a value of T for success and F for failure.

      Note: a successful request does not mean the business is accepted and processed successfully. 

      Example:T

      sign_type

      String

      Sign type. RSA, RSA2 and MD5 are supported. Use uppercase.

      Example:MD5

      sign

      String

      Sign value

      Example:8342649bb0b3b818c9bed5952503b3df

      error

      String

      Error code that is returned when the request is failed to describe the request failure reason. For more information, see the Error Code section in this document. 

      Example:ILLEGAL_SIGN

      Business parameter

      qrcode

      String Required

      QR code

      Example:https://qr.alipay.com/9446219319446735

      #Error codes

      #Business error

      Error codeSpecification
      AE_BARCODE_GENERAL_CODE_FAIL_AND_RETRYModifying a QR code is failed. This error code supports retrial.
      AE_BARCODE_GENERAL_CODE_FAIL_AND_NOT_RETRYModifying a QR code is failed. This error code supports retrial.
      ILLEGAL_ARGUMENTParameter error, check and then retry.

      #System error

      Error codeSpecification
      ILLEGAL_SIGNInvalid signature
      ILLEGAL_DYN_MD5_KEYInvalid dynamic key
      ILLEGAL_ENCRYPTInvalid encryption
      ILLEGAL_ARGUMENTInvalid argument
      ILLEGAL_SERVICEInvalid service name
      ILLEGAL_USERInvalid user ID
      ILLEGAL_PARTNERInvalid partner ID
      ILLEGAL_EXTERFACEInterface configure error.
      ILLEGAL_PARTNER_EXTERFACEThe partner ID does not have access privilege.
      ILLEGAL_SECURITY_PROFILEThe key is not available
      ILLEGAL_AGENTInvalid Agent ID
      ILLEGAL_SIGN_TYPEInvalid sign type
      ILLEGAL_CHARSETIllegal character set
      HAS_NO_PRIVILEGENo priviledge
      INVALID_CHARACTER_SETInvalid character set.

      #Samples

      #Request

      https://intlmapi.alipay.com/gateway.do?service=alipay.commerce.qrcode.modifyStatus&partner=208xxxxxxxxx8155&_input_charset=UTF-8&sign_type=MD5&notify_url=https%3A%2F%2Fwww.mikascoffee.com%2Fnotify&biz_type=OVERSEASHOPQRCODE&qrcode=https%3A%2F%2Fqr.alipay.com%2Focx07305q83kwul5nb8ii2e&status=STOP&sign=7dbd6662f85e23ed98591e4d975ae398


      #Response

      The returned data of a successful request:

      copy
      <alipay>
          <is_success>T</is_success>
          <request>
              <param name="partner">208xxxxxxxxx8155</param>
              <param name="service">alipay.commerce.qrcode.modifyStatus</param>
              <param name="_input_charset">UTF-8</param>
              <param name="qrcode">https://qr.alipay.com/ocx07305q83kwul5nb8ii2e</param>
              <param name="biz_type">OVERSEASHOPQRCODE</param>
              <param name="sign">7dbd6662f85e23ed98591e4d975ae398</param>
              <param name="notify_url">https://www.mikascoffee.com/notify</param>
              <param name="sign_type">MD5</param>
              <param name="status">STOP</param>
          </request>
          <response>
              <qrcodeinfo>
                  <qrcode>https://qr.alipay.com/ocx07305q83kwul5nb8ii2e</qrcode>
              </qrcodeinfo>
          </response>
          <sign>8c76d8c145f49a2201c0e1e752f927e5</sign>
          <sign_type>MD5</sign_type>
      </alipay>


      The response for a failed request:

      copy
      <alipay>
      <is_success>F</is_success>
      <error>ILLEGAL_SIGN</error>
      </alipay>