Cancel

Cancels a Debit or Credit while it is still in Accepted status, before being Originated. If a transaction has already been Originated, then instead of being Cancelled, it will have to be Refunded.

Endpoints

URL

XML Endpoint

/EPNAPI/ACH.aspx

CGI

/EPNAPI/ACHXML.aspx

XML

Pages of Note

Transactions Status Flow

Transaction Errors and Severity Levels

Transaction Status Codes Guide

Parameters

Parameter Name

Type

Character Limit

Required

Notes

Method

String

20

Yes

“Cancel". This parameter is not submitted to WebService interfaces because it is implied by the WebService method being called.

Version

String

15

Yes

Version of the API with which you integrated. Should be at least "1.4.2".

ResponseXML

Boolean

5

 

"True" for an XML response. "False" (default) for a simple text response. The "ResponseXML" parameter is not submitted to XML interfaces because they always return an XML response.

Test

Boolean

5

 

"True" if this is just a test that should not be finalized. "False” (default) if this is a live/production request

Login

String

16

Yes

Normally this is the merchant's 6-digit Company Number.

Password

String

16

Yes

 

TransactionID

Int64

20

Depends

Number assigned by Check Commerce to the transaction which is to be Cancelled.

ReferenceNumber

String

40

Depends

Identifier assigned by merchant to the transaction which is to be Cancelled.

Notes

String

60

Explanation for the Cancel, to be stored for convenience.

Request Samples

/EPNAPI/ACH.aspx

Request

EPNAPI/ACH.aspx?Method=Cancel&Version=1.4.2.35&Login={MerchantNumber}&Password={MerchantPassword}&TransactionId=1904885692

Response

Method=Cancel
Version=1.4.2.35
Test=True
Success=True
Severity=0
Message=Transaction Cancelled.
TransactionID=1904885692
Status=Cancelled
ApprovalCode=
Note=PrevPay: nil +0
Note=Score: 100/100
Note=Cancellation Notes: 
Score=nil

/EPNAPI/ACHXML.aspx

Request

<?xml version="1.0"?>
<Response Method="Cancel" Version="1.4.2.35" Test="True" Success="True" Severity="0" TransactionID="1904885694" Status="Cancelled" ApprovalCode="">
    <Message>Transaction Cancelled.</Message>
    <Notes>
        <Note>PrevPay: nil +0</Note>
        <Note>Score: 100/100</Note>
        <Note>Cancellation Notes: </Note>
    </Notes>
    <Scores>
        <Score>nil</Score>
    </Scores>
</Response>

Response

<ACH>
    <Method>Cancel</Method>
    <Version>1.4.2.35</Version>
    <Login>999997</Login>
    <Password>demoacct</Password>
    <TransactionID>1904885694</TransactionID>
</ACH>

Search