Refund

Creates an ACH Refund Transaction.

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

Endpoint Details

Parameter Name

Type

Character Limit

Basic Requirements

Notes

Method

String

20

Yes

"Refund".  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

Optional

"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 Refunded.1

ReferenceNumber

String

40

Depends

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

Amount

Decimal

9

Depends

U.S. Dollars.  0 for the original amount, any other lower amount for a partial refund.

Notes

String

60

Optional

Explanation for the Refund, to be stored for convenience.

CustRefId

String

Optional

User information field, can be used to store additional data as needed.

Addenda

String

80

Optional

Please note that the information provided in the notes is for informational purposes only. We maintain updates in the notes field as they progress through our system during processing. Please be aware that notes may change at any time and should not be relied upon for data parsing.

/EPNAPI/ACH.aspx

Request

/EpnApi/ACH.aspx?Method=Refund&Version=1.4.2.34&Login={MerchanLogin}&Password={MerchantPassword}&Test=true&TransactionID=1904884973&Amount=0

Response

Network=ACH
Method=Refund
Version=1.4.2
Test=True
Success=True
Severity=0
Message=Transaction refunded in the amount of $150.00
TransactionID=1904884973
Status=Accepted
Note=Refund Notes:

/EPNAPI/ACHXML.aspx

Request

<ACH>
    <Method>Refund</Method>
    <Login>{Merchant Login}</Login>
    <Password>{Merchant Password}</Password>
    <Version>1.4.2.34</Version>
    <Test>true</Test>
    <TransactionID>1904884973</TransactionID>
    <Amount>0</Amount>
</ACH>

Response

<?xml version="1.0"?>
<Response Network="ACH" Method="Refund" Version="1.4.2" Test="True" Success="True" Severity="0" TransactionID="1904885768" Status="Accepted"> 
  <Message>Transaction refunded in the amount of $150.00</Message> 
  <Notes> 
    <Note>Refund Notes: </Note> 
  </Notes> 
</Response>

Search