APIs

POST/customers/{customerid}

Creates a profile for a customer. The customer will be required to go through Green Dot’s verification process before initiating further API calls.

The customer can be in any of the following status conditions:

Status	Description
Pending	The customer verification is pending, and the customer cannot initiate transfer requests till such time the customer has been verified. For Future use
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.
FailedVerification	The customer verification failed. Customer cannot initiate transfer requests. See accompanying response codes
OFACMatch-Pending	The customer verification had a soft OFAC Match that is getting reviewed by internal Risk Team. At this time transactions/links will not be blocked for this customer.
OFACMatch-Confirmed	The customer verification had a hard OFAC Match that is confirmed by internal Risk Team. At this time, transactions/links will be blocked for this customer.

Request

Field	Type	Format	Values Allowed	Required	Description
Firstname	String	Min 2 characters Max 25 characters	a-z, A-Z, hyphen, space	Yes	Customer's first name.
Lastname	String	Min 2 characters Max 25 characters	a-z, A-Z, hyphen, space	Yes	Customer's last name.
Email	String	Min 6 characters Max 50 characters	a-Z, A-Z, 0-9, underscore, hyphen, period, ampersand	Yes	Customer's verified Email address.
Phonenumber	String	only allow 10 characters	0-9	No	Customer's verified Phone number.
Dateofbirth	String	Min 10 characters Max 10 characters	0-9, hyphen,dash,period	Conditional	If Partner is disbursing to AnyDebit, this field is required. Date of birth in valid format (e.g.: MM-DD-YYYY): MM-DD-YY MM/DD/YYYY MM/DD/YY
Socialsecuritynumber	String	Min 11 characters Max 11 characters	0-9, hyphen	Conditional	The Social Security Number of the customer.
address1	String	Min 0 characters Max 25 characters	a-z, A-Z, 0-9, hyphen, space, /, period	No	Address Line 1.
address2	String	Min 0 characters Max 25 characters	a-z, A-Z, 0-9, hyphen, space, /, period	No	Address Line 2.
City	String	Min 0 characters Max 25 characters	a-z, A-Z, hyphen, space	No	City of the customer.
State	String	Min 0 characters Max 2 characters	any word character	No	Abbreviation of the State (e.g. CA, OH).
Zipcode	String	max 5 characters	0-9	Yes	Zip Code of the customer (e.g. 54321).
LastFourSSN	String	Min and Max 4 digits	0-9	Conditional	Last 4 digits of the SSN

Response Object

If the request is successful, a customerid is returned to the partner.

customerid: If a CustomerID is not provided by the partner in the POST request (Path Parameter), Green Dot will generate a unique CustomerID for this transfer.
customeruri: The Customer URL to be referenced in transfer requests.
status: See the status table above.
responsecode: See the response code & description below.
responsemessage: See the response code & description below.
responsedate: The response date and time.

POST Request /customers/

{
   "firstname":"new12145",
   "lastname":"user1214",
   "email":"[email protected]",
   "phonenumber":"6162534111",
   "dateofbirth":"01/14/78",
   "socialsecuritynumber":"555123456",
   "address1":"123 Main St",
   "address2":"Apt 51",
   "city":"SomeCity",
   "state":"CA",
   "zipcode":"54321"
}

Success

{
   "customerid": "e7310e3c-a8b4-49bc-b3e0-8b2150e5cd15",
   "customeruri": "https://partners.greendotonline.com/customers/e7310e3c-a8b4-49bc-b3e0-8b2150e5cd15",
   "status": "Verified",
   "responsecode": 0,
   "responsemessage": "Success",
   "responsedate": "2016-01-26T08:28:34.6348002Z",
   "responsedetail": 
  {
     "responsedetailcode": 10,
     "responsedetaildescription": "None"
   }
}

Success

