Cash PickUp Commit

CashPickUpCommit API Method

Commit the cash pick up transaction.

📘

Every request triggered should have a unique X-GD-RequestId value in the header.

Syntax

POST {baseUrl}/barcode/cash-pickup/commit

Example Request

Success Request

POST {baseUrl}/barcode/cash-pickup/commit
Authorization: bearer {token}
Content-Type: application/json
X-GD-RequestId: 227ed887-8bc7-4e97-9173-a8ead91effc0

{
  "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/commit
Authorization: bearer {token}
Content-Type: application/json
X-GD-RequestId: 66219996371691

{
   "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

ParameterRequired (Y/N)Format/ Data TypePatternDescription
X-GD-RequestIdYesStringMaxLength:50It is a unique transaction identifier that is generated by the retailer.
requestDateTimeYesDateTime2024-08-13T12:34:56ZTime 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
userIdYesStringMaxLength:50The unique ID of the user generating the transaction.
storeIdYesStringMaxLength: 20The store number associated with the offline store of retailer.
If not supplied, InvalidParameter (Code:100) error will be return.
registerIdNoStringRegister where the transaction occurred.
merchantIdYesStringMaxLength: 20Unique merchant Id. It is defined by Green Dot – Merchant corresponding with Retailer.
barcodeNoStringMaxLength: 100The barcode value or identifier sent in the request.
amountNoDecimalMin: 1The transaction amount specified in the request.

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
{
	"customerFee": "10.00",
       "supportPhone": "",
"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
{
	"customerFee": "",
       "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

ParameterRequired(Y/N)Format/Data TypePatternDescription
requestIdYesStringMaxLength:50The unique request ID from request.
responseIdYesStringMaxLength:50The unique Response Identifier (generated by GreenDot).
responseDateTimeYesDateTime2024-098-13T16:12:23.4541445+08:00Time 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
responseCodeYesNumericMaxLength:4Indicates success and failure of the response codes. It is in the numeric format.
responseDescriptionYesStringMaxLength:255Describes the Response Code in more detail. It is in the String format.
customerFeeYesDecimal10.00The fee amouth associated with the customer, if applicable
supportPhoneYesStringMaxLength: 255The support or customer service phone number available for the customer

Response Cases

CodeCodeTextResponse DescriptionDescription
0SuccessSuccess
100InvalidParameter• 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.
130InvalidMerchant InvalidMerchantMerchantId in request has not been found/enabled in the system.
800InvalidStoreStore was not foundStore is not found; store is not for the partner or store does not support this operation.
861RetailChainUserNotFoundUser is not found.UserID in request is not found in system.
862RetailChainUserNotActiveUser is not active.UserId in request is not active.
1000GeneralFailureGeneralFailureService failure.