Cash PickUp Auth
Cash PickUp Auth API Method
Auth the CashPickUp Transaction (part of Cardless Cash Pickup).
Every request triggered should have a unique X-GD-RequestId value in the header
Syntax
POST {baseUrl}/barcode/cash-pickup/auth
Example Request
Success Request
POST {baseUrl}/barcode/cash-pickup/auth
Authorization: bearer {token}
Content-Type: application/json
X-GD-RequestId: 227ed887-8bc7-4e97-9173-a8ead91effc0
{
"customerInfo": {
"firstName": "string",
"lastName": "string",
"dateOfBirth": "string",
"idIssuedBy": "string",
"idType": "string",
"idNum": "string"
},
"addressInfo": {
"address":"string",
"city": "string",
"state": "string",
"zip": "string"
},
"barcode": "abc123de",
"amount": 50.18,
"metadata": {
"storeId": "abc123",
"merchantId": "FSCC0342",
"userId": "TellerIDwruaQnIt",
"requestDateTime": "2024-07-23T07:09:46.0000000+00:00",
"registerId": "5399860082642512131121312121213121212121"
}
}
Negative Request
POST {baseUrl}}/barcode/cash-pickup/auth
Authorization: bearer {token}
Content-Type: application/json
X-GD-RequestId: 66219996371691
{
"customerInfo": {
"firstName": "",
"lastName": "",
"dateOfBirth": "",
"idIssuedBy": "",
"idType": "",
"idNum": ""
},
"addressInfo": {
"address":"",
"city": "",
"state":
"zip": "string"
},
"barcode": "abc123de",
"amount": 50.18,
"metadata": {
"storeId": "", ---------------------- Invalid OR Missing StoreId
"merchantId": "FSCC0342",
"userId": "TellerIDwruaQnIt",
"requestDateTime": "2024-07-23T07:09:46.0000000+00:00",
"registerId": "5399860082642512131121312121213121212121"
}
}
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 | 2024-08-13T12: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 |
| 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 offline store of retailer. If not supplied, InvalidParameter (Code:100) error will be return. |
| registerId | No | String | Register where the transaction occurred. | |
| merchantId | Yes | String | MaxLength: 20 | Unique merchant Id. It is defined by Green Dot – Merchant corresponding with Retailer. |
| barcode | No | String | MaxLength: 100 | The barcode value or identifier sent in the request. |
| amount | No | Decimal | Min: 1 | The transaction amount specified in the request. |
| customerInfo | Yes | object | { 1, … } | The customer info object. |
| firstName | No | String | MaxLength: 100 | The First Name of the customer. |
| lastName | No | String | MaxLength: 100 | The Last Name of the customer. |
| dateOfBirth | No | String | 2024-08-13T12: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 |
| idIssuedBy | No | String | Max: 30 | The authority that issued the customer’s identification |
| idType | No | String | Max: 30 | The type of identification document |
| idNum | No | String | Max: 30 | The identification number on the customer’s document |
| addressInfo | Yes | object | { 1, … } | The address info object. |
| address | No | String | Max: 50 | The street address, including house or building number and street name |
| city | No | String | Max: 50 | The name of the city where the address is located |
| state | No | String | Max: 50 | The state or province of the address location |
| zip | No | String | Max: 50 | The postal code or ZIP code for the address area |
Example Response
Success Response
HTTP/1.1 200 OK
Content-Type: application/json
X-GD-RequestId: 66219996371691
X-GD-ResponseId: 0648d859-f7e3-4d51-a164-af4d2614dc90
X-GD-ResponseCode: 0
{
"retailerCommission": 100.00,
"receiptText": "string",
"customerFee": 10.5,
"supportPhone": "string",
"metadata": {
"requestId": "227ed887-8bc7-4e97-9173-a8ead91effc0",
"responseId": "0648d859-f7e3-4d51-a164-af4d2614dc90",
"responseDateTime": "2024-08-27T10:30:56.884207Z",
"responseCode": 0,
"responseDescription": "Success"
}
}
Negative Response
HTTP/1.1 200 OK
Content-Type: application/json
X-GD-RequestId: 66219996371691
X-GD-ResponseId: 160d9d1b-c528-425c-ad09-01ade5fb5fa9
X-GD-ResponseCode: 800
{
"retailerCommission": 0,
"receiptText": "",
"customerFee": 0,
"supportPhone": "",
"metadata": {
"requestId": "227ed887-8bc7-4e97-9173-a8ead91effc0",
"responseId": "160d9d1b-c528-425c-ad09-01ade5fb5fa9",
"responseDateTime": "2024-08-27T10:30:56.884207Z",
"responseCode": 800,
"responseDescription": "Store was 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 | 2024-098-13T16: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. |
| retailerCommission | Yes | Decimal | 10.00 | The commission allocated to the retailer |
| receiptText | Yes | String | MaxLength:255 | The text or message displayed on the customer’s receipt |
| customerFee | Yes | Decimal | 10.00 | The fee amouth associated with the customer, if applicable |
| supportPhone | Yes | String | MaxLength: 255 | The support or customer service phone number available for the customer |
Response Cases
| Code | CodeText | ResponseDescription | Description |
|---|---|---|---|
| 0 | Success | Success | |
| 100 | InvalidParameter | • RequestId is too long • UserId is too long • StoreId is too long • MerchantId is too long • RequestId is required • RequestDateTime is required • UserId is required • StoreId is required • MerchantId is required | 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 | 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 3 days ago