Get Cashier URL Information

Overview

This interface returns information about whether a QR code has been scanned by the user and provides details about the scanner (payer).

API URL

• Testing environment: https://uat.test2pay.com/sgs/api/acquire2/getCashierUrlInfo
• Production environment: https://api.payby.com/sgs/api/acquire2/getCashierUrlInfo

Request

HTTP Headers

Attributes

• Content-Language String

  • Language in which the response message will be used.
  • Currently, only English is supported.
  • Example value: en
  • Maximum length: 10

• Content-Type String Required

  • Media type of the request body.
  • Required for operations with a request body.
  • Format: application/<format> (e.g., application/json)
  • Example value: application/json

• sign String Required

  • Request signature using private-key cryptography.
  • Ensures the payment gateway can verify the request origin.

• Partner-Id String Required

  • Merchant ID of your account.
  • Example value: 200001200101
  • Maximum length: 12

HTTP Body

• requestTime Timestamp(3) Required

  • Request timestamp in milliseconds.
  • Example value: 1581493898000

• bizContent GetCashierUrlInfoRequest Required

  • Business request content containing the necessary parameters for generating the cashier URL.

  • tokenUrl String Required

    • The cashier URL used to initiate or query the payment process.
    • Example value:
      https://checkout.payby.com/pay-page/main?BIZ_TYPE=202&ft=cd624549f4894d78b0d368e48bb27aae&t=1654519114067

Request Sample

HTTP Headers

{
    "Content-Language": "en",
    "Content-Type": "application/json",
    "Partner-Id": "200000018128",
    "sign": "RXF8WmC67QSnr62l3oU33fjpUvAo6Yrgvk05c/vYLtmHRGMoAH4qSnap2pto3mY7KgyP5wkNUsyQXJ/ZwbfccSONLb5zA7Z7q74IsOwdJw3BKXxVWr4tfjkA02Pfcp0cZWjE/Y8jTcbtgdc5VI90LNmkgPWbrSlDbNW8p3NlhnKg+Xfl95SgMBPF9afttsU/2a5jLnZXSVcXoSthxpJ6XkZwd45+jhOjBguT+IC8uLVSNRvwDisRGgf9PYv39OH6ITEhbY2sgjkdzBZBOZlt7awy2vkMEsePsuafwrNhuz7xzjj55PzNzk8+zCUu/791OhC/eFUyGimtDw5mX9cyQw=="
}

HTTP Body

{
  "requestTime": 1581406091642,
  "bizContent": {
    "tokenUrl": "https://checkout.payby.com/pay-page/main?BIZ_TYPE=202&ft=cd624549f4894d78b0d368e48bb27aae&t=1654519114067"
  }
}

Response

HTTP Headers

• Sign String Required
  • Response signature used to verify the integrity and authenticity of the response data.

HTTP Body

Note: The body field in the HTTP response is returned only when applyStatus is SUCCESS and code is 0.

• head ResponseHeader Required

  • Response header information containing metadata such as status codes and messages.

• body GetCashierUrlInfoResponse

  • Response body content containing the main data returned by the API.

  • payer Payer Required

    • Information about the person making the payment, including identity and payment details.

    • mobileNumberMask String

      • Masked mobile number of the payer, used to partially conceal the full number for privacy and security.
      • Example value: +971-58*92

Response Sample

HTTP Headers

{
    "sign": "nDdClX1tAyV3qcX/Epay6AXFNRGSsWd8ysWO9SgwPrNTetSePLA9C39mGp6qRbjJeqXLEnYLwSkBu5eKdtyVX3tflGLiV2kvRjVfYpTCjXdVL2Pcnv2w+ghjHe2jL988iklk7q5AjAgdtXNphpHcTes9pk6W3bVCbvijH6at0fExUtZ91L1LrnPGELT1IJm/lFW3w4KLh0Gxs7FzDPI9RDfUemObNlRzV8kCtkWahwPgs/hBnS69GyYDKN7ihQX2UiLuP239wl6IA+VG/ZZKHPhLs8bbuOS+LKWORIp6jRt+JsAx7c/Ot1RNyOnHKxPRKJ8bVTohEp39yUz/HwG8oA=="
}

HTTP Body

{
    "body":{
        "payer":{
            "mobileNumberMask":"+971-58*92"
        }
    },
    "head":{
        "applyStatus":"SUCCESS",
        "code":"0",
        "msg":"SUCCESS",
        "success":true,
        "traceCode":"975929"
    }
}

Response Codes

Code	Message	Cause	Workaround
0	SUCCESS	Request completed successfully	-
400	INVALID_PARAMETER	Invalid parameter provided	Adjust request parameters
400	REQUESTTIME_TOO_EARLY	Request time is too early	Adjust request time
400	REQUESTTIME_TOO_LATER	Request time is too late	Adjust request time
402	RATE_LIMIT_REJECT	Request rate limit exceeded	Reduce request frequency
403	UNAUTHORIZED	API not authorized	Contact PayBy
404	SERVICE_NOT_AVAILABLE	API service unavailable	Contact PayBy
500	SYSTEM_ERROR	System error occurred	Contact PayBy and retry later
504	SERVICE_TIMEOUT	Service timeout	Retry later
601	RISK_FAIL	Risk control validation failed	Adjust business logic
62082	TOKEN_URL_NOT_EXIST	Token URL is invalid or expired	Adjust request parameters