API Exporting Inactive Customers
Inactive Customer Information may be exported through the PayTrace API at any time allowing customer activity to be viewed. The request will need to have the value of "ExportInactiveCustomers" used as the Method.
Export Inactive Customers Request
Required Name Value Pairs
UN, PSWD, TERMS, METHOD, DAYS
Sample Export Inactive Customers Request
‘format the request string to export all of the customer profiles for the demo account
strRequest = “UN~demo123|PSWD~demo123|TERMS~Y|METHOD~ExportInactiveCustomers|DAYS~30|”
strResponse = SendPayTraceAPIRequest(strRequest) ‘defined in Referencing the API Page
Request Response
Returned Name Value Pairs
CUSTID, BNAME, LASTTRANX, LASTCHECK, WHEN.
Example of Parsing an Export Customers Response
‘declare tools to loop through the response and store the current name / value pair
Dim arrResponse() as String
Dim arrPair() as String
Dim Counter as Integer
Dim arrSUBResponse() as String
Dim arrSUBPair() as String
Dim SUBCounter as Integer
‘declare the tools to store the values of the appropriate responses
Dim strError As String
‘…declare all of the individual fields (i.e. BNAME, LASTTRANX, etc) that you wish to catch.
‘check to make sure the response was not empty/invalid
if strResponse <> “” and inStr(strResponse,”|”) > 0 and inStr(strResponse,”~”) > 0 then
arrResponse = split(strResponse, “|”) ‘split the response into an array of name/value pairs
for Counter = 0 to uBound(arrResponse)-1
arrPair = split(arrResponse(Counter), “~”)
If UCase(arrPair(0)) = "ERROR" Then
StrError = strError & arrPair(1)
ElseIf UCase(arrPair(0)) = "CUSTOMERRECORD" Then
arrSUBResponse = split(arrPair(1), “+”)
for SUBCounter = 0 to uBound(arrSUBResponse)-1
arrSUBPair = split(arrResponse(SUBCounter), “=”)
If UCase(arrSUBPair (0)) = "CUSTID" Then
Msgbox “Customer ID = “ & arrSUBPair (1)
ElseIf UCase(arrSUBPair (0)) = "BNAME" Then
Msgbox “Billing Name = “ & arrSUBPair (1)
ElseIf UCase(arrSUBPair (0)) = "LASTTRANX" Then
Msgbox “Date of Last Transaction = “ & arrSUBPair (1)
End If
next
End If
next
Else
StrError = StrError & “The response from the PayTrace API was invalid."
End if
If StrError <> “” then
MsgBox “Inactive customer export was not successful per the following error: ” & StrError
Else
MsgBox “Inactive customer export was successful”
End if
page revision: 3, last edited: 22 Sep 2014 16:32