{
  "customerid": "e7310e3c-a8b4-49bc-b3e0-8b2150e5cd15",
  "customeruri": "https://partners.greendotonline.com/customers/e7310e3c-a8b4-49bc-b3e0-8b2150e5cd15",
  "status": "OFACMatch",
  "responsecode": 200,
  "responsemessage": "Success",
  "responsedate": "2016-01-26T08:28:34.6348002Z",
  "responsedetail": 
  {
     "responsedetailcode": 0,
     "responsedetaildescription": " Success"
   }
}

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

Creates a link to a debit card attached to a bank account.

Request

Field	Type	Format	Values Allowed	Required	Description
firstname	String	Min 2 characters Max 25 characters	a-z, A-Z, hyphen,space	Yes	Card holder's first name.
middlename	String	Min 2 characters Max 25 characters		Yes	Card holder's middle name.
lastname	String	Min 2 characters Max 25 characters	a-z, A-Z, hyphen, space	Yes	Card holder's last name.
accountnumber	String	Max 25 characters		No	The PAN number of the source or destination debit/prepaid card.
expirymonth	String	Max 2 characters		Yes	MM (01 for Jan, 12 for Dec).
expiryyear	String	Max 4 characters		Yes	YYYY (e.g.: 2016).
nickname	String	Max 30 characters		No	The nickname to associate with the link.
address1	String	Max 255 characters	a-z, A-Z, 0-9, hyphen, space, /, period	No	Address Line 1.
address2	String	Max 255 characters	a-z, A-Z, 0-9, hyphen, space, /, period	No	Address Line 2.
city	String	Max 55 characters	a-z, A-Z, hyphen, space	No	City name.
state	String	Max 2 characters	any word character	No	Abbreviation of the State (e.g. CA, OH).
country	String	Max 3 characters		No	ISO 3166-1 alpha-3 Country Code (e.g. USA).
postalcode	String	Max 5 characters	0-9	Yes	Postal code of the address.

Response Object

linkid: The unique identifier for this linked card.
linkuri: The link URL to be referenced in transfer requests.
status: See the link status table above.
fundsavailability: Funds availability can be any one of the following:
- IMMEDIATE
- NEXT_BUSINESS_DAY
- TWO_TO_FIVE_BUSINESS_DAYS
responsecode: See the response code & description table below.
responsemessage: See the response code & description table below.
responsedate: The response date and time.

POST Request /customers/bdef994c-0446-4a41-9b39-f0225da7b4e1/links/type/bankcards

{
   "firstname":"John",
   "middlename":"Jacob",
   "lastname":"Smith",
   "accountnumber":"5102589999999970",
   "expirymonth":"12",
   "expiryyear":"2020",
   "nickname":"my new card",
   "address1":"123 Main Street",
   "address2":"ste 100",
   "city":"SomeCity",
   "state":"CA",
   "country":"USA",
   "postalcode":"54321"
}

Success

{
   "linkid":"07ea72d8-d4c0-4a2f-a854-8e59b3a7d5e8",
   "linkuri":"https://partners.greendotonline.com/customers/bdef994c-0446-4a41-9b39-f0225d
a7b4e1/links/bankcards/07ea72d8-d4c0-4a2f-a854-8e59b3a7d5e8",
   "status":"verified",
   "fundsavailability":"IMMEDIATE",
   "responsecode":"0",
   "responsemessage":"Success",
   "responsedate":"2015-10-02T09:00:000Z"
}

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

Creates a link to a bank checking account.

Request Parameters

