POST /customers/{customerid}/links/type/cash

Creates a link to create a cash pickup claim code.

Request

Field	Type	Format	Values Allowed	Required	Description
firstname	String	Max 25 characters	a-z, A-Z, hyphen, space	Yes	The first name of the person that will claim/remit cash at the retailer
lastname	String	Max 25 characters	a-z, A-Z, hyphen, space	Yes	The last name of the person that will claim/remit cash at the retailer
email	String	Max 255 characters	a-Z, A-Z, 0-9, underscore, hyphen, period, ampersand	No	The email address of the person that will claim/remit cash at the retailer
phone	String	Exactly 10 characters	0-9, hyphen, space, (,)	No	The Phone number of the person that will claim/remit cash at the retailer
dateofbirth	String	Max 10 characters	0-9, hyphen, dash, period	No	Date of birth in the format MM-DD-YYYY
ssn	String	Exactly 9 characters	0-9, hyphen	No	The Social Security Number of the person that will claim/remit cash at the retailer
identificationid	String	Max 25 characters	N/A	No	The ID of the person that will claim/remit cash at the retailer
identificationtype	String	Max 25 characters	N/A	No	The type of ID presented by the person that will claim/remit cash at the retailer Valid values 1,2 etc • 1= Driving License • 2 = State ID • 3 = SSN • 4 = US Passport • 5 = Mexican Matricula Consular ID • 6 = Military ID • 7 = Tribal ID
identificationissuedby	String	Max 25 characters	N/A	No	Agency that issued the identification
identificationexpirydate	String	Max 10 characters	N/A	No	Date the Identification expires. Format is: MM-DD-YYYY
address	String	Max 255 characters	a-z, A-Z, 0-9, hyphen, space, /, period	No	Address details of the person that will claim/remit cash at the retailer
city	String	Max 25 characters	a-z, A-Z, hyphen, space	No	City name
state	String	Max 2 characters	any word character	No	State code
zipcode	String	Max 10 characters	0-9, hyphen	Yes	Zipcode/postal code

Response Object

linkid: The unique identifier for this cash recipient
linkuri: The link URL to be referenced in transfer requests
status:
- verified: The customer has been verified and the customer can initiate transfer requests. This is the status that we will return for all successful POST requests.
responsecode: See the response code & description table below
responsemessage: See the response code & description table below
responsedate: The response date and time

Field	Type	Format	Description
linkid	String	Min 2 characters Max 50 characters	The unique identifier for this cash recipient. (e.g. 4a46c1ba-d5f0-4c04-b84d-6bd481afd4af)
linkuri	String	Max 255 characters	The link URL to be referenced in transfer requests
status	String	Max 50 characters	Verified
responsecode	Int	N/A	See the response code & description above (e.g. 0)
responsemessage	String	Max 150 characters	See the response code & description above (e.g. Success)
responsedate	Datetime	N/A	The response date and time (e.g. 2023-11-26T08:28:34.6348002Z)

POST Request

Sample /customers/e7310e3c-a8b4-49bc-b3e0-8b2150e5cd15/links/cash Request

{
	"firstname": "Daall",
	"lastname": "Tinan",
	"zipCode": "06320"
}

Sample Success Response

{
    "linkid": "4a46c1ba-d5f0-4c04-b84d-6bd481afd4af",
    "linkuri": "http://partners.greendotonline.com/customers/e7310e3c-a8b4-49bc-b3e0-8b2150e5cd15/links/4a46c1ba-d5f0-4c04-b84d-6bd481afd4af",
    "status": "verified",
    "responsecode": 0,
    "responsemessage": "Success",
    "responsedate": "2023-12-20T06:00:24.7068537Z",
    "responsedetail": {
        "responsedetailcode": 10,
        "responsedetaildescription": "None"
    }
}

GET/links/customers/{customerid}

Returns a list of link information related to the specified customer.

Request

None.

Response Object

partnerprogramidentifier: Unique ID provided by GD for the given partner program.
customerlinks: List of customer link details.
cardlinks: List of card link details.
cashlinks: List of cash link details.
gdaccountlinks: List of GD account link details.
achlinks: List of ach links.
moneypaklinks: List of moneypak link details.
responsecode: See the response code & description below.
responsemessage: See the response code & description below.
responsedate: The response date and time.

The status for each link can be one of the following:

Active – At least one transfer is successful for a given link.
InActive- Freshly created link or no successful transfers with the given link.
Deleted – As of now it is used for MoneyPak but will be returned when the delete link option is enabled for partners.
Expired – Future use.
Blocked – Future use.

