Auth

Retail Consumption Auth (Step 1 of 2-Phase)

Perform necessary validation and place a hold on the transaction (Step 1 of 2-Phase). Return with appropriate response for the auth result. On successful response, Green Dot will hold the funds and it cannot be used for another Auth or Transact request[Please see Appendix A for response code details]

A successful response to an Auth by a GDN Partner (Partner-hosted/PUSH) implies that the AuthCommit request will be honored.Any exceptions to this will be handled during the settlement process.

Diagrams below describe the structures of the AuthRequest and AuthResponse objects:

Details of each attribute in the AuthRequestand AuthResponseobjects should belisted in the expected order in the tables below:

Auth Request

RequestHeader

Field

Required

Type

Max Length

Description

CustomerANI

Optional

String

10

Phone number area code first. To be provided if initiated by IVR. Must be all numerical digits Either CustomerIP or CustomerANI needs to be provided

CustomerIP

Optional

String

20

Web users IP address. To be provided if initiated by Web.Either CustomerIP or CustomerANI needs to be provided

PartnerIP

Optional

String

20

Partner’s IP address. To be provided if initiated by Web.

PartnerCode

Yes

String

50

Unique code to identify partner.

Password

Optional

String

50

Password for authentication

UserName

Optional

String

50

UserName as provided by Green Dot for authentication

Channel

Yes

Integer

N/A

“1” for Unknown“2” for web application“3” for IVR“4” for Desktop“5” for Stores POS"6" for Mobile

RequestDateTime

Yes

DateTime

N/A

Timestamp of Submitted Request in UTC time.

RequestID

Yes

String

50

Unique Request Identifier.

Version

Yes

String

10

Value = 2.0.0Format: <Major version>.<Minor Version>.<Revision>

Amount

Yes

Decimal

N/A

Transaction Amount.

AuthLifeSpan

Yes

String

3

The time period for which this Auth request is valid. If AuthCommit Request is not received by this time, the Auth should be voided.Position 1 -time code1 Calendar days2 Hours3 MinutesPosition 2-3 -time interval0-99 A value of 01 through 99 indicating the number of repetitions indicated in position 1.Ex: ‘131’ (= 31 calendar days)
Note: Calendar days are calculated as:RequestDate (date & time, local transaction) e.g.: 06 mar01:160114 calendar days means that authorization will expire. 20 mar01:2359

Customer

Field

Required

Type

Max Length

Description

Address1

N/A

String

35

Address

Address2

N/A

String

35

Address

City

N/A

String

25

City

CustomerReferenceNumber

N/A

String

50

Customer reference number.

DLNumber

N/A

String

30

Driver License Number or State ID.

DLState

N/A

String

2

Driver License Number or State ID issue state.

DOB

N/A

String

10

Date of Birth. YYYY-MM-DD

FirstName

N/A

String

25

First Name of Customer.

LastName

N/A

String

25

Last Name of Customer.

MiddleName

N/A

String

25

Middle Name of Customer.

Phone

N/A

String

10

Phone Number.

SSN

N/A

String

9

Preferred to have customer full SSN or Tax ID else last 4 digits of customer SSN or Tax ID required.

State

N/A

String

2

State

ZipCode

N/A

String

10

USPS zip code.

Description

Yes

String

255

Description for this request

DictionaryEntry

Optional

Dictionary<string, string>

N/A

Array of key-value pairs.For swipe transactions this may include store information. For Disbursement transactions, this may include the StatementIdentifier: <transaction description>

PartialApproval

Yes

Boolean

N/A

Default=false. Reserved for Future. To approve a portion of the original transaction amount in the authorization request when the transaction amount exceeds the funds available on the Green Dot Product.

PaymentType

Yes

Integer

N/A

“1” for Cash
“2” for Check
“3” for MoneyPak
“7” for BarCode
“8” for Direct Deposit
“9” for Mobile Remote Deposit Capture (MRDC)

ProgramNumber

Yes

String

20

Program identifier. Example: BIN

SourceAccount

Information regarding the Account from which the funds will be moved. Ex: MoneyPak

Field

Required

Type

Max Length

Description

AccountNumber

Yes

String

50

Account Number or Barcode number of the given AccountType.

AccountReferenceNumber

Yes

String

50

Reference Number of the given AccountType. For Barcode funding, this will be the barcode transaction number. For MoneyPak, this will be the PIN reference number. For Disbursements, this will be the Green Dot Customer reference number

AccountType

Yes

Integer

N/A

“1” for MoneyPak PIN
“4” for POS Cash Funding
“5” for Check Funding
“6” for Promotion Funding
“7” for Barcode Funding
“8” for Disbursement
“9” for Barcode Cash Pick-Up

SubAccountNumber

N/A

String

50

SubAccountReferenceNumber

N/A

String

50

