ACHVOID

ACHVOID cancels an ACH transaction that has been previously submitted BUT NOT settled to the bank.

Successful requests will be indicated with a 2xx HTTP response code and the Approved attribute set to 'true'.

NOTE

It is possible to receive an HTTP 2xx response code indicating that the request was successfully received, understood, and processed at the HTTP protocol level, but still have the Approved attribute set to false. (A 2xx response code with an Approved attribute set to false means the server successfully handled the request itself; however the actual business or application logic determined that the request was not approved).

Conditions around ACHVOID

PayNetWorx performs settlement functions in the background throughout the day. This means that we are unable to provide a definitive cut-time after which a submitted ACH could be voided. It could be an hour, it could be 15 minutes.

Available Functions

Perform an 'achvoid' transaction

POST, /v0/transaction/achvoid

REQUEST Object Attributes

View REQUEST Object Attributes

achVoidTable

Attribute	Data Type	Description	Required
TransactionID	ksuid	TransactionID (from ACHDEBIT / ACHCREDIT response)	True
Reason	string	Reason for void	True
Detail	object	Transaction Details	False
MerchantData	object	Merchant Defined Transaction Data (supports 1 or more Merchant Defined Keys) MerchantData is aKey/Value of the "Detail" Object	False
MerchantDefinedKey1	string	Merchant - defined transaction data (field 1) MerchantDefinedKey1 is aKey/Value of the "Detail" > "MerchantData" Object	False
MerchantDefinedKey2	string	Merchant - defined transaction data (field 2) MerchantDefinedKey2 is aKey/Value of the "Detail" > "MerchantData" Object	False
TransactionEntry	object	See Transaction Entry Section (Information about transaction entry)	False

REQUEST Example

Code Sample using CURL

URL=https://api.qa.paynetworx.net/v0/transaction/achvoid
HTTPAUTHTOKEN=1fHfjpw86udrDQHRMKabypEmhY4:1fHfkJrOs7iVBnC07HDxCPZuPsK
curl -sS --user $HTTPAUTHTOKEN -H 'Content-Type: application/json' -H "Request-ID: $(ksuid)" $URL -d '
{
    "TransactionID": "1XSnl0X7GC44qPT2CVV8BCz0bQi",
    "Reason": "customer-cancellation",
    "Detail": {
        "MerchantData": {
            "OrderNumber": "22-1111",
            "CustomerID": "991111",
            "VoidReason": "Loan already paid"
        }
    }
}'

RESPONSE Object Attributes

View RESPONSE Object Attributes

defaultResponseTable

Attribute	Data Type	Description
TransactionID	ksuid	Unique transaction lifetime system ID
EventID	ksuid	Unique transaction event system ID
RequestID	ksuid	Unique transaction request system ID
ResponseText	string	Response Message Text
Approved	boolean	Request approval indicator

RESPONSE Example

JSON Response Object

{
  "TransactionID": "1XSnl0X7GC44qPT2CVV8BCz0bQi",
  "EventID": "1XSnvq7J5ggxZg70sWuRg4kEBcu",
  "RequestID": "1XSnzEjZ4IBh5Nj0OEVPTWpwYo8",
  "ResponseText": "ACH void approved",
  "Approved": true
}