inquireBenefitIssue

2023-04-28 21:00

URL: https://www.isv.host:port/isv/provided/path/for/benefit/query

With this API call, our server can request an Independent Software Vendor (ISV) to query the result of the previous issuing.

The message structure of this API is defined by us. When the ISV develops this API, follow the specifications below.

Note: If the ISV returns error codes not defined by us, we handle them as system errors.

Structure

A message consists of a header and body. The following sections are focused on the body structure. For the header structure, see:

Request parameters

Field

Data type

Required

Description

benefitIssueRequestId

String

Yes

Indicates the unique ID assigned by our server to identify an issuing request.

Maximum length: 64 characters.
Characters not allowed: special characters such as @ # ?

Response parameters

Field	Data type	Required	Description	Example
success	Boolean	Yes	Indicates whether the inquiry is successful	true
resultCode	String	No	Indicates the result codes Maximum length: 64 characters. Characters not allowed: special characters such as @ # ? Can be empty. Note: This field is required when the value of success is `false`.	-
resultMessage	String	No	Indicates the result messages that describe result codes in detail. Maximum length: 256 characters Characters not allowed: special characters such as @ # ? Can be empty.	-
benefitDetails	List<ExternalBenefitDetail>	No	Indicates the details of the benefit. Note: This field is required when the value of success is `true`.	-

Error codes

Error codes are usually classified into the following categories:

Common error codes are common across all Open APIs for ISVs.
API-specific error codes are listed in the following table.

Error code	Result status	Error message	Further action
ISSUE_REQUEST_ID_NOT_EXIST	F	When the issuing request ID does not exist and the ISV does not have the corresponding issuing record, we consider that the issuing does not need to be reversed.	Check the issuing request ID and try again later.

Samples

Request

copy
{
    "benefitIssueRequestId": "20211111010101000001234"
}

Response

copy
{
    "success": true,
    "resultCode": "",
    "resultMessage": "",
    "benefitDetails": [
        {
            "benefitInstanceId": "20211212010101000001234",
            "benefitTemplateId": "202001010101011234",
            "amount": {
                "currency": "USD",
                "value": "100"
            },
            "status": "ACTIVATED",
            "activateTime": "2019-04-04T12:08:56+05:30",
            "expireTime": "2019-05-04T12:08:56+05:30",
            "benefitCode": "QAZWSX123",
            "benefitPin": "ZXCVBN321",
            "benefitUrl": "",
            "extendInfo": "{\"k1\":\"v1\",\"k2\":\"v2\"}"
        }
    ]
}