Field	Type	Format	Description
partnerprogramidentifier	String	Max 100 characters	Unique ID provided by GD for the given partner program.
Customerlinks.customerid	String	Max 50 characters	customerid
Customerlinks.linkid	String	Max 100 characters	The unique identifier for link account associated with the customer
Customerlinks.linkuri	String	Max 255 characters	The link URL to be referenced in transfer requests
Customerlinks.status	String	Max 50 characters	See status above. Active – At least one transfer is successful for a given link InActive- Freshly created link or no successful transfers with the given link
Customerlinks.fundsavailability	String		No use for cash
cardlinks	Array		No use for cash
bankcardlinks	Array		No use for cash
cashlinks.linkid		Max 100 characters	The unique identifier for link account
cashlinks.linkuri	String	Max 255 characters	The link URL to be referenced in transfer requests
cashlinks.status	string	Max 50 characters	See status above. Active – At least one transfer is successful for a given link InActive- Freshly created link or no successful transfers with the given link
cashlinks.recipientfirstname	string	Max 25 characters	The first name of the person that will claim/remit cash at the retailer
cashlinks.recipientlastname	string	Max 25 characters	The last name of the person that will claim/remit cash at the retailer
cashlinks.recipientemail	string	Max 255 characters	The email address of the person that will claim/remit cash at the retailer
cashlinks.recipientphone	string	Exactly 10 characters	The Phone number of the person that will claim/remit cash at the retailer
cashlinks.recipientdateofbirth	string	Max 10 characters	Date of birth in the format MM-DD-YYYY
cashlinks.recipientsocialsecuritynumber	string	Exactly 9 characters	The Social Security Number of the person that will claim/remit cash at the retailer
cashlinks.recipientidentificationid	string	Max 25 characters	The ID of the person that will claim/remit cash at the retailer
cashlinks.recipientidentificationtype	string	Max 25 characters	The type of ID presented by the person that will claim/remit cash at the retailer Valid values 1,2 etc • 1= Driving License • 2 = State ID • 3 = SSN • 4 = US Passport • 5 = Mexican Matricula Consular ID • 6 = Military ID • 7 = Tribal ID
cashlinks.recipientidentificationissuedby	string	Max 25 characters	Agency that issued the identification
cashlinks.recipientidentificationexpirydate	string	Max 10 characters	Date the Identification expires. Format is: MM-DD-YYYY
cashlinks.recipientaddress	string	Max 255 characters	Address details of the person that will claim/remit cash at the retailer
cashlinks.recipientcity	string	Max 25 characters	City name
cashlinks.recipientstate	string	Max 2 characters	State code
cashlinks.recipientzipcode	string	Max 10 characters	Zipcode/postal code

GET Request

/links/customers/e7310e3c-a8b4-49bc-b3e0-8b2150e5cd15

Sample Success Response

{
    "partnerprogramidentifier": "FiservCashOut",
    "customerlinks": [
        {
            "customerid": "e7310e3c-a8b4-49bc-b3e0-8b2150e5cd15",
            "linkid": "cf42ecba-736c-4082-82ab-99849a6e1be5",
            "linkuri": "http://partners.greendotonline.com/customers/e7310e3c-a8b4-49bc-b3e0-8b2150e5cd15",
            "status": "Active",
            "fundsavailability": null
        }
    ],
    "cardlinks": [],
    "bankcardlinks": [],
    "cashlinks": [
        {
            "recipientfirstname": "Daall",
            "recipientlastname": "Tinan",
            "recipientemail": null,
            "recipientphone": null,
            "recipientidentificationid": null,
            "recipientidentificationtype": "",
            "recipientidentificationissuedby": null,
            "recipientidentificationexpirationdate": null,
            "recipientaddress": null,
            "recipientcity": null,
            "recipientstate": null,
            "recipientzipcode": "06320",
            "recipientdateofbirth": "0001-01-01T00:00:00",
            "recipientsocialsecuritynumber": "",
            "customerid": "e7310e3c-a8b4-49bc-b3e0-8b2150e5cd15",
            "linkid": "4a46c1ba-d5f0-4c04-b84d-6bd481afd4af",
            "linkuri": "http://partners.greendotonline.com/customers/e7310e3c-a8b4-49bc-b3e0-8b2150e5cd15/links/4a46c1ba-d5f0-4c04-b84d-6bd481afd4af",
            "status": "Inactive",
            "fundsavailability": null
        }
    ],
    "gdaccountlinks": [],
    "moneypaklinks": [],
    "achlinks": [],
    "responsecode": 0,
    "responsemessage": "Success",
    "responsedate": "2023-12-20T08:54:36.8857728Z",
    "responsedetail": {
        "responsedetailcode": 10,
        "responsedetaildescription": "None"
    }
}

GET/links/linkid/{linkId}

Returns a list of link information related to the specified linkId.

Request

None.

Response Object

partnerprogramidentifier: Unique ID provided by GD for the given partner program.
customerlinks: List of customer link details.
cardlinks: List of card link details (this is an Green Dot ONLY internal link and is not meant for partner use).
cashlinks: List of cash link details.
gdaccountlinks: List of GD account link details.
moneypaklinks: List of moneypak link details.
bankcardslinks: List of Bank Cards links and details.
responsecode: See the response code & description below.
responsemessage: See the response code & description below.
responsedate: The response date and time.

The status for each link can be one of the following:

Active – At least one transfer is successful for a given link.
InActive- Freshly created link or no successful transfers with the given link.
Deleted – As of now it is used for MoneyPak but will be returned when the delete link option is enabled for partners.
Expired – Future use.
Blocked – Future use.

