AuthVoid

Cancels the transaction authorized in the Auth request (in case of 2-Phase). Return with appropriate response for the void result. On successful response, Green Dot will release the funds and the Partner is expected to release the Auth against the customer’s account. [Please see Appendix A for response code details.]

AnAuthVoid request can be sent in case a response was not received for the AuthRequest in a timely manner or a Void was sent by the Retailers POS within the Green Dot void delay timeframe.

Important Notes:

In the event a matching Auth Request was not found on the partner system, Green Dot expects an AuthVoidResponse with the ResponseCode “00”, indicating theAuth Request was notfound
In the event the partner already voided the transaction, Green Dot expects an AuthVoidResponse with the ResponseCode “00”, indicatingthe Auth was previously voided
The only instance an AuthVoidRequest should be rejected is when the partner finds the Auth request and explicitly declines the request to Void the transactionDiagrams below describe the structures of the AuthVoidRequestand AuthVoidResponseobjects:

Diagrams below describe the structures of the AuthVoidRequest and AuthVoidResponse objects:

Details of each attribute in the AuthVoidRequest and AuthVoidResponse objects are listed in the tables below:

AuthVoid Request

RequestHeader

Field	Partner-hosted/PUSH (Required?)	GreenDothosted/PULL (Required?)	Type	Max Length	Description
CustomerANI	Optional	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	Optional	String	20	Web users IP address. To be provided if initiated by Web.Either CustomerIP or CustomerANI needs to be provided
PartnerIP	Optional	Optional	String	20	Partner’s IP address. To be provided if initiated by Web.
PartnerCode	Yes	Yes	String	25	Unique code to identify partner.
Password	Optional	Optional	String	512	Password for authentication
UserName	Optional	Optional	String	50	UserName for authentication
Channel	Yes	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	Yes	DateTime	N/A	Timestamp of Submitted Request in UTC time.
RequestID	Yes	Yes	String	50	Unique Request Identifier.
Version	Yes	Yes	String	10	Value = 2.0.0Format: `<Major version>.<Minor Version>.<Revision>`
Amount	Yes	Optional	Decimal	N/A	Transaction Amount.
Description	Yes	Yes	String	255	Description for this request
DictionaryEntry	Optional	Optional	Dictionary<string, string>	N/A	Array of key-value pairs.
OriginalRequestID	Yes	Yes	String	50	RequestID for the original TransactRequest or AuthCommitRequest
PaymentType	Yes	Yes	Integer	N/A	”0” for NULL
ProgramNumber	Yes	Yes	String	20	Program identifier. Example: BIN, Settlement Group Reference ID

SourceAccount

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

Field	Partner-hosted/PUSH (Required?)	GreenDothosted/PULL (Required?)	Type	Max Length	Description
AccountNumber	Yes	Yes	String	50	Account Number or Barcode number of the given AccountType.
AccountReferenceNumber	Optional	Optional	String	50	Reference Number of the given AccountType.For Barcode funding, this will be the barcode transaction number. For MoneyPak, this is the PIN reference number. For Disbursements, this will be the Green Dot Customer reference number
AccountType	Yes	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	N/A	String	50
SubAccountReferenceNumber	N/A	N/A	String	50

TargetAccount

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

Field	Partner-hosted/PUSH (Required?)	GreenDothosted/PULL (Required?)	Type	Max Length	Description
AccountNumber	Yes	Yes	String	50	Customer Account Number.
AccountReferenceNumber	Optional	Yes	String	50	Partner's unique reference number identifying customer account.
AccountType	Yes	Yes	Integer	N/A	“2” for Partner’s Customer –Card “3” for Partner’s Customer –Other
SubAccountNumber	Optional	Optional	String	50	Customer’s sub account number.
SubAccountReferenceNumber	Optional	Optional	String	50	Partner's unique reference number identifying customer’s sub-account.

AuthVoid Response

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

ResponseHeader

Field	Partner-hosted/PUSH (Required?)	GreenDothosted/PULL (Required?)	Type	Max Length	Description
RequestID	Yes	Yes	String	50	Request Identifier echoed back from request
ResponseCode	Yes	Yes	String	2	Indicates successful and non-successful responses.
ResponseDateTime	Yes	Yes	DateTime	N/A	Timestamp of response in UTC time.
ResponseID	Yes	Yes	String	50	Unique Response Identifier
ResponseText	Yes	Yes	String	255	Response code description.
Version	Yes	Yes	String	10	Value = 2.0.0Format: `<Major version>.<Minor Version>.<Revision>`
DictionaryEntry	Optional	Optional	Dictionary<string, string>	N/A	Array of key-value pairs.

Sample Request/Response

Request

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"><s:Body><AuthVoid 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:Auditi: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-03-10T14:53:53.2066201Z</a:RequestDateTime><a:RequestID>AuthVoid2020-03-10T22:53:51</a:RequestID><a:Version>2.0.0</a:Version><a:Amount>500.0000</a:Amount><a:Description>AuthVoid by SoapUI</a:Description><a:DictionaryEntry xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><b:KeyValueOfstringstring><b:Key>RetailerName</b:Key><b:Value>******</b:Value></b:KeyValueOfstringstring><b:KeyValueOfstringstring><b:Key>AuthCreateDate</b:Key><b:Value>2020-03-10 7:52:18 AM</b:Value></b:KeyValueOfstringstring></a:DictionaryEntry><a:OriginalRequestID>TestAuth2020-03-10T22:52:05</a:OriginalRequestID><a:PaymentType>0</a:PaymentType><a:ProgramNumber>********</a:ProgramNumber><a:SourceAccount><a:AccountNumber>PG*******************11</a:AccountNumber><a:AccountReferenceNumber>63********20</a:AccountReferenceNumber><a:AccountType>7</a:AccountType><a:SubAccountNumber i:nil="true"></a:SubAccountNumber><a:SubAccountReferenceNumber i:nil="true"></a:SubAccountReferenceNumber></a:SourceAccount><a:TargetAccount><a:AccountNumber>14************09</a:AccountNumber><a:AccountReferenceNumber>14************09</a:AccountReferenceNumber><a:AccountType>3</a:AccountType><a:SubAccountNumber i:nil="true"></a:SubAccountNumber><a:SubAccountReferenceNumber i:nil="true"></a:SubAccountReferenceNumber></a:TargetAccount></request></AuthVoid></s:Body></s:Envelope >

Response

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"><soap:Body><ns3:AuthVoidResponse xmlns="https://partners.greendotcorp.com/GDCPartners/GDCWS_GDNPartnerAPI/" xmlns:ns2="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:ns3="http://greendotcorp.com/WebServices/Corporate/GDNPartnerAPI/" xmlns:ns4="http://schemas.microsoft.com/2003/10/Serialization/"><ns3:AuthVoidResult><RequestID>AuthVoid2020-03-10T22:53:51</RequestID><ResponseCode>00</ResponseCode><ResponseDateTime>2020-03-10T14:53:54.270Z</ResponseDateTime><ResponseID>6522173611763833359264732034138459</ResponseID><ResponseText>Success</ResponseText><Version>2.0.0</Version></ns3:AuthVoidResult></ns3:AuthVoidResponse></soap:Body></soap:Envelope >