7. Update Redeemable Card Budget

2024-11-22 08:09

POST /api/open/alipay/v1/ipass/template/manage/updateBudget

Use this interface to manage the stock of redeemable card.

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

requestId string REQUIRED

An unique ID of this request.

merchantId string REQUIRED

Merchant ID provided by AlipayHK.

templateCode string REQUIRED

A template code ID provided by AlipayHK.

updateType string REQUIRED

Type of update action.

APPEND_BUDGET: Increase number of budget.
SUBTRACT_BUDGET: Reduce number of budget.

Not allowed to update if template status is closed / expired.

number number REQUIRED

Number of stock to modify with the updateType.

The final stock must be within x to 1,000,000, where x is the number of issued redeemable cards.

More information:

Value range: 1-999999

Response parameters

resultInfo ResultInfo REQUIRED

A metadata object indicates the result of the request.

Show child parameters

API Explorer

Request

Request Body

Response

Response Body

Result/Error codes

Code	Value	Message
SUCCESS	S	Success
PARAM_ILLEGAL	F	Illegal parameters. For example, non-numeric input, invalid date.
UNKNOWN_EXCEPTION	U	API failed due to unknown reason.
PASS_TEMPLATE_HAS_NOT_EXIT	F	Template of this pass doesn't exist.
PASS_TEMPLATE_STATUS_ILLEGAL	F	Template status of the pass is invalid.