Validate Unload Eligibility
ValidateUnloadEligibility API Method
This method is used to validate if retailer or store is allowed to do cash unload.
Validated items:
• If Retailer is authorized for unloads.
• If Store is valid.
Every request triggered should have a unique X-GD-RequestId value in the header.
Syntax
POST {baseUrl}/unload/validate/retailer
Example Request
Success Request
POST {baseUrl}/unload/validate/retailer
Authorization: bearer {token}
Content-Type: application/json
X-GD-RequestId: test101
{
"metadata": {
"merchantId": "fscc0342",
"registerId": "01",
"requestDateTime": "2023-10-11T06:46:00Z",
"storeId": "CC970",
"userId": "[email protected]"
}
}
Negative Request
POST {baseUrl}/unload/validate/retailer
Authorization: bearer {token}
Content-Type: application/json
X-GD-RequestId: test101
{
"metadata": {
"merchantId": "fscc0342",
"registerId": "01",
"requestDateTime": "2023-10-11T06:53:22Z",
"storeId": "CC970",
"userId": "[email protected]"
}
}
Request Parameters
| Parameter | Required(Y/N) | Format/Data Type | Pattern | Description |
|---|---|---|---|---|
| X-GD-RequestId | Yes | String | MaxLength:50 | It is a unique transaction identifier that is generated by the retailer. |
| requestDateTime | Yes | DateTime | 2023-08-08T12:34:56Z | Time stamp at which transaction occurred. The time stamp has to be in UTC time zone and follow the following date and time formats: • YYYY-MM-DDTHH:mm:ssZ |
| registerId | No | String | MaxLength: 20 | Register where the transaction occurred. |
| userId | Yes | String | MaxLength:50 | The unique ID of user generating the transaction. |
| storeId | Yes | String | MaxLength: 20 | The store number associated with the retailer that sold the package. If not supplied, InvalidParameter (Code:100) error will be return. |
| merchantId | Yes | String | MaxLength: 20 | The unique merchant Id. Defined by Green Dot – Merchant corresponding with Retailer. |
Example Response
Success Response
HTTP/1.1 200 OK
Content-Type: application/json
X-GD-RequestId: test101
X-GD-ResponseId: c1fc2a2e-87a7-4bbd-8482-6ad8afaa1fcd
X-GD-ResponseCode: 0
{
"metadata": {
"requestId": "test101",
"responseId": "c1fc2a2e-87a7-4bbd-8482-6ad8afaa1fcd",
"responseDateTime": "2023-10-11T06:46:01.830206Z",
"responseCode": 0,
"responseDescription": "Success"
}
}
Negative Response
HTTP/1.1 200 OK
Content-Type: application/json
X-GD-RequestId: test101
X-GD-ResponseId: 268fb4f5-d252-4bd7-9525-c35736146144
X-GD-ResponseCode: 861
{
"metadata": {
"requestId": "test101",
"responseId": "268fb4f5-d252-4bd7-9525-c35736146144",
"responseDateTime": "2023-10-11T06:53:24.7038474Z",
"responseCode": 861,
"responseDescription": "User is not found."
}
}
Response Parameters
| Parameter | Required(Y/N) | Format/Data Type | Pattern | Description |
|---|---|---|---|---|
| requestId | Yes | String | MaxLength:50 | The unique request ID from request. |
| responseId | Yes | String | MaxLength:50 | The unique Response Identifier (generated by GreenDot). |
| responseDateTime | Yes | DateTime | 2023-09-07T16:12:23.4541445+08:00 | Time stamp at which transaction occurred. The time stamp is in UTC time zone and follow the following date and time formats: • YYYY-MM-DDTHH:mm:ssfffffffK |
| responseCode | Yes | Numeric | MaxLength:4 | Indicates success and failure of the response codes. It is in the numeric format. |
| responseDescription | Yes | String | MaxLength:255 | Describes the Response Code in more detail. It is in the String format. |
Response Cases
| Code | CodeText | Response Description | Description |
|---|---|---|---|
| 0 | Success | Success | Success. |
| 100 | InvalidParameter | • UserId is required • RequestDateTime is required • StoreId is required • MerchantId is required • RequestId is required • RequestId is too long • StoreId is too long • MerchantId is too long • UserId is too long | Invalid parameter in the request. Examples: MerchantID not supplied, StoreID not supplied. |
| 130 | InvalidMerchant | InvalidMerchant | MerchantId in request has not been found/enabled in the system. |
| 800 | InvalidStore | • Store was not found • Block by Store Hierarchy setting | Store is not found; store is not for the partner or store does not support this operation. |
| 861 | RetailChainUserNotFound | User is not found. | UserID in request is not found in system. |
| 862 | RetailChainUserNotActive | User is not active. | UserId in request is not active. |
| 1000 | GeneralFailure | GeneralFailure | Service failure. |
Updated 8 months ago