Get Package Details API Method

This method is used to validate the sale of a new card package, or a MoneyPak, prior to initiating the sale.

It verifies that the externId entered from the package is available for purchase.

Syntax

POST {baseUrl}/package/details

Example Request

POST {baseUrl}/package/details
Content-Type: application/json
Authorization: Bearer {token} 

{
"metadata": {
     "requestId": "201309181254",
     "merchantId": "15|118",
     "storeId": "39275"
     "requestDateTime": "2023-09-18T10:53:07Z"
},
      "externId": "3085033189"
      "transactionAmount": "20.00",
      "paymentProgramType": "Regular"
}

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
merchantId	Yes	String	MaxLength:20	The unique merchant Id. Defined by Green Dot – Merchant corresponding with Retailer.
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.
registerId	No	String	MaxLength:20	Register where the transaction occurred.
userId	No	String	MaxLength:50	The unique ID of the user generating the transaction. UserID is now a required field to support ‘teller incentive program’.
externId	Yes	String	Max:30	The externId is the last 19 digits of the barcode on the package.
transactionAmount	No	decimal	500.00	Amount of money to be loaded. For example: Five Hundred Dollars is entered as “500.00”. Twenty Dollars is entered as “20.00”)
paymentProgramType	Yes	Enum	Regular, CheckCashing	Type of payment option that customer selects. For example: • If the customer is paying with a check, then it will be “CheckCashing”. If they are paying by cash, or a combination of check and cash, PaymentProgramType will be “Regular”.

Example Response

HTTP/1.1 200 OK
Content-Type: application/json

{
"metadata": {
     "requestId": "201309181254",
     "responseCode": 0, 
     "responseDescription": "Success",
     "responseDateTime": "2013-09-18T17:53:07.1411753Z",
     "responseId": "583775d2-78d6-4735-8fed-e02a2c35bf51"
},
      "minAllowedAmount": "20.00",
  "maxAllowedAmount": "500.00",
  "purchaseFee": "4.95",
  "merchantFee": "2.00"
}

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.
minAllowedAmount	No	Decimal	20.00	This field returns the minimum amount that can be reload.
maxAllowedAmount	No	Decimal	500.00	This field returns the maximum amount that can be reload.
purchaseFee	Yes	Decimal	4.95	The fee of current transaction.
merchantFee	Yes	String	2.00	This is the merchant fee for this transaction.