Direct Deposit Form

Direct Deposit Form API Method

This operation is used to get the direct deposit form for customer.

📘

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

Syntax

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

Example Request

Success Request

POST {baseUrl}/card/direct-deposit-form
Authorization: bearer {token}
Content-Type: application/json
X-GD-RequestId: 227ed887-8bc7-4e97-9173-a8ead91effc0

{
  "fullName": "zpqtD oNoJV",
  "achReferenceNumber": "16364336696326",
  "abaRoutingNumber": "124303162",
  "bankName": "GO2bank",
  "addressLine1": "298 Peachtree Street, SUITE 132",
  "addressLine2": "Atlanta, GA, 98366",
  "metadata": {
    "storeId": "abc123",
    "merchantId": "FSCC0342",
    "userId": "TellerIDwruaQnIt",
    "requestDateTime": "2024-07-23T07:09:46.0000000+00:00",
    "registerId": "5399860082642512131121312121213121212121"
   }
}

Negative Request

POST {baseUrl}}/card/direct-deposit-form
Authorization: bearer {token}
Content-Type: application/json
X-GD-RequestId: 66219996371691

{
  "fullName": "",
  "achReferenceNumber": "",
  "abaRoutingNumber": "",
  "bankName": "",
  "addressLine1": "",
  "addressLine2": "",
  "metadata": {
    "storeId": "", ---------------------- Invalid OR Missing StoreId
    "merchantId": "FSCC0342",
    "userId": "TellerIDwruaQnIt",
    "requestDateTime": "2024-07-23T07:09:46.0000000+00:00",
    "registerId": "5399860082642512131121312121213121212121"
   }
}

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

2024-08-13T12: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

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 offline store of retailer.
If not supplied, InvalidParameter (Code:100) error will be return.

registerId

No

String

Register where the transaction occurred.

merchantId

Yes

String

MaxLength: 20

Unique merchant Id. It is defined by Green Dot – Merchant corresponding with Retailer.

fullName

No

String

MaxLength: 20

The First Name, Middle Name and Last Name of the customer.

achReferenceNumber

No

String

“16360932138674”

ACH Reference number of the account.

abaRoutingNumber

No

String

“124303162”

Routing number of the account.

bankName

No

String

"GO2bank"

Bank name of the account.

addressLine1

No

String

Max: 30

The mailing address of the customer.

addressLine2

No

String

Max: 30

Second line of address of customer, may include City/State/Zipcode

Example Response

Success Response

HTTP/1.1 200 OK
Content-Type: application/json
X-GD-RequestId: 66219996371691
X-GD-ResponseId: 0648d859-f7e3-4d51-a164-af4d2614dc90
X-GD-ResponseCode: 0
{
"metadata": {
"requestId": "227ed887-8bc7-4e97-9173-a8ead91effc0",
"responseId": "0648d859-f7e3-4d51-a164-af4d2614dc90",
"responseDateTime": "2024-08-27T10:30:56.884207Z",
"responseCode": 0,
"responseDescription": "Success"
},
"output”="<base64 pdf file>”

}

Negative Response

HTTP/1.1 200 OK
Content-Type: application/json
X-GD-RequestId: 66219996371691
X-GD-ResponseId: 160d9d1b-c528-425c-ad09-01ade5fb5fa9
X-GD-ResponseCode: 800
{
	"metadata": {
		"requestId": "227ed887-8bc7-4e97-9173-a8ead91effc0",
		"responseId": "160d9d1b-c528-425c-ad09-01ade5fb5fa9",
		"responseDateTime": "2024-08-27T10:30:56.884207Z",
		"responseCode": 800,
		"responseDescription": "Store was not found"
	}
}

Response Parameters

Parameter

Required(Y/N)

Format/Data Type

Pattern

Description

requestId

Yes

String

MaxLength:50

The unique request ID from request.

responseId

Yes

String

MaxLength:50

The unique Response Identifier (generated by GreenDot).

responseDateTime

Yes

DateTime

2024-098-13T16: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

Yes

Numeric

MaxLength:4

Indicates success and failure of the response codes. It is in the numeric format.

responseDescription

Yes

String

MaxLength:255

Describes the Response Code in more detail. It is in the String format.

output

Yes

base64 byte

PDF File for Download

Return base64 pdf field

Response Cases

Code

CodeText

ResponseDescription

Description

0

Success

Success

100

InvalidParameter

• RequestId is too long
• UserId is too long
• StoreId is too long
• MerchantId is too long
• RequestId is required
• RequestDateTime is required
• UserId is required
• StoreId is required
• MerchantId is required

Invalid parameter in the request. Examples: MerchantID not supplied, StoreID not supplied.

130

InvalidMerchant

InvalidMerchant

MerchantId in request has not been found/enabled in the system.

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.

1000

GeneralFailure

GeneralFailure

Service failure.