Game Creation / Editing

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

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  

Wallet-side application identifier. Required for editing; omit when creating a new application.

REQUIRED when editing; omit when creating.

More information:

  • Maximum length: 64 characters

gameId string  

Content provider's unique game identifier. Required when creating a new application; omit when editing.

REQUIRED when creating; omit when editing.

More information:

  • Maximum length: 64 characters

name object  

Multilingual application name. A map of locale code to display name (e.g. en_US, zh_HK). Required when creating a new application; optional when editing.

REQUIRED when creating; optional when editing.

Show child parameters

description object  

Multilingual application description. A map of locale code to description text.

Show child parameters

intro object  

Multilingual application introduction. A map of locale code to intro text.

Show child parameters

iconUrl string  

Application icon URL. Must use HTTPS. Supported formats: PNG, JPG, JPEG, WebP. File size must be between 20KB and 500KB. Minimum dimension: 192px. Required when creating a new application; optional when editing.

REQUIRED when creating; optional when editing.

More information:

  • Maximum length: 512 characters

tags Array<string>  

Application tags. Maximum 10 items, each up to 32 characters. Commas are not allowed within individual tag values. When editing, the entire tag list is replaced.

More information:

  • Maximum size: 10 elements

Response parameters

result object  REQUIRED

Result information.

Show child parameters

appId string  REQUIRED

Wallet-side application identifier.

More information:

  • Maximum length: 64 characters

createTime string  REQUIRED

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

More information:

  • Maximum length: 64 characters

modifyTime string  REQUIRED

Application last modification 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
SUCCESSSCreate or edit successful, including idempotent requests.
APP_ALREADY_EXISTFAn application with the same partner and gameId already exists with different content.Use a different gameId or update the existing application.
APP_ICON_INVALIDFInvalid icon. The icon URL, format, content, file size, or pixel dimensions are invalid.Verify the icon URL, format (PNG/JPG/JPEG/WebP), size (20KB–500KB), and minimum dimension (192px).
APP_NOT_EXISTFThe application does not exist when editing.Verify the appId or create a new application first.
PARAM_ILLEGALFInvalid parameter. Missing required fields, format errors, tags constraint violation, or missing parameters.Review the request parameters against the field constraints and retry.
UNKNOWN_EXCEPTIONUUnknown exception.Retry at a later time. If the issue persists, contact the wallet team with the request timestamp.