Customer Lookup API Method

This API allows for the retrieval of current POB partners’ customer information.

Endpoint

POST ~/customers/accounts/search

SLA Response and Resolution Time

Request

RequestParameters

Parameter Name	Type	Format	Required	Description
Content-Type	string	Header	Required	"application/json"
accountNumber	string	Body	Required	The account number
retailer: storeNumber	string	Body	Optional	Store number
retailer: storeName	string	Body	Optional	Store name
retailer: stateCode	string	Body	Optional	State code
retailer: latitude	decimal	Body	Optional	Store location latitude
retailer: longitude	decimal	Body	Optional	Store location longitude

Request Body Sample:

{"accountNumber": "5165297873423453","retailer": {"storeNumber": "string","storeName": "xd","stateCode": "ca","latitude": 2.2,"longitude": 1.1}}

Response

Response Parameters

If the GET request gets customer information success, the following response fields will be returned along with a 200HTTP response code.

Parameter Name	Type	Required	Description
customerId	string	Required	The customer identifier
accountId	string	Required	The account identifier
firstName	string	Required	First name of cardholder
lastName	string	Required	Last name of cardholder
zipCode	string	Required	Cardholder home zip code
expiryYear	string	Required	Format in YYYY
expiryMonth	string	Required	Format in MM. e.g. 01 for January

If the GET request gets customer information fails, the following response fields will be returned along with related HTTP responsecodesand Error codes.

Parameter Name	Type	Required	Description
errorCode	string	Required	The error code
errorMessage	string	Required	The error message

SampleResponses

Get valid customer

{"customerId": "0033B00000ToKB8QAN","accountId": "a0I3B000001qiEsUAI","firstName": "Nancy","lastName": "Yang","zipCode": "02110","expiryYear": "2030","expiryMonth": "01"}

Customer not found

{"errorCode":"ACCOUNT_NOT_FOUND","errorMessage":"The provided account doesn't exist ..."}

HTTP Response Codes

Below is a complete list of the response codes that the application needs to return for requests. In the event of network or infrastructure issues, other response codes may be returned by the infrastructure.

HTTP Response Codes	Description
200 OK	The request was completed successfully
400 BAD REQUEST	General error when the request could not be fulfilled due to errors such as validation errors, missing required data, etc
401 UNAUTHORIZED	Error code response for missing or invalid authentication token
404 NOT FOUND	The requested resource is not found. e.g. The PAN is not found, or the card is expired

Error Codes

Error response messages contain the following parameters:

Error Code	Error Description
ACCOUNT_EXPIRED	Account expired
ACCOUNT_NOT_FOUND	Account not found
AUTHORIZATION_FAILED	Authorization failed
GATEWAY_TIMEOUT	Gateway timeout
ACCOUNT_BLOCKED	Account blocked

Information need to be Provided by Partner

OAuth

If partner choose OAuth 2.0 to do Authentication, Green Dot will need credentials of OAuth, please contact Green Dot Product Owner.For non-Prod environment, Green Dot technical team also need these credentials for testing.

Test Data

For Customer Info API, test account for different scenarios need to be provided, please send email with these test data to [email protected].