Game Information Query

POST /api/open/v1/alipay/intl/hkwallet/app/query

General Headers

Name

Description

Type

Sample

Client-Id

REQUIRED

An ID provided by AlipayHK, used to identify partner and application system.

String

4Q5Y8W0WSG45P907917

Content-Type

REQUIRED

The RFC 2616 media type of the request body, the charset should be as same as the one used for cryptographic operations. 

String

application/json; charset=UTF-8

Signature

REQUIRED

A key-value pairs string separated by commas (,), which keys and values are joined by equal signs (key=value). 

Valid keys include: 

  • algorithm: The digital signature algorithm used in generating the signature, RSA256 or ECC224, uses RSA256 by default. 
  • keyVersion: The key version of the signing key configured with Client-Id, uses the latest version by default. 
  • signature: The signature value of this request. 

String

algorithm=RSA256,keyVersion=1,signature=KEhXthj4bJ801Hqw8kaLvEKc0Rii8KsNUazw7kZgjxyGSPuOZ48058UVJUkkR21iD9JkHBGR rWiHPae8ZRPuBagh2H3qu7fxY5GxVDWayJUhUYkr9m%2FOW4UQVmXaQ9yn%2Fw2dCtzwAW0htPHYrKMyrT pMk%2BfDDmRflA%2FAMJhQ71yeyhufIA2PCJV8%2FCMOa46303A0WHhH0YPJ9%2FI0UeLVMWlJ1XcBo3Jr bRFvcowQwt0lP1XkoPmSLGpBevDE8%2FQ9WnxjPNDfrHnKgV2fp0hpMKVXNM%2BrLHNyMv3MkHg9iTMOD% 2FFYDAwSd%2B6%2FEOFo9UbdlKcmodJwjKlQoxZZIzmF8w%3D%3D

Encrypt

REQUIRED when message content needs to be encrypted. 

A key-value pairs string separated by commas (,), which keys and values are joined by equal signs (key=value). 

Valid keys include: 

  • algorithm: The symmetric key algorithm used in encryptingthe signature, only RSA_AES is supported. 
  • keyVersion: The key version of the signing key configured with Client-Id, uses the latest version by default.
  • symmetricKey: The encrypted symmetric key.

String

algorithm=RSA_AES,keyVersion=1,symmetricKey=bqS8HSmdaRrpKSuPy7CqUlyd8lJurG93

Request-only Headers

Name

Description

Type

Sample

Request-Time

REQUIRED

The ISO-8601 datetime of this API request with timezone.

String

2024-05-22T06:42:21+05:30

Response-only Headers

Name

Description

Type

Sample

Response-Time

REQUIRED

The ISO-8601 datetime of this API response with timezone.

String

2024-05-22T06:42:21+05:30

Tracer-Id

An ID for tracing this request.

String

abcdefg135202000000000263818

Request parameters

appId string  REQUIRED

Wallet-side application identifier.

More information:

  • Maximum length: 64 characters

Response parameters

result object  REQUIRED

Result information.

Show child parameters

appId string  REQUIRED

Wallet-side application identifier.

More information:

  • Maximum length: 64 characters

gameId string  REQUIRED

Content provider's unique game identifier. Conditional if not recorded.

More information:

  • Maximum length: 64 characters

appName object  REQUIRED

Multilingual application name. A map of locale code to display name.

Show child parameters

iconUrl string  REQUIRED

Application icon URL. Conditional if not available.

More information:

  • Maximum length: 512 characters

tags Array<string>  REQUIRED

Application tags. Conditional if not available.

More information:

  • Maximum size: 10 elements

appStatus string  REQUIRED

Application publish status.

  • ​online: The application is online.
  • ​offline: The application is offline.

More information:

  • Maximum length: 16 characters

effectiveVersion string  REQUIRED

Currently effective (published) version identifier. Conditional if no published version exists.

More information:

  • Maximum length: 64 characters

effectiveVersionPublishTime string  REQUIRED

Publication time of the effective version in ISO 8601 format. Conditional if no published version exists.

More information:

  • Maximum length: 64 characters

latestVersion string  REQUIRED

Latest version identifier. Conditional if no versions have been created.

More information:

  • Maximum length: 64 characters

latestVersionStatus string  REQUIRED

Status of the latest version (e.g. P, A, R, O). Conditional if no versions have been created.

  • ​P: Preview.
  • ​A: Approving.
  • ​R: Released.
  • ​O: Offline.

More information:

  • Maximum length: 16 characters

latestAudit object  REQUIRED

Latest audit information. Conditional if no audit record exists.

Show child parameters

releasedVersions Array<object>  REQUIRED

List of published versions.

More information:

  • Maximum size: 10 elements
Show child parameters

recentVersions Array<object>  REQUIRED

List of recent versions with their statuses.

More information:

  • Maximum size: 10 elements
Show child parameters
API Explorer

Request

Request Body

Response

Response Body

Result/Error codes

CodeValueMessageFurther action
SUCCESSSThe application status was queried successfully.
APP_NOT_EXISTFThe application does not exist.Verify the appId or contact the wallet team to confirm the application status.
PARAM_ILLEGALFInvalid parameter. Missing required fields, format errors, or missing parameters.Review the request parameters against the field constraints and retry.
UNKNOWN_EXCEPTIONUUnknown exception. An unexpected error occurred during the query.Retry at a later time. If the issue persists, contact the wallet team.