Common Entities

Common Headers

Header	Description
X-GD-RequestId	Unique UUID for the request.
X-GD-AuthenticationType	Authentication type for the request. Possible Values: UsernamePassword-2, OAuth-3
Authorization	Details in Authentication
Content-Type	application/x-www-form-urlencoded (for AccessToken API only) OR application/json (for other APIs)

Response Details

Field	Type	Required	Description
code	Integer	Yes	Response code
codeDescription	String	Yes	Description of the response code
subCode	Integer	Optional	Response sub code
subCodeDescription	String	Optional	More detail description of the response sub code

Retailer

Retailer object details included in AuthCommit request to Partner:

Field	Type	Format	Required	Description
storeName	string	Max 100 chars	Optional	Name of store where transaction is taking place (i.e. Walmart)
storeId	string	Max 50 chars	Optional	Store ID or store number of associated transaction
terminalID	string	Max 50 chars	Optional	Terminal ID or number of where transaction is taking place
address	Object	N/A	Optional	See Address table below for details

Address

Field	Type	Format	Required	Description
addressLine1	string	Max 150 chars	Optional	Address Line1
addressLine2	string	Max 150 chars	Optional	Address Line2
city	string	Max 50 chars	Optional	City
state	string	Max 2 chars	Optional	State
zip	string	5 digit or 10 digit xxxxx or xxxxx-xxxx	Optional	Zip code

TransactionStatus

Below are the transaction statuses the Partner would return to Green Dot in the API response:

Field	Description
Completed	Transaction is successfully completed
Declined	Transaction is declined by the partner
Voided	Transaction is voided (if there is a void after AuthCommit call)
Failed	Transaction is failed if the partner service encounters internal service errors
Pending	Transaction is not fully complete. There are subsequent steps to complete

ClaimCodeStatus

Field	Description
New	Claimcode is generated, but unused and can still be used for cash out
Consumed	Claimcode was successfully used to take cash out
Expired	Claimcode is expired. Cash out transaction was not completed within the expiration time window (expiration time is configurable)
Cancelled	Cancelled by user, Partner, or Green Dot

EventType

EventType	Description
CashOut	Indicate the type of occurring event that is related to Cash Out product

EventName

EventName	EventType	Description
AuthCommit.Committed	CashOut	Event triggered after a 1-Phase AuthCommit for Cash Out is committed by retailer side

Payload

EventName: AuthCommit.Committed

Field	Type	Format	Required	Description
originalAuthorizationId	String	Min 6 characters Max 25 characters	Yes	Authorization Id returned by Partner in AuthCommit response
transactionReference	String	Min 32 characters Max 36 characters	Yes	Green Dot’s generated transaction reference number in AuthCommit request
claimCode	String	Min 10 characters Max 30 characters	Yes	Barcode or Claimcode for cashpickup

Updated 21 days ago