GetDirectDepositInfo API Method

This operation is used to get direct deposit information (account and routing number) for a given account.

📘
Every request triggered should have a unique X-GD-RequestId value in the header.

Syntax

POST {baseUrl}/card/direct-deposit-details

Example Request

Success Request

POST {baseUrl}/card/direct-deposit-details 
Authorization: bearer {token}
Content-Type: application/json
X-GD-RequestId: test101
{
    "metadata": {
        "merchantId": "fscc0342",
        "registerId": "01",
        "requestDateTime": "2023-11-09T14:05:02Z",
        "storeId": "CC970",
        "userId": "[email protected]"
    },  
  "accountNumber": "",
  "accountIdentifier": "06e33e98-5c40-4c1a-967b-930f28f509a4"
}

Negative Request

POST {baseUrl}/card/direct-deposit-details
Authorization: bearer {token}
Content-Type: application/json
X-GD-RequestId: test101
{
    "metadata": {
        "merchantId": "fscc0342",
        "registerId": "01",
        "requestDateTime": "2023-11-09T14:07:13Z",
        "storeId": "CC970",
        "userId": "[email protected]"
    },  
  "accountNumber": "",
  "accountIdentifier": "06e33e98-5c40-4c1a-967b-930f28f509a8"
}

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
registerId	No	String	MaxLength: 20	Register where the transaction occurred.
userId	Yes	String	MaxLength:50	The unique ID of the user generating the transaction.
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.
merchantId	Yes	String	MaxLength: 20	Unique merchant Id. It is defined by Green Dot – Merchant corresponding with Retailer.
accountNumber	No	String	16 digits PAN	16 digits number Note: Either AccountNumber or AccountIdentifier is required
accountIdentifier	No	GUID	e5843e05-d367-4bf1-a223-3af46ae18802	Newly created unique identifier for sale card, should be using for all subsequent API calls. Either of AccountNumber / AccountIdentifier required.

Example Response

Success Response

HTTP/1.1 200 OK
Content-Type: application/json
X-GD-RequestId: test101
X-GD-ResponseId: 8dd4b342-b716-4019-af54-3910551ddd1b
X-GD-ResponseCode: 0

{    
    "bankName": "GO2bank",
    "abaRoutingNumber": "124303162",
    "achReferenceNumber": "16360932138674",
    "metadata": {
        "requestId": "test101",
        "responseId": "8dd4b342-b716-4019-af54-3910551ddd1b",
        "responseDateTime": "2023-11-09T14:05:07.2865269Z",
        "responseCode": 0,
        "responseDescription": "Success"
    } }

Negative Response

HTTP/1.1 200 OK
Content-Type: application/json
X-GD-RequestId: test101
X-GD-ResponseId: 3efa565a-e000-45d7-8219-2f45fbaa5174
X-GD-ResponseCode: 110

{    
    "bankName": null,
    "abaRoutingNumber": null,
    "achReferenceNumber": null,
    "metadata": {
        "requestId": "test101",
        "responseId": "3efa565a-e000-45d7-8219-2f45fbaa5174",
        "responseDateTime": "2023-11-09T13:50:37.4678618Z",
        "responseCode": 110,
        "responseDescription": "Account not found"    
} 
}

Response Parameters

Parameter	Format/Data Type	Pattern	Description
requestId	String	MaxLength:50	The unique request ID generated from the request.
responseId	String	MaxLength:50	The unique Response Identifier (generated by GreenDot).
responseDateTime	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	Numeric	MaxLength:4	Indicates success and failure of the response codes. It is in the numeric format.
responseDescription	String	MaxLength:255	Describes the Response Code in more detail. It is in the String format.
bankName	String	"GO2bank"	Bank name of the account.
abaRoutingNumber	String	"124303162"	Routing number of the account.
achReferenceNumber	String	"16360932138674"	ACH Reference number of the account.

Response Cases

Code	CodeText	ResponseDescription	Description
0	Success		Success.
100	InvalidParameter	• RequestId is required • RequestDateTime is required • UserId is required • StoreId is required • MerchantId is required • Either AccountNumber or AccountIdentifier is required • RequestId is too long • UserId is too long • StoreId is too long • MerchantId is too long • Invalid length of AccountNumber	Invalid parameter in the request. Examples: MerchantID not supplied, StoreID not supplied.
110	InvalidAccountNumber	• Account Status is Locked • Account Status is Restricted • Account Status is Pending • Account Status is Closed • Account Not Found. • InvalidAccountNumber	Account is not found; account status is not valid
130	InvalidMerchant	InvalidMerchant	MerchantId in request has not been found/enabled in the system.
600	UnableToProcessRequest		Error when getting DD info.
800	InvalidStore	Store was not found	Store is not found; store is not for the partner or store does not support this operation.
861	RetailChainUserNotFound	User is not found.	UserID in request is not found in system.
862	RetailChainUserNotActive	User is not active.	UserId in request is not active.
823	CardStatusInvalid	CardStatusInvalid	CardStatus is not activated. Canot retrieve DD info.
1000	GeneralFailure	GeneralFailure	Service failure.