This API is used to update some parameters of a gift card instance based on instanceId. All parameters except passTypeIdentifier, organizationPassId, and serialNumber (namely, instanceId) can be updated. The value of passStyleIdentifier (namely, modelId) can be changed to another gift card model ID with the same passTypeIdentifier.

Restrictions

You need to create an app in AppGallery Connect and apply for services corresponding to the passes. In addition, only an instance that has been added to the Huawei server can be updated.

Prototype

Protocol	HTTPS PATCH
Direction	Developer server -> Huawei server
URL	{url}/hmspass/v1/giftcard/instance/{instanceId} Set the {url} variable based on the region where the server is located. For details, please refer to Wallet Server Addresses.
Data Format	Request: Content-Type: application/json Response: Content-Type: application/json

URL Parameters

Expand

Parameter	Mandatory/Optional	Type	Description
instanceId	Mandatory	String	Unique identifier of an instance. It must be unique across all instances sharing the same appId. The value contains only letters, digits, dots (.), hyphens (-), and underscores (_).

Request Parameters

Request Header

Expand

Parameter	Mandatory/Optional	Type	Description
Authorization	Mandatory	String	Authorization code. For details about how to obtain the value, please refer to the Client Credentials mode in OAuth 2.0-based Authentication. In this mode, client_id and client_secret are respectively the App ID and App key of the app that you created in AppGallery Connect. Concatenate the value of access_token to the end of Bearer, with a space in between, to generate the value of Authorization.
Content-Type	Mandatory	String	The value is always application/json;charset=utf-8.
Accept	Mandatory	String	The value is always application/json;charset=utf-8.

Request Body

Expand

Parameter	Mandatory/Optional	Type	Description
For details, please refer to the HwWalletObject Parameters.	Mandatory	HwWalletObject	Pass instance to be updated.

Request Example

Collapse
Word wrap
Dark theme
Copy code
PATCH /hmspass/v1/giftcard/instance/30001 HTTP/1.1
Content-Type: application/json;charset=utf-8
Authorization: Bearer ***
Accept: application/json;charset=utf-8
Host: wallet-passentrust-drcn.cloud.huawei.com.cn
{
  "fields": {
    "commonFields": [
      {
        "key": "balance",
        "value": "$50"
      }
    ]
  }
}

Response Parameters

When the result code is 200:

Expand

Parameter	Type	Description
For details, please refer to the HwWalletObject Parameters.	HwWalletObject	Updated pass instance.

Response Example

Collapse
Word wrap
Dark theme
Copy code
HTTP/1.1 200 OK
Content-Type: application/json
{
  "passTypeIdentifier": "hwpass.com.huawei.wallet.giftcard.test",
  "passStyleIdentifier": "giftCardModelTest",
  "organizationPassId": "356688115",
  "serialNumber": "30001",
  "fields": {
    "status": {
      "state": "active",
      "effectTime": "2019-11-13T00:00:00.111Z",
      "expireTime": "2028-11-20T00:00:00.111Z"
    },
    "barCode": {
      "text": "1118466050",
      "type": "codabar",
      "value": "1118466050",
      "encoding": "UTF-8"
    },
    "commonFields": [
      {
        "key": "cardNumber",
        "value": "12345678"
      },
      {
        "key": "balance",
        "value": "$50"
      },
      {
        "key": "balanceRefreshTime",
        "value": "Thursday, Dec 12,2018"
      },
      {
        "key": "pin",
        "value": "118.91",
        "label": "PIN Number"
      }
    ]
  }
}

Result Codes

For details, please refer to Result Codes.

Call Example

Collapse
Word wrap
Dark theme
Copy code
public HwWalletObject partialUpdateWalletInstance(String url, String instanceId, HwWalletObject body) {
    // Construct the HTTP header.
    HttpHeaders header = constructHttpHeaders();
    // Construct the HTTP URL.
    String baseUrl = ConfigHelper.instants().getValue("walletServerBaseUrl");
    String walletServerUrl = baseUrl + url + instanceId;
    // Construct the HTTP body.
    String hwLoyaltyInstance = CommonUtil.toJson(body);
    JSONObject jsonObj = JSONObject.parseObject(hwLoyaltyInstance);

    // Send the HTTP request and obtain the response.
    HttpEntity<JSONObject> entity = new HttpEntity<>(jsonObj, header);
    ResponseEntity<HwWalletObject> response =
        REST_TEMPLATE.exchange(walletServerUrl, HttpMethod.PUT, entity, HwWalletObject.class);

    // Return the updated wallet instance.
    return response.getBody();
}

Updating the Entire Gift Card Instance

Adding Messages to a Gift Card Instance

Send feedback

Was this page helpful?

Send feedback

Reach out to us through the community for any other questions.

Community Q&A Intelligent Assistant