Merchants can use this API to query all subsidy details for an Order Submission API request, as well as the refunded amount for each subsidy entry.
https://apis.5upay.com/subsidy/query
| Name | Type& Length | Description | Required |
|---|---|---|---|
| merchantId | varchar(9) | The unique merchant ID in the PayEase system, viewable in the merchant portal. | M |
| requestId | varchar(50) | The requestId provided in the Order Submission API request. | M |
| partnerId | varchar(9) | The unique service provider ID in the PayEase system, viewable in the merchant portal. | C |
| hmac | varchar(500) | HMAC signature generated by the merchant. For generation method, refer to the request encryption process. | M |
Note: The parameter values above must not contain the following special characters: ' " & < > ( ) [Space]
| Name | Description |
|---|---|
| merchantId | Same as the request parameter |
| requestId | Same as the request parameter |
| partnerId | Same as the request parameter |
| status | API Call Status: SUCCESS - API call succeeded |
| ERROR - API call failed | |
| status | Status of the acquiring order |
| INIT – Initialized | |
| SUCCESS – Successful | |
| CANCEL – Canceled | |
| FAILED – Failed | |
| subsidyDetail | Subsidy Details Returned upon successful query; array format containing all subsidy order details related to this acquiring transaction |
| hmac | Signature generated by Geoswift; please refer to the decryption procedure for the verification process |
| Name | Description |
|---|---|
| subsidyDetailId | Unique identifier for the subsidy order generated by Geoswift |
| subsidyMerchantId | Merchant ID associated with this subsidy detail |
| subsidyDetailAmount | Subsidy amount for this detail |
| subsidyStatus | Status of this subsidy detail |
| INIT Initialized | |
| SUCCESS Successful | |
| CANCEL Canceled | |
| FAILED Failed | |
| refundedSubsidyAmount | Total amount of subsidy that has been successfully refunded or is being processed for refund |