Game Version Submission

POST /api/open/v1/alipay/intl/hkwallet/app/versions/apply

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

version string  REQUIRED

Version identifier to apply for. Must correspond to an existing version of the application.

More information:

  • Maximum length: 64 characters

applyType string  REQUIRED

Submission type, case-sensitive.

  • online: Apply to bring the version online (publish).
  • offline: Apply to take the version offline.
  • onlineCancel: Cancel a pending online application.

More information:

  • Maximum length: 64 characters

reason string  

Reason for the application. Required when applyType is offline; optional otherwise.

REQUIRED when applyType=offline.

More information:

  • Maximum length: 512 characters

Response parameters

result object  REQUIRED

Result information.

Show child parameters

appId string  REQUIRED

Wallet-side application identifier.

More information:

  • Maximum length: 64 characters

version string  REQUIRED

Version identifier.

More information:

  • Maximum length: 64 characters

versionStatus string  REQUIRED

Version status after the application. The value depends on the applyType.

  • P: Preview — the application is in preview state.
  • A: Approving — the application is under review or processing.
  • O: Offline — the version has been taken offline.


More information:

  • Maximum length: 16 characters

applyType string  REQUIRED

Echo of the request applyType field.

More information:

  • Maximum length: 64 characters

applyTime string  REQUIRED

Application submission time in ISO 8601 format (e.g. 2026-11-12T10:00:00.000+08:00).

More information:

  • Maximum length: 64 characters
API Explorer

Request

Request Body

Response

Response Body

Result/Error codes

CodeValueMessageFurther action
SUCCESSSThe version application was submitted successfully.
APP_NOT_EXISTFThe application does not exist.Verify the appId or contact the wallet team to confirm the application status.
APP_VERSION_NOT_EXISTFThe specified version does not exist for the application.Verify the version identifier and retry.
OPERATION_CONFLICTFOperation conflict. The version is in a state that does not allow the requested operation.Check the current version status and retry with an appropriate applyType.
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 application.Retry at a later time. If the issue persists, contact the wallet team.