Get Retail Chain User Info
GetRetailChainUserInfo API Method
This operation is used to get RetailChainUser (teller) information by retailChainUserId.
Every request triggered should have a unique X-GD-RequestId value in the header.
Syntax
POST {baseUrl}/retailer/user/information
Example Request
Success Request
POST {baseUrl}/retailer/user/information
Authorization: bearer {token}
Content-Type: application/json
X-GD-RequestId: test101
{
"metadata": {
"merchantId": "fscc0342",
"registerId": "01",
"requestDateTime": "2023-11-09T13:25:45Z",
"storeId": "CC970",
"userId": "[email protected]"
},
"retailChainUserId": "[email protected]"
}
Negative Request
POST {baseUrl}/retailer/user/information
Authorization: bearer {token}
Content-Type: application/json
X-GD-RequestId: test101
{
"metadata": {
"merchantId": "fscc0342",
"registerId": "01",
"requestDateTime": "2023-11-09T13:29:06Z",
"storeId": "CC970",
"userId": "[email protected]"
},
"retailChainUserId": "[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 the 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 | Unique merchant Id. It is defined by Green Dot – Merchant corresponding with Retailer. |
| retailChainUserId | Yes | String | MaxLength: 50 | The unique ID of the user whose information is requested. |
Example Response
Success Response
HTTP/1.1 200 OK
Content-Type: application/json
X-GD-RequestId: test101
X-GD-ResponseId: 0237f1af-3168-4907-a86f-dafc5b42957e
X-GD-ResponseCode: 0
{
"retailChainUserId": "[email protected]",
"firstName": "Jack",
"lastName": "Bauer",
"last4DigitsOfCommissionCard": "",
"isActive": true,
"phoneNumber": "6648763215",
"email": "[email protected]",
"lastFourSsn": "1234",
"metadata": {
"requestId": "test101",
"responseId": "0237f1af-3168-4907-a86f-dafc5b42957e",
"responseDateTime": "2023-11-09T13:25:46.1924552Z",
"responseCode": 0,
"responseDescription": "Success"}
}
Negative Response
HTTP/1.1 200 OK
Content-Type: application/json
X-GD-RequestId: test101
X-GD-ResponseId: ffdf001f-6167-4006-a1b2-d20255da455e
X-GD-ResponseCode: 861
{
"retailChainUserId": null,
"firstName": null,
"lastName": null,
"last4DigitsOfCommissionCard": null,
"isActive": false,
"phoneNumber": null,
"email": null,
"lastFourSsn": null,
"metadata": {
"requestId": "test101",
"responseId": "ffdf001f-6167-4006-a1b2-d20255da455e",
"responseDateTime": "2023-11-09T13:29:08.2211497Z",
"responseCode": 861,
"responseDescription": "RetailChainUserNotFound"
} }
Response Parameters
| Parameter | Format/Data Type | Pattern | Description |
|---|---|---|---|
| requestId | String | MaxLength:50 | The unique request ID generated from the request. |
| responseId | String | MaxLength:50 | The unique Response Identifier (generated by GreenDot). |
| responseDateTime | 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 | Numeric | MaxLength:4 | Indicates success and failure of the response codes. It is in the numeric format. |
| responseDescription | String | MaxLength:255 | Describes the Response Code in more detail. It is in the String format. |
| RetailChainUserId | MaxLength: 50 | MaxLength: 50 | The unique ID of the user whose information is requested. |
| FirstName | String | MaxLength: 30 | User’s first name. |
| LastName | String | MaxLength: 30 | User’s last name. |
| Last4DigitsOfCommissionCard | String | 8764 | If there already a FSC card is associated, this field contains the last 4 digits of the card. Otherwise it’s empty. e.g. : ********1234 |
| IsActive | Bool | true/false | If the user is active this Boolean will set to true, else it will be false. |
| PhoneNumber | String | MaxLength: 25 | The phone number of the user. |
| String | Email format: [email protected] MaxLength: 40 | Email info of the user. | |
| lastFourSsn | String | “2347” | Last 4 digits of SSN of user. |
Response Cases
| Code | CodeText | ResponseDescription | Description |
|---|---|---|---|
| 0 | Success | N/A | Success. |
| 100 | InvalidParameter | • RequestId is required • RequestDateTime is required • UserId is required • StoreId is required • MerchantId is required • The RetailChainUserId field is required. • RequestId is too long • UserId is too long • StoreId is too long • MerchantId is too long • The field RetailChainUserId must be a string with a minimum length of 1 and a maximum length of 50. | 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 | Store is not found; store is not for the partner or store does not support this operation. |
| 861 | RetailChainUserNotFound | RetailChainUserNotFound User is not found. | Either UserID in mata or retailChainUserId in request is not found in system. |
| 862 | RetailChainUserNotActive | User is not active. | UserId in request metadata is not active. |
| 1000 | GeneralFailure | GeneralFailure | Service failure. |
Updated 8 months ago