Field	Type	Format	Values Allowed	Required	Description
firstname	String	Min 2 characters Max 25 characters	a-z, A-Z, hyphen, space	Yes	First name of the ACH Account Holder.
middlename	String	Min 2 characters Max 25 characters		No	Middle name of the ACH Account Holder.
lastname	String	Min 2 characters Max 25 characters	a-z, A-Z, hyphen, space	Yes	Last name of the ACH Account Holder.
accountnumber	String	Max 17 Digits		Yes	Destination bank account number
routingnumber	String	Required 9 Digits	0-9	Yes	Routing number of the associated bank account
bankname	String	Max 50 characters		No	Associated Bank Name
nickname	String	Max 50 characters		Yes	ACH account nickname.
accounttype	String		1 or 2	No	Type of the account 1: checking (default) 2: saving
address1	String	Max 50 characters	a-z, A-Z, 0-9, hyphen, space, /, period	No	Address Line 1 of the ACH Account Holder.
address2	String	Max 50 characters	a-z, A-Z, 0-9, hyphen, space, /, period	No	Address Line 2 of the ACH Account Holder.
city	String	Max 25 characters	a-z, A-Z, hyphen, space	No	City name of the ACH Account Holder
state	String	Max 20 characters	any word character	No	State name of the ACH Account Holder.
country	String	Max 20 characters		No	Country name of the ACH Account Holder.
postalcode	String	Max 10 characters	0-9, hyphen	Yes	Zip code of the ACH Account Holder.

Response Object

linkid: The unique identifier for this linked card
linkuri: The link URL to be referenced in transfer requests
status: See the link status table above
fundsavailability: Funds availability can be any one of the following:
- IMMEDIATE
- NEXT_BUSINESS_DAY
- TWO_TO_FIVE_BUSINESS_DAYS
responsecode: See the response code & description table below
responsemessage: See the response code & description table below
responsedate: The response date and time

POST Request /customers/bdef994c-0446-4a41-9b39-f0225da7b4e1/links/type/ach

{
   "firstname":"John",
   "middlename":"Jacob",
   "lastname":"Smith",
   "accountnumber":"5102589999999970",
   "accounttype":"1",
   "routingnumber":" 011103093",
   "nickname":"my new card",
   "address1":"123 Main Street",
   "address2":"ste 100",
   "city":"SomeCity",
   "state":"CA",
   "country":"USA",
   "postalcode":"54321",
   "bankname":"Bank of America, NA"
}

Success

{
   "linkid":"07ea72d8-d4c0-4a2f-a854-8e59b3a7d5e8",
   "linkuri":"https://partners.greendotonline.com/customers/bdef994c-0446-4a41-9b39-f0225d
a7b4e1/links/07ea72d8-d4c0-4a2f-a854-8e59b3a7d5e8",
   "status":"verified",
   "fundsavailability":"TWO_TO_FIVE_BUSINESS_DAYS",
   "responsecode":"0",
   "responsemessage":"Success",
   "responsedate":"2015-10-02T09:00:000Z"
}

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

Creates a link to create a cash pickup 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	Yes	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	Yes	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		Yes	The ID of the person that will claim/remit cash at the retailer.
identificationtype	string	Max 25 characters		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		No	Agency that issued the identification.
identificationexpirydate	string	Max 10 characters		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: See the link status table above
fundsavailability: Funds availability can be any one of the following:
- IMMEDIATE
- NEXT_BUSINESS_DAY
- TWO_TO_FIVE_BUSINESS_DAYS
responsecode: See the response code & description table below
responsemessage: See the response code & description table below
responsedate: The response date and time

POST Request /customers/950e4868-9f51-4a08-96a7-fcad96c4458e/links/cash

{
   "firstname":"jack",
   "lastname":"smith",
   "email":"[email protected]",
   "phonenumber":"626-123-5555",
   "ssn":"555123456",
   "identificationid":"CA093283",
   "identificationtype":"1",
   "identificationissuedby":"CA",
   "identificationexpirydate":"01-01-2019",
   "address":"123 Main St",
   "city":"Eureka",
   "state":"CA"
}

Success

{
   "linkid":"0738054c-a715-4c90-af4c-ad99bae91abc",
   "linkuri":"https://partners.greendotonline.com/customers/950e4868-9f51-4a08-96a7-fcad96c4458e/links/0738054c-a715-4c90-af4c-ad99bae91abc",
   "status":"verified",
   "fundsavailability":"IMMEDIATE",
   "responsecode":"0",
   "responsemessage":"Success",
   "responsedate":"2015-10-02T09:00:000Z"
}