TargetAccount

Information regarding the Account to which the funds will be moved. Ex: Partner’s Customer Account

Field

Required

Type

Max Length

Description

AccountNumber

Yes

String

50

Customer Account Number.

AccountReferenceNumber

Optional

String

50

Partner's unique reference number identifying customer account.

AccountType

Yes

Integer

N/A

“2” for Partner’s Customer –Card
“3” for Partner’s Customer –Other

SubAccountNumber

Optional

String

50

Customer’s sub account number.

SubAccountReferenceNumber

Optional

String

50

Partner's unique reference number identifying customer’s sub-account.

TransactionReferenceNumber

Optional

String

50

Unique Identifier for this request

Auth Response

📘

FirstName, LastName, ZipCode are required for ALL GDN Partners, including Point of Banking (POB) Partners.

ResponseHeader

Field

Required

Type

Max Length

Description

RequestID

Yes

String

50

Request Identifier echoed back from request

ResponseCode

Yes

String

2

Indicates successful and non-successful responses.

ResponseDateTime

Yes

DateTime

N/A

Timestamp of response in UTC time.

ResponseID

Yes

String

50

Unique Response Identifier

ResponseText

Yes

String

255

Response code description.

Version

Yes

String

10

Value = 2.0.0Format: <Major version>.<Minor Version>.<Revision>

AuthorizedAmount

Yes

Decimal

N/A

Actual authorized Amount

Balance

Optional

Decimal

N/A

Target Account Balance. Only if response is success.

ConfirmationID

Yes

String

50

Unique Transaction Confirmation number. Only if response is success.For AccountType “7” (Barcode Funding), the ConfirmationID will be sent to user via email/SMS. Green Dot and partner customer support teams may use this value to look-up/search transactions

Customer

FieldRequiredTypeMax LengthDescription
Address1OptionalString35Address
Address2OptionalString35Address
CityOptionalString25City
CustomerReferenceNumberYesString50Customer reference number.
DLNumberOptionalString30Driver License Number or State ID.
DLStateOptionalString2Driver License Number or State ID issue state.
DOBOptionalString10Date of Birth. YYYY-MM-DD
FirstNameYesString25First Name of Customer.
LastNameYesString25Last Name of Customer.
MiddleNameOptionalString25Middle Name of Customer.
PhoneOptionalString10Phone Number.
SSNOptionalString9Preferredtohave customer full SSN or Tax IDelse last 4 digits of customer SSN or Tax IDrequired.
StateOptionalString2State
ZipCodeYesString10USPS zip code.
DictionaryEntryN/ADictionary<string, string>N/AArray of key-value pairs.
OriginalAmountYesDecimalN/AAmount requested for authorization

SourceAccount

Information regarding the Account from which the funds will be moved. Ex: MoneyPak

Field

Required

Type

Max Length

Description

AccountNumber

Yes

String

50

Account Number or Barcode number of the given AccountType.

AccountReferenceNumber

Yes

String

50

Reference Number of the given AccountType. For Barcode funding, this will be the barcode transaction number. For MoneyPak, this will be the PIN reference number. For Disbursements, this will be the Green Dot Customer reference number

AccountType

Yes

String

N/A

“1” for MoneyPak PIN
“4” for POS Cash Funding
“5” for Check Funding
“6” for Promotion Funding
“7” for Barcode Funding
“8” for Disbursement
“9” for Barcode Cash Pick-Up

SubAccountNumber

Optional

String

50

SubAccountReferenceNumber

Optional

String

50

TargetAccount

Information regarding the Account to which the funds will be moved. Ex: Partner’s Customer Account

Field

Required

Type

Max Length

Description

AccountNumber

Yes

String

50

Customer Account Number.

AccountReferenceNumber

Yes

String

50

Partner's unique reference number identifying customer account.

AccountType

Yes

String

N/A

“2” for Partner’s Customer –Card
“3” for Partner’s Customer –Other

SubAccountNumber

Optional

String

50

Customer’s sub account number.

SubAccountReferenceNumber

Optional

String

50

Partner's unique reference number identifying customer’s sub-account.

Sample Request/Response