Field	Type	Format	Description
partnerprogramidentifier	String	Max 100 characters	Unique ID provided by GD for the given partner program
Customerlinks	Array	N/A	N/A
cardlinks	Array	N/A	No use for cash
bankcardlinks	Array	N/A	No use for cash
cashlinks.linkid	String	Max 100 characters	The unique identifier for link account
cashlinks.linkuri	String	Max 255 characters	The link URL to be referenced in transfer requests
cashlinks.status	String	Max 50 characters	See status above. Active – At least one transfer is successful for a given link InActive- Freshly created link or no successful transfers with the given link
cashlinks.recipientfirstname	String	Max 25 characters	The first name of the person that will claim/remit cash at the retailer
cashlinks.recipientlastname	String	Max 25 characters	The last name of the person that will claim/remit cash at the retailer
cashlinks.recipientemail	String	Max 255 characters	The email address of the person that will claim/remit cash at the retailer
cashlinks.recipientphone	String	Exactly 10 characters	The Phone number of the person that will claim/remit cash at the retailer
cashlinks.recipientdateofbirth	String	Max 10 characters	Date of birth in the format MM-DD-YYYY
cashlinks.recipientsocialsecuritynumber	String	Exactly 9 characters	The Social Security Number of the person that will claim/remit cash at the retailer
cashlinks.recipientidentificationid	String	Max 25 characters	The ID of the person that will claim/remit cash at the retailer
cashlinks.recipientidentificationtype	String	Max 25 characters	The type of ID presented by the person that will claim/remit cash at the retailer Valid values 1,2 etc • 1= Driving License • 2 = State ID • 3 = SSN • 4 = US Passport • 5 = Mexican Matricula Consular ID • 6 = Military ID • 7 = Tribal ID
cashlinks.recipientidentificationissuedby	String	Max 25 characters	Agency that issued the identification
cashlinks.recipientidentificationexpirydate	String	Max 10 characters	Date the Identification expires. Format is: MM-DD-YYYY
cashlinks.recipientaddress	String	Max 255 characters	Address details of the person that will claim/remit cash at the retailer
cashlinks.recipientcity	String	Max 25 characters	City name
cashlinks.recipientstate	String	Max 2 characters	State code
cashlinks.recipientzipcode	String	Max 10 characters	Zipcode/postal code

GET Request (Customer linkid)

/links/linkid/cf42ecba-736c-4082-82ab-99849a6e1be5

Sample Success Response

{
    "partnerprogramidentifier": "FiservCashOut",
    "customerlinks": [
        {
            "customerid": "e7310e3c-a8b4-49bc-b3e0-8b2150e5cd15",
            "linkid": "cf42ecba-736c-4082-82ab-99849a6e1be5",
            "linkuri": "http://partners.greendotonline.com/customers/e7310e3c-a8b4-49bc-b3e0-8b2150e5cd15",
            "status": "Active",
            "fundsavailability": null
        }
    ],
    "cardlinks": [],
    "bankcardlinks": [],
    "cashlinks": [],
    "gdaccountlinks": [],
    "moneypaklinks": [],
    "achlinks": [],
    "responsecode": 0,
    "responsemessage": "Success",
    "responsedate": "2023-12-20T08:56:10.4819515Z",
    "responsedetail": {
        "responsedetailcode": 10,
        "responsedetaildescription": "None"
    }
}

GET Request (Cash linkid)

/links/linkid/4a46c1ba-d5f0-4c04-b84d-6bd481afd4af

Sample Success Response

{
    "partnerprogramidentifier": "FiservCashOut",
    "customerlinks": [],
    "cardlinks": [],
    "bankcardlinks": [],
    "cashlinks": [
        {
            "recipientfirstname": "Daall",
            "recipientlastname": "Tinan",
            "recipientemail": null,
            "recipientphone": null,
            "recipientidentificationid": null,
            "recipientidentificationtype": "",
            "recipientidentificationissuedby": null,
            "recipientidentificationexpirationdate": null,
            "recipientaddress": null,
            "recipientcity": null,
            "recipientstate": null,
            "recipientzipcode": "06320",
            "recipientdateofbirth": "0001-01-01T00:00:00",
            "recipientsocialsecuritynumber": "",
            "customerid": "e7310e3c-a8b4-49bc-b3e0-8b2150e5cd15",
            "linkid": "4a46c1ba-d5f0-4c04-b84d-6bd481afd4af",
            "linkuri": "http://partners.greendotonline.com/customers/e7310e3c-a8b4-49bc-b3e0-8b2150e5cd15/links/4a46c1ba-d5f0-4c04-b84d-6bd481afd4af",
            "status": "Inactive",
            "fundsavailability": null
        }
    ],
    "gdaccountlinks": [],
    "moneypaklinks": [],
    "achlinks": [],
    "responsecode": 0,
    "responsemessage": "Success",
    "responsedate": "2023-12-20T08:57:07.5452405Z",
    "responsedetail": {
        "responsedetailcode": 10,
        "responsedetaildescription": "None"
    }
}

Note: accountstatus can be eligible or not eligible.