Inquiry

• Endpoint: POST /aggregate-pay/api/gateway/queryPaybylink
• Tags: Collection Service/PayByLink

Description

Endpoint：queryPaybylink

Parameters

Field	In	Type	Required	Constraints	Description
Content-Type	header	string	Yes
sign	header	string	Yes		签名信息请参考技术文档

Parameter Examples

• Content-Type: "application/json"
• sign: "FPFVT3o227JrFRbqu19boZCpVVTF9KznxyRawUmxpfXilHV/0yK46haPhAjNu1hPUMy7Vw/ILXhfzffNm4Fj0apWknlTY9OJxnSoQxS9BTFtc61tn5yV1q69x/kkBl82/qwg+XTJ4fOzy7Mar3VaC1E2PlDA6RkkKBUyNE6RYgsdB+Su7an4+4HVTNAnoe74WyvBgxTLMNg28igBTdqxaO3w/UBY6ObVp7vkqkQGdL1Y+HgmMYaAVwrM3+ALWGId0sJ+YqTY4WJ+0xCRGhaSnybiIjZsQEYyID68WNUfuavDLDsEhaMm/HfQvf5p0R1Ltovp3wwJnEbQcjY458iX5A=="

Request Body

Content-Type: application/json

Field	Type	Required	Constraints	Description	Enum
version	string	Yes		API version. Current value: 1.1
keyVersion	string	Yes		Signature Algorithm Version, Current value: 1
requestTime	string	Yes		Request time, compliant with rfc3339 specification, format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX The time must be within two minutes of the current time
merchantNo	string	No	maxLength: 32	Merchant Id, the unique identifier generated when the merchant signs the contract with PayerMax
merchantAppId	string	Yes	maxLength: 64	Merchant AppId，The unique identifier assigned to the merchant app by PayerMax.
data	object	Yes		Request data body.
data.merchantLinkId	string	Yes	maxLength: 64	Merchant link unique order number.

Example

{
  "version": "1.1",
  "keyVersion": "1.0",
  "requestTime": "2022-01-22T10:00:00.500+08:00",
  "merchantAppId": "6666c8b036a24579974497c2f9a33333",
  "merchantNo": "010213834784554",
  "data": {
    "merchantLinkId": "paybylinktest001"
  }
}

Responses

200

