API Exporting Check Information

Check information may be exported through the PayTrace API at any time allowing check records to be viewed without being stored on the client computer.

Exporting Check Request

Required Name Value Pairs

UN, PSWD, TERMS, SDATE, EDATE, METHOD (SDATE and EDATE are not required if passing CHECKID)

Optional Name Value Pairs For Exporting Check Request


Sample Exporting Check Request

‘format the request string to export all of the transactions for the demo account processed in the first ‘week of December 2010
strRequest = “UN~demo123|PSWD~demo123|TERMS~Y|METHOD~ExportCheck|”
strRequest = strRequest & “SDATE~12/01/2010|EDATE~12/07/2010|”

strResponse = SendPayTraceAPIRequest(strRequest) ‘defined in Referencing the API Page

Request Response

Returned Name Value Pairs

Responses elicited from an ExportCheck request will always return either one or more error messages or one or more check records.

Example of Parsing an Export Check 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, BADDRESS, 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)) = "CHECKRECORD" Then
            arrSUBResponse = split(arrPair(1), “+”)
            for SUBCounter = 0 to uBound(arrSUBResponse)-1
                arrSUBPair = split(arrResponse(SUBCounter), “=”)
                If UCase(arrSUBPair (0)) = "BNAME" Then
                    Msgbox “Billing Name = “ & arrSUBPair (1)
                ElseIf UCase(arrSUBPair (0)) = "BADDRESS" Then
                    Msgbox “Billing Address = “ & arrSUBPair (1)
                End If 
        End If 
    StrError = StrError  & “The response from the PayTrace API was invalid."
End if 

If StrError <> “” then
    MsgBox “Check export was not successful per the following error: ” & StrError
    MsgBox “Check export was successful”
End if