Request

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"><s:Body><Auth xmlns="http://greendotcorp.com/WebServices/Corporate/GDNPartnerAPI/"><request xmlns:a="https://partners.greendotcorp.com/GDCPartners/GDCWS_GDNPartnerAPI/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"><a:Audit i:nil="true"></a:Audit><a:Authentication><a:PartnerCode>GreenDot</a:PartnerCode><a:Password>*****</a:Password><a:UserName>*****</a:UserName></a:Authentication><a:Channel>5</a:Channel><a:RequestDateTime>2020-01-20T10:05:02.9129305Z</a:RequestDateTime><a:RequestID>TestAuth2020-01-20T18:01:37</a:RequestID><a:Version>2.0.0</a:Version><a:Amount>10.0000</a:Amount><a:AuthLifeSpan>210</a:AuthLifeSpan><a:Customer i:nil="true"></a:Customer><a:Description>Test Auth</a:Description><a:DictionaryEntry i:nil="true" xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><b:KeyValueOfstringstring><b:Key>Partner</b:Key><b:Value>***</b:Value></b:KeyValueOfstringstring><b:KeyValueOfstringstring><b:Key>StoreNumber</b:Key><b:Value>***</b:Value></b:KeyValueOfstringstring><b:KeyValueOfstringstring><b:Key>StoreState</b:Key><b:Value>*****</b:Value></b:KeyValueOfstringstring><b:KeyValueOfstringstring><b:Key>StoreName</b:Key><b:Value>****</b:Value></b:KeyValueOfstringstring><b:KeyValueOfstringstring><b:Key>StoreCity</b:Key><b:Value>******</b:Value></b:KeyValueOfstringstring><b:KeyValueOfstringstring><b:Key>StoreAddress1</b:Key><b:Value>******Chichester Ave</b:Value></b:KeyValueOfstringstring><b:KeyValueOfstringstring><b:Key>StoreAddress2</b:Key><b:Value>******</b:Value></b:KeyValueOfstringstring><b:KeyValueOfstringstring><b:Key>StoreZipcode</b:Key><b:Value>******</b:Value></b:KeyValueOfstringstring><b:KeyValueOfstringstring><b:Key>RetailerName</b:Key><b:Value>******</b:Value><b:KeyValueOfstringstring></a:DictionaryEntry><a:PartialApproval>false</a:PartialApproval><a:PaymentType>1</a:PaymentType><a:ProgramNumber>451062</a:ProgramNumber><a:SourceAccount><a:AccountNumber></a:AccountNumber><a:AccountReferenceNumber>10******************02</a:AccountReferenceNumber><a:AccountType>4</a:AccountType><a:SubAccountNumber i:nil="true"></a:SubAccountNumber><a:SubAccountReferenceNumber></a:SubAccountReferenceNumber></a:SourceAccount><a:TargetAccount><a:AccountNumber>45******************23</a:AccountNumber><a:AccountReferenceNumber>44************41</a:AccountReferenceNumber><a:AccountType>2</a:AccountType><a:SubAccountNumber>js******************m</a:SubAccountNumber><a:SubAccountReferenceNumber i:nil="true"></a:SubAccountReferenceNumber></a:TargetAccount><a:TransactionReferenceNumber i:nil="true"></a:TransactionReferenceNumber></request></Auth></s:Body></s:Envelope>

Response

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"><soap:Body><ns2:AuthResponse xmlns="https://partners.greendotcorp.com/GDCPartners/GDCWS_GDNPartnerAPI/" xmlns:ns2="http://greendotcorp.com/WebServices/Corporate/GDNPartnerAPI/" xmlns:ns3="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:ns4="http://schemas.microsoft.com/2003/10/Serialization/"><ns2:AuthResult><RequestID>TestAuth2020-01-20T18:01:37</RequestID><ResponseCode>00</ResponseCode><ResponseDateTime>2020-01-20T04:05:04</ResponseDateTime><ResponseID>4055427293</ResponseID><ResponseText>Success</ResponseText><Version>2.0.0</Version><AuthorizedAmount>10.0000</AuthorizedAmount><Balance>665.80</Balance><ConfirmationID>4055427293</ConfirmationID><Customer><Address1>1903 INGERSOL PL</Address1><Address2 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"></Address2><City>NEW PORT RICHEY</City><CustomerReferenceNumber>6870963037</CustomerReferenceNumber><DLNumber xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"></DLNumber><DLState xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"></DLState><DOB>1999-12-20</DOB><FirstName>*****</FirstName><LastName>*****</LastName><MiddleName xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"></MiddleName><Phone>**********</Phone><SSN>68******63</SSN><State>FL</State><ZipCode>33552</ZipCode></Customer><DictionaryEntry xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"></DictionaryEntry><OriginalAmount>10.0000</OriginalAmount><SourceAccount><AccountNumber>83**********************13</AccountNumber><AccountReferenceNumber>10******************02</AccountReferenceNumber><AccountType>4</AccountType><SubAccountNumber xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"></SubAccountNumber><SubAccountReferenceNumber></SubAccountReferenceNumber></SourceAccount><TargetAccount><AccountNumber>45******************23</AccountNumber><AccountReferenceNumber></AccountReferenceNumber><AccountType>2</AccountType><SubAccountNumber>js******************om</SubAccountNumber><SubAccountReferenceNumber xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"></SubAccountReferenceNumber></TargetAccount></ns2:AuthResult></ns2:AuthResponse></soap:Body></soap:Envelope >