Field	Type	Required	Constraints	Description	Enum
code	string	Yes		Return code, ‘APPLY_SUCCESS’ means success
msg	string	Yes		Return message, ‘Success.’
data	object	No		Return data body.
data.linkId	string	Yes	maxLength: 64	PMmax link unique number.
data.merchantLinkId	string	Yes	maxLength: 64	Merchant link unique order number.
data.totalAmount	string	Yes	maxLength: 24	Order amount, the unit of amount is yuan.
data.country	string	Yes	maxLength: 2	The country code that the user pays for, in capital letters，see【Trading Supported Countries/Regions and Currencies】
data.currency	string	Yes	maxLength: 3	Currency code, uppercase letters, see 【Trading Supported Countries/Regions and Currencies】
data.linkStatus	string	Yes	maxLength: 16	ACTIVE、EXPIRED.	ACTIVE, EXPIRED
data.expiresAt	string	Yes	maxLength: 32	The specific time when the link expires.
data.linkUrl	string	Yes	maxLength: 256	PayByLink url
data.qrCodeUrl	string	Yes	maxLength: 256	PayByLink QRcode url.
data.description	string	Yes	maxLength: 256	Order description, displayed to the user on the link page.
data.linkDescription	string	No	maxLength: 256	Link description, not displayed to users, used for merchant notes.
data.payByLinkInfo	array[object]	No		The transaction details structure of the linked list.
data.payByLinkInfo[].outTradeNo	string	No	maxLength: 64	The unique identifier of each transaction order, when the link is not opened, this field is empty
data.payByLinkInfo[].status	string	No	maxLength: 32	Transaction status: ：SUCCESS、PENDING、CLOSE.
data.payByLinkInfo[].completeAt	string	No	maxLength: 32	Transaction success time, only when the transaction status is successful, return this time.
data.payByLinkInfo[].userInfo	object	No		User Info
data.payByLinkInfo[].userInfo.userId	string	No	maxLength: 64	The oneTime class can be passed in, and the user’s unique id on the merchant side.
data.payByLinkInfo[].userInfo.userName	string	No	maxLength: 64	oneTime type can be passed in, user name.
data.payByLinkInfo[].paymentDetails	array[object]	No		Payment method information, the payment method will be returned only if the transaction is successful.
data.payByLinkInfo[].paymentDetails[].targetOrg	string	No	maxLength: 64	Target institution, the target institution selected by the user for payment, and the target institution selected by the user for payment will be returned only if the transaction is successful.
data.payByLinkInfo[].paymentDetails[].paymentMethodType	string	No	maxLength: 64	Payment method type, the payment method selected by the user to pay, and the payment method selected by the user to pay will be returned only if the transaction is successful.
data.payByLinkInfo[].paymentDetails[].cardInfo	object	No		Card Info
data.payByLinkInfo[].paymentDetails[].cardInfo.cardOrg	string	No	maxLength: 32	Card Scheme, will return when the user chooses card scheme to pay
data.payByLinkInfo[].paymentDetails[].cardInfo.country	string	No	maxLength: 2	Card issuing country
data.payByLinkInfo[].paymentDetails[].cardInfo.cardType	string	No	maxLength: 32	Card funding type, such as DEBIT、CREDIT and so on.
data.payByLinkInfo[].paymentDetails[].cardInfo.totalCardOrg	array[string]	No		Brand of the card.Dual-standard card returns two brands.
data.payByLinkInfo[].paymentDetails[].cardInfo.type	string	No	maxLength: 32	Type of the card. PAN is a full pan; NETWORK_TOKEN is not a full pan, such as APPLEPAY.
data.payByLinkInfo[].paymentDetails[].cardInfo.source	string	No	maxLength: 32	Source of the card. CARD、APPLEPAY、GOOGLEPAY_PAN、GOOGLEPAY_CRYPTOGRAM、NETWORK_TOKEN
data.payByLinkInfo[].paymentDetails[].cardInfo.cardBinNo	string	No	maxLength: 16	Card BIN number.
data.payByLinkInfo[].paymentDetails[].cardInfo.cardNumber	string	No	maxLength: 32	Masked card number.
data.payByLinkInfo[].paymentDetails[].cardInfo.cardHolderName	string	No	maxLength: 128	Masked cardholder name.
data.payByLinkInfo[].paymentDetails[].cardInfo.cardLast4	string	No	maxLength: 4	The last four digits of the card.
data.payByLinkInfo[].paymentDetails[].cardInfo.cardExpirationYear	string	No	maxLength: 2	Two-digit number representing the card’s expiration year.
data.payByLinkInfo[].paymentDetails[].cardInfo.cardExpirationMonth	string	No	maxLength: 2	Two-digit number representing the card’s expiration month.
data.payByLinkInfo[].paymentDetails[].cardInfo.cardIdentifierNo ⚠️	string	No	maxLength: 19	Card number, the ciphertext is returned when paymentMethod is CARD
data.goodsDetails	array[object]	No		Commodity information, support multiple uploads.
data.goodsDetails[].goodsName	string	Yes	maxLength: 128	product name.
data.goodsDetails[].goodsDescription	string	Yes	maxLength: 256	product description.
data.goodsDetails[].quantity	string	Yes	maxLength: 16	Number of Products.
data.goodsDetails[].price	string	Yes	maxLength: 24	Commodity price.
data.goodsDetails[].goodsCurrency	string	No	maxLength: 3	Commodity quotation currency, uppercase letters, see 【Trading Supported Countries/Regions and Currencies】
data.goodsDetails[].showUrl	string	No	maxLength: 128	Product display address.

Response Example

{
  "code": "APPLY_SUCCESS",
  "msg": "SUCCESS.",
  "data": {
    "linkId": "jyirffse",
    "merchantLinkId": "paybylinktest001",
    "totalAmount": "10000",
    "country": "ID",
    "currency": "IDR",
    "linkStatus": "ACTIVE",
    "expiresAt": "2022-11-22T10:00:00.500+08:00",
    "linkUrl": "https://www.payermax.link/mtfbpomjw",
    "qrCodeUrl": "https://www.payermax.link/images/mtfbpomjwquc/qrcode",
    "payByLinkInfo": [
      {
        "outTradeNo": "order2022001",
        "status": "SUCCESS",
        "completeAt": "2022-10-20T10:00:00.500+08:00",
        "paymentDetails": [
          {
            "targetOrg": "",
            "paymentMethodType": "CARD",
            "cardInfo": {
              "cardOrg": "VISA",
              "cardNumber": "625244****9483"
            }
          }
        ]
      }
    ],
    "goodsDetails": {
      "goodsId": "ZAK1002",
      "goodsName": "MacPro 14",
      "quantity": "1",
      "price": "14999.00",
      "showUrl": "https: //xxx.xxx.com/SKU1239438283"
    }
  }
}

Enum Reference

data.linkStatus

• ACTIVE
• EXPIRED