UpdateInstanceStatus

2024-07-19 03:47

Update Voucher Instance Status

Interface: XXX/updateInstanceStatus

When voucher status is changed, Alipay+ Rewards will call this interface to change the voucher status in wallet side.
Direction: Alipay+ Rewards ---> Wallet

Request

(M=Madantory, C=Conditional, O=Optional)

header

Field	Type	Length	Mandatory	Detail	Sample
clientId	String	8	M	Client ID	2110200000000044
signature	String	1024	M	Signature	algorithm=sha256withrsa,keyVersion=2,signature=xxxxxxxxxxxyyyyyyyyyyyyyyzzzzzzzzz==
encrypt	String	32	O	encrypt method	algorithm=rsa, keyVersion=2
Content-type	String	/	M	Http content type	application/json; charset=UTF-8

body

Field	Type	Length	Madantory	Description	Sample
userId	String	32	M	Wallet userId
voucherId	String	64	M	VoucherId of each voucher assigned by wallet.
bizDate	Date	/	M	Update time
status	String	32	M	Voucher status	VALID - Back to original status REDEEMED - redeemed by user or merchant

Response

Field	Type	Length	Madantory	Description	Sample
resultInfo	ResultInfo	/	M	Result info
voucherId	String	32	M	VoucherId of each voucher assigned by wallet.
status	String	32	M	Voucher status	VALID - Back to original status REDEEMED - redeemed by user or merchant

ResultInfo

Field	Type	Length	Madantory	Description	Sample
resultStatus	String	32	M	S - Successful F - Failed U - Unknown	S
resultCode	String	32	M	Error Code	SYSTEM_BUSY
resultMessage	String	256	M	Error Message	system busy,retry again.

Error Code

ResultCode	ResultStatus	ResultMessage
SUCCESS	S	Success
PARAM_ILLEGAL	F	Illegal parameters exist. For example, a non-numeric input, or an invalid date.
REQUEST_TRAFFIC_EXCEED_LIMIT	U	The request traffic exceeds the limit.
SYSTEM_ERROR	U	System process occour error
USER_NOT_FOUND	F	User not found
INSTANCE_NOT_FOND	F	Instance not found

Sample

request

copy
{
    "voucherId":"20221119190501115401500000000001087200954853",
    "userId":"210672124",
    "bizDate":"2022-11-17T10:08:56+09:20",
    "status":"REDEEMED"
}

response

copy
{
    "voucherId":"20221119190501115401500000000001087200954853",
    "status":"redeemed"
    "resultInfo":{
        "resultStatus":"S",
        "resultCode":"SUCCESS",
        "resultMessage":"Success."
    }
}