Call the QueryPrepaidCards API to query prepaid card information - Expenses and Costs

API Name

QueryPrepaidCards

Overview

You can call this operation to query prepaid cards.

Request parameters

Name	Type	Required	Description
Action	String	Yes	Action is API name：QueryPrepaidCards
EffectiveOrNot	Boolean	No	Value：True，False
ExpiryTimeStart	String	No	Expire time start，Format：yyyy-MM-dd’T’HH:mm:ss’Z’，Sample：2018-08-01T00:00:00Z
ExpiryTimeEnd	String	No	Expire time end，Format：yyyy-MM-dd’T’HH:mm:ss’Z’，sample：2018-08-01T00:00:00Z

Response parameters

Name	Type	Required
PrepaidCardId	String
PrepaidCardNo	String
GrantedTime	String
EffectiveTime	String
ExpiryTime	String
NominalValue	String	Total card amount
Balance	String	Available amount
ApplicableProducts	String	Applicable products
ApplicableScenarios	String	Available，Expired，Cancelled

Error codes

Error code	Description	HTTP status code	Description
NotApplicable	This API is not applicable for caller.	400	The error message returned when you are not authorized to use the API.
MissingParameter	The specified parameter xx is mandatory for this request.	400	The error message returned when the xx parameter is not specified.
InvalidParameter	The specified parameter xx is not valid.	400	The error message returned when the xx parameter is invalid.
InvalidModuleCode	The specified moduleCode is not valid.	400	The error message returned when the specified moduleCode parameter is invalid.
InvalidConfigCode	The specified configCode is not valid.	400	The error message returned when the specified configCode parameter is invalid.
InvalidOwner	The specified owner doesn’t belong to caller.	400	The error message returned when the specified owner does not belong to the caller.
InvalidCaller	The specified caller doesn’t exists.	400	The error message returned when the caller is invalid.
InternalError	The request processing has failed due to some unknown error, exception or failure.	400	The error message returned when an unknown internal error occurs.
ProductNotFind	Can not find inquired product, it may not exist.	400	The error message returned when the specified product is invalid.

Sample requests

&Action=QueryRedeem
&ExpiryTimeStart=
&ExpiryTimeEnd=
&EffectiveOrNot=
&PageNum=
&PageSize=

Sample responses

"Data": {
    "Redeem": {
      "Redeem": [
        {
          "Status": "expired",
          "ApplicableProducts": "",
          "NominalValue": "0",
          "Specification": "",
          "Balance": "0",
          "RedeemId": "15",
          "ExpiryTime": "2018-06-13 20:25:00",
          "EffectiveTime": "2018-05-14 20:25:00",
          "RedeemNo": "48890819881872821610",
          "GrantedTime": "2018-05-14 20:25:00"
        }
      ]
    },
    "TotalCount": 1,
    "PageSize": 20,
    "PageNum": 1
  },
  "Message": "Successful!",
  "RequestId": "555C62F8-88C5-4FC5-A929-B8C544FC6AEC",
  "Success": true,
  "Code": "Success"