Managing A Check

Managing checks through the PayTrace API may only be accomplished by providing the check ID of the unsettled check and the type or status that you’d like to assign it. CheckType (status) may be set to Void, Hold, or Fund (Capture). Please note that some check processors, such as Paya, do not support Void, Hold, and Fund requests.

Manage a Check Request

Required Name Value Pairs


Optional Name Value Pairs For Manage a Check Request
  • The check amount may be revised when sending a request to manage a check that’s not processed by a real-time check processor.

Sample Manage a Check Request

‘format the request string to process a void transaction ID 1539 from settlement
strRequest = “UN~demo123|PSWD~demo123|TERMS~Y|METHOD~ManageCheck|”
strRequest = strRequest & “CHECKTYPE~Void|CheckID~1539|”
strRequest = “PARMLIST=” & URLEncode(strRequest)

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

Request Response

Returned Name Value Pairs

Responses elicited from a ProcessCheck request of ManageCheck and a CheckType of void, hold, or fund will always return either one or more error messages or a set of responses. Successful responses will always include: RESPONSE, CHECKIDENTIFIER

Example of Parsing a Manage 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

‘declare the tools to store the values of the appropriate responses
Dim strError As String
Dim strResponseMessage As String
Dim strCheckID As String

‘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)) = "RESPONSE" Then
            strResponseMessage = arrPair(1)
        ElseIf UCase(arrPair(0)) = " CHECKIDENTIFIER" Then
            strCheckID = arrPair(1)
        End If 
    StrError = StrError  & “The response from the PayTrace API was invalid."
End if

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