ACH Transactions

Transaction Controller

Search for ACH Transactions

get

The search API will return paginated results. Default page-size (results per page) is 25. Dates are stored in UTC - any date related searches should account for this. HATEOAS links will be returned to the response, allowing you to page to the next set of results or the previous.

Query parameters

idanyOptional

Unique id of the ach transaction

typeanyOptional

Type. Allowed values: Debit,Credit

amountanyOptional

Amount of the transaction

routing-numberanyOptional

Routing number

account-typeanyOptional

Account type. Allowed values: Checking, Savings

trace-numberanyOptional

Trace number

check-numberanyOptional

Check number

invoiceanyOptional

Invoice number

date-filteranyOptional

Predefined date ranges that can be searched on (Dates are stored in UTC). Allowed values: last_24_hours, yesterday, last_week, last_month, last_180_days, custom_range

status-change-start-dateanyOptional

Filters the transactions list by the created date/time (Dates are stored in UTC). Setting start date will return transactions that were processed after this date/time. Setting both start and end date creates a range

status-change-end-dateanyOptional

Use with start date to create range (Dates are stored in UTC)

date-formatanyOptional

Date format being used for start or end date (Dates are stored in UTC). Allowed values: MM-dd-yyyy hh:mm a, MM-dd-yy HH:mm, MM-dd-yy HH:mm z, yyyy-MM-dd HH:mm, yyyy-MM-dd HH:mm z

order-idanyOptional

Order Id

pageanyOptional

Page number

page-sizeanyOptional

Page Size

descendinganyOptional

List results in descending order, default is true

order-byanyOptional

Provide the name of one of the allowed search fields and the results will be ordered by this field. Use in combination with descending field.

purchase-orderanyOptional

Purchase order

customer-idanyOptional

Customer Id

descriptionanyOptional

Description

statusanyOptional

Status of transaction. Allowed values: Pending, Settling, Settled, Returned

standard-entry-class-codeanyOptional

PPD = Predetermined Payment and Deposit

email-addressanyOptional

Email address

Header parameters

api-keyanyRequired

api-key-value

Responses

200

OK

application/xmlapplication/json

401

Unauthorized

403

Forbidden

404

Not Found

get

HTTPcURLJavaScriptPython

GET //rest/v2/ach/transactions HTTP/1.1
Host: gateway-sb.clearent.net
Accept: */*

<?xml version="1.0"?>
<object>
	<ach-transaction>
		<check-field>invoice</check-field>
		<client-ip>111.22.22.333</client-ip>
		<dob-year>dob-year</dob-year>
		<email-receipt>true</email-receipt>
		<software-type-version>1.0</software-type-version>
		<type>Debit</type>
		<validate-account>true</validate-account>
		<amount>text</amount>
		<routing-number>text</routing-number>
		<account-number>text</account-number>
		<account-type>Checking</account-type>
		<standard-entry-class-code>PPD</standard-entry-class-code>
		<check-number>text</check-number>
		<create-token>false</create-token>
		<create-description>false</create-description>
		<individual-name>text</individual-name>
		<token-id>1188888888888888</token-id>
		<id>text</id>
		<status>Pending</status>
		<billing>
			<city>City</city>
			<company>Company</company>
			<country>Country</country>
			<first-name>John</first-name>
			<last-name>Doe</last-name>
			<phone>Phone</phone>
			<state>State</state>
			<street>Street</street>
			<street2>Street2</street2>
			<zip>Zip</zip>
		</billing>
		<shipping>
			<city>City</city>
			<company>Company</company>
			<country>Country</country>
			<first-name>John</first-name>
			<last-name>Doe</last-name>
			<phone>Phone</phone>
			<state>State</state>
			<street>Street</street>
			<street2>Street2</street2>
			<zip>Zip</zip>
		</shipping>
		<invoice>text</invoice>
		<purchase-order>text</purchase-order>
		<customer-id>text</customer-id>
		<order-id>text</order-id>
		<email-address>text</email-address>
		<description>text</description>
		<comments>text</comments>
		<billing-is-shipping>true</billing-is-shipping>
		<status-change-date>text</status-change-date>
		<display-message>text</display-message>
		<provider-transaction-id>text</provider-transaction-id>
		<trace-number>text</trace-number>
		<settled-date>text</settled-date>
		<returned-date>text</returned-date>
		<returned-code>text</returned-code>
		<returned-message>text</returned-message>
		<ach-token>
			<account-number>1111</account-number>
			<account-type>Checking</account-type>
			<created>1100000000000000</created>
			<customer-key>customer123</customer-key>
			<default>false</default>
			<individual-name>John Doe</individual-name>
			<last-used>1100000000000000</last-used>
			<merchant-id>000008888</merchant-id>
			<routing-number>081009813</routing-number>
			<times-used>14</times-used>
			<token-description>Travel checking account</token-description>
			<token-id>1100000000000000</token-id>
			<updated>1100000000000000</updated>
		</ach-token>
		<merchant-id>text</merchant-id>
		<terminal-id>text</terminal-id>
		<software-type>MySoftware_Version1.3</software-type>
		<paya-authorization>text</paya-authorization>
	</ach-transaction>
</object>

Post Transaction

post

All ACH transaction types can be performed through this endpoint by specifying within the “type” keypair. We also provide convenience endpoints for each ACH transaction type independently (/ach/transactions/debit or /ach/transactions/credit). The "check-field" keypair can check for a duplicate transaction attempt. The “check-field” points to another field you provide within the request. The field you select needs to have a value. Fields supported: invoice, order-id, purchase-order, check-number.

Example: "check-field": "invoice", "invoice": "invoice1"

A customer's bank account can be validated using the field "validate-account". If the validation fails, an appropriate error message is returned.

Example: "validate-account": "true".

Header parameters

api-keyanyRequired

apiKeyValue

Body

application/xmlapplication/json

This model represents the ach transaction in the response

check-fieldstring · enumOptional

Field to check for duplicate transactions on such as invoice

Example: invoicePossible values:

client-ipstringOptional

Optional client ip address

Example: 111.22.22.333

dob-yearstringOptional

1999, 2000, 2009

Example: dob-year

email-receiptstringOptional

Boolean which signifies whether or not a receipt should be sent

Example: true

software-type-versionstringRequired

Include the version of software-type

Example: 1.0

typestring · enumRequiredPossible values:

validate-accountstring · enumOptional

Set to true when validating account information.

Example: truePossible values:

amountstringOptional

An absolute number with two decimal places.

routing-numberstringRequired

9 digits.

account-numberstringRequired

Account number masked to only show last four

account-typestring · enumRequiredPossible values:

standard-entry-class-codestring · enumRequired

PPD = Predetermined Payment and Deposit

Possible values:

check-numberstringOptional

This value helps with duplicate transaction checking

create-tokenstringOptional

Set to true if you would like to create a token as part of the transaction

Example: false

create-descriptionstringOptional

Pass in when creating a token if you would like to save a description wiht the token

Example: false

individual-namestringOptional

The name of the account holder.

token-idstringOptional

Pass in if you would like to run the transaction with a previously created token. The token replaces routing-number, account-number, account-type and individual name; making those fields unnecessary when paying with a token

Example: 1188888888888888

idstringOptional

Unique id of the ach transaction.

statusstring · enumOptional

Returned from GET and can be used with search filter.

Possible values:

invoicestringOptional

This value helps with duplicate transaction checking

purchase-orderstringOptional

This value helps with duplicate transaction checking

customer-idstringOptional

This value helps with duplicate transaction checking

order-idstringOptional

This value helps with duplicate transaction checking

email-addressstringOptional

Email Address of customer

descriptionstringOptional

A brief description of the product being sold

commentsstringOptional

Any additional comments to be made of the transaction

billing-is-shippingstring · enumOptional

Is the billing address the same as the shipping address?

Possible values:

status-change-datestringOptional

Last date that the status of the transaction changed

display-messagestringOptional

message to be displayed

provider-transaction-idstringOptional

transaction id from the ach provider

trace-numberstringOptional

Trace number associated with a returned or settled transaction

settled-datestringOptional

Date of settled transaction

returned-datestringOptional

Date of a returned transaction

returned-codestringOptional

Code associated with a returned transaction (NACHA)

returned-messagestringOptional

Message associated with a returned transaction (NACHA)

merchant-idstringOptional

Merchant Id of the transaction

terminal-idstringOptional

Terminal Id of the api-key used to create the transaction

software-typestringOptional

Static field referencing the software name you are building

Example: MySoftware_Version1.3

paya-authorizationstringOptional

Paya Authorization

Responses

200

OK

application/xmlapplication/json

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

HTTPcURLJavaScriptPython

POST //rest/v2/ach/transactions HTTP/1.1
Host: gateway-sb.clearent.net
Content-Type: application/xml
Accept: */*
Content-Length: 1683

"<?xml version=1.0?>
<check-field>invoice</check-field>
<client-ip>111.22.22.333</client-ip>
<dob-year>dob-year</dob-year>
<email-receipt>true</email-receipt>
<software-type-version>1.0</software-type-version>
<type>Debit</type>
<validate-account>true</validate-account>
<amount>text</amount>
<routing-number>text</routing-number>
<account-number>text</account-number>
<account-type>Checking</account-type>
<standard-entry-class-code>PPD</standard-entry-class-code>
<check-number>text</check-number>
<create-token>false</create-token>
<create-description>false</create-description>
<individual-name>text</individual-name>
<token-id>1188888888888888</token-id>
<id>text</id>
<status>Pending</status>
<billing>
	<city>City</city>
	<company>Company</company>
	<country>Country</country>
	<first-name>John</first-name>
	<last-name>Doe</last-name>
	<phone>Phone</phone>
	<state>State</state>
	<street>Street</street>
	<street2>Street2</street2>
	<zip>Zip</zip>
</billing>
<shipping>
	<city>City</city>
	<company>Company</company>
	<country>Country</country>
	<first-name>John</first-name>
	<last-name>Doe</last-name>
	<phone>Phone</phone>
	<state>State</state>
	<street>Street</street>
	<street2>Street2</street2>
	<zip>Zip</zip>
</shipping>
<invoice>text</invoice>
<purchase-order>text</purchase-order>
<customer-id>text</customer-id>
<order-id>text</order-id>
<email-address>text</email-address>
<description>text</description>
<comments>text</comments>
<billing-is-shipping>true</billing-is-shipping>
<status-change-date>text</status-change-date>
<display-message>text</display-message>
<provider-transaction-id>text</provider-transaction-id>
<trace-number>text</trace-number>
<settled-date>text</settled-date>
<returned-date>text</returned-date>
<returned-code>text</returned-code>
<returned-message>text</returned-message>
<ach-token>
	<account-number>1111</account-number>
	<account-type>Checking</account-type>
	<created>1100000000000000</created>
	<customer-key>customer123</customer-key>
	<default>false</default>
	<individual-name>John Doe</individual-name>
	<last-used>1100000000000000</last-used>
	<merchant-id>000008888</merchant-id>
	<routing-number>081009813</routing-number>
	<times-used>14</times-used>
	<token-description>Travel checking account</token-description>
	<token-id>1100000000000000</token-id>
	<updated>1100000000000000</updated>
</ach-token>
<merchant-id>text</merchant-id>
<terminal-id>text</terminal-id>
<software-type>MySoftware_Version1.3</software-type>
<paya-authorization>text</paya-authorization>
"

application/xmlapplication/json

<?xml version="1.0"?>
<object>
	<check-field>invoice</check-field>
	<client-ip>111.22.22.333</client-ip>
	<dob-year>dob-year</dob-year>
	<email-receipt>true</email-receipt>
	<software-type-version>1.0</software-type-version>
	<type>Debit</type>
	<validate-account>true</validate-account>
	<amount>text</amount>
	<routing-number>text</routing-number>
	<account-number>text</account-number>
	<account-type>Checking</account-type>
	<standard-entry-class-code>PPD</standard-entry-class-code>
	<check-number>text</check-number>
	<create-token>false</create-token>
	<create-description>false</create-description>
	<individual-name>text</individual-name>
	<token-id>1188888888888888</token-id>
	<id>text</id>
	<status>Pending</status>
	<billing>
		<city>City</city>
		<company>Company</company>
		<country>Country</country>
		<first-name>John</first-name>
		<last-name>Doe</last-name>
		<phone>Phone</phone>
		<state>State</state>
		<street>Street</street>
		<street2>Street2</street2>
		<zip>Zip</zip>
	</billing>
	<shipping>
		<city>City</city>
		<company>Company</company>
		<country>Country</country>
		<first-name>John</first-name>
		<last-name>Doe</last-name>
		<phone>Phone</phone>
		<state>State</state>
		<street>Street</street>
		<street2>Street2</street2>
		<zip>Zip</zip>
	</shipping>
	<invoice>text</invoice>
	<purchase-order>text</purchase-order>
	<customer-id>text</customer-id>
	<order-id>text</order-id>
	<email-address>text</email-address>
	<description>text</description>
	<comments>text</comments>
	<billing-is-shipping>true</billing-is-shipping>
	<status-change-date>text</status-change-date>
	<display-message>text</display-message>
	<provider-transaction-id>text</provider-transaction-id>
	<trace-number>text</trace-number>
	<settled-date>text</settled-date>
	<returned-date>text</returned-date>
	<returned-code>text</returned-code>
	<returned-message>text</returned-message>
	<ach-token>
		<account-number>1111</account-number>
		<account-type>Checking</account-type>
		<created>1100000000000000</created>
		<customer-key>customer123</customer-key>
		<default>false</default>
		<individual-name>John Doe</individual-name>
		<last-used>1100000000000000</last-used>
		<merchant-id>000008888</merchant-id>
		<routing-number>081009813</routing-number>
		<times-used>14</times-used>
		<token-description>Travel checking account</token-description>
		<token-id>1100000000000000</token-id>
		<updated>1100000000000000</updated>
	</ach-token>
	<merchant-id>text</merchant-id>
	<terminal-id>text</terminal-id>
	<software-type>MySoftware_Version1.3</software-type>
	<paya-authorization>text</paya-authorization>
</object>

Post a Credit Transaction

post

An ACH credit transaction takes money out of the merchant's account and puts it into your customer's account.

The "check-field" keypair can check for a duplicate transaction attempt. The “check-field” points to another field you provide within the request. The field you select needs to have a value.

Fields supported: invoice, order-id, purchase-order, check-number.

Example: "check-field": "invoice", "invoice": "invoice1"

A customer's bank account can be validated using the field "validate-account". If the validation fails, an appropriate error message is returned.

Example: "validate-account": "true".

Header parameters

api-keyanyRequired

apiKeyValue

Body

application/xmlapplication/json

This model represents the ach transaction in the response

check-fieldstring · enumOptional

Field to check for duplicate transactions on such as invoice

Example: invoicePossible values:

client-ipstringOptional

Optional client ip address

Example: 111.22.22.333

dob-yearstringOptional

1999, 2000, 2009

Example: dob-year

email-receiptstringOptional

Boolean which signifies whether or not a receipt should be sent

Example: true

software-type-versionstringRequired

Include the version of software-type

Example: 1.0

typestring · enumRequiredPossible values:

validate-accountstring · enumOptional

Set to true when validating account information.

Example: truePossible values:

amountstringOptional

An absolute number with two decimal places.

routing-numberstringRequired

9 digits.

account-numberstringRequired

Account number masked to only show last four

account-typestring · enumRequiredPossible values:

standard-entry-class-codestring · enumRequired

PPD = Predetermined Payment and Deposit

Possible values:

check-numberstringOptional

This value helps with duplicate transaction checking

create-tokenstringOptional

Set to true if you would like to create a token as part of the transaction

Example: false

create-descriptionstringOptional

Pass in when creating a token if you would like to save a description wiht the token

Example: false

individual-namestringOptional

The name of the account holder.

token-idstringOptional

Pass in if you would like to run the transaction with a previously created token. The token replaces routing-number, account-number, account-type and individual name; making those fields unnecessary when paying with a token

Example: 1188888888888888

idstringOptional

Unique id of the ach transaction.

statusstring · enumOptional

Returned from GET and can be used with search filter.

Possible values:

invoicestringOptional

This value helps with duplicate transaction checking

purchase-orderstringOptional

This value helps with duplicate transaction checking

customer-idstringOptional

This value helps with duplicate transaction checking

order-idstringOptional

This value helps with duplicate transaction checking

email-addressstringOptional

Email Address of customer

descriptionstringOptional

A brief description of the product being sold

commentsstringOptional

Any additional comments to be made of the transaction

billing-is-shippingstring · enumOptional

Is the billing address the same as the shipping address?

Possible values:

status-change-datestringOptional

Last date that the status of the transaction changed

display-messagestringOptional

message to be displayed

provider-transaction-idstringOptional

transaction id from the ach provider

trace-numberstringOptional

Trace number associated with a returned or settled transaction

settled-datestringOptional

Date of settled transaction

returned-datestringOptional

Date of a returned transaction

returned-codestringOptional

Code associated with a returned transaction (NACHA)

returned-messagestringOptional

Message associated with a returned transaction (NACHA)

merchant-idstringOptional

Merchant Id of the transaction

terminal-idstringOptional

Terminal Id of the api-key used to create the transaction

software-typestringOptional

Static field referencing the software name you are building

Example: MySoftware_Version1.3

paya-authorizationstringOptional

Paya Authorization

Responses

200

OK

application/xmlapplication/json

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

HTTPcURLJavaScriptPython

POST //rest/v2/ach/transactions/credit HTTP/1.1
Host: gateway-sb.clearent.net
Content-Type: application/xml
Accept: */*
Content-Length: 1683

"<?xml version=1.0?>
<check-field>invoice</check-field>
<client-ip>111.22.22.333</client-ip>
<dob-year>dob-year</dob-year>
<email-receipt>true</email-receipt>
<software-type-version>1.0</software-type-version>
<type>Debit</type>
<validate-account>true</validate-account>
<amount>text</amount>
<routing-number>text</routing-number>
<account-number>text</account-number>
<account-type>Checking</account-type>
<standard-entry-class-code>PPD</standard-entry-class-code>
<check-number>text</check-number>
<create-token>false</create-token>
<create-description>false</create-description>
<individual-name>text</individual-name>
<token-id>1188888888888888</token-id>
<id>text</id>
<status>Pending</status>
<billing>
	<city>City</city>
	<company>Company</company>
	<country>Country</country>
	<first-name>John</first-name>
	<last-name>Doe</last-name>
	<phone>Phone</phone>
	<state>State</state>
	<street>Street</street>
	<street2>Street2</street2>
	<zip>Zip</zip>
</billing>
<shipping>
	<city>City</city>
	<company>Company</company>
	<country>Country</country>
	<first-name>John</first-name>
	<last-name>Doe</last-name>
	<phone>Phone</phone>
	<state>State</state>
	<street>Street</street>
	<street2>Street2</street2>
	<zip>Zip</zip>
</shipping>
<invoice>text</invoice>
<purchase-order>text</purchase-order>
<customer-id>text</customer-id>
<order-id>text</order-id>
<email-address>text</email-address>
<description>text</description>
<comments>text</comments>
<billing-is-shipping>true</billing-is-shipping>
<status-change-date>text</status-change-date>
<display-message>text</display-message>
<provider-transaction-id>text</provider-transaction-id>
<trace-number>text</trace-number>
<settled-date>text</settled-date>
<returned-date>text</returned-date>
<returned-code>text</returned-code>
<returned-message>text</returned-message>
<ach-token>
	<account-number>1111</account-number>
	<account-type>Checking</account-type>
	<created>1100000000000000</created>
	<customer-key>customer123</customer-key>
	<default>false</default>
	<individual-name>John Doe</individual-name>
	<last-used>1100000000000000</last-used>
	<merchant-id>000008888</merchant-id>
	<routing-number>081009813</routing-number>
	<times-used>14</times-used>
	<token-description>Travel checking account</token-description>
	<token-id>1100000000000000</token-id>
	<updated>1100000000000000</updated>
</ach-token>
<merchant-id>text</merchant-id>
<terminal-id>text</terminal-id>
<software-type>MySoftware_Version1.3</software-type>
<paya-authorization>text</paya-authorization>
"

application/xmlapplication/json

<?xml version="1.0"?>
<object>
	<check-field>invoice</check-field>
	<client-ip>111.22.22.333</client-ip>
	<dob-year>dob-year</dob-year>
	<email-receipt>true</email-receipt>
	<software-type-version>1.0</software-type-version>
	<type>Debit</type>
	<validate-account>true</validate-account>
	<amount>text</amount>
	<routing-number>text</routing-number>
	<account-number>text</account-number>
	<account-type>Checking</account-type>
	<standard-entry-class-code>PPD</standard-entry-class-code>
	<check-number>text</check-number>
	<create-token>false</create-token>
	<create-description>false</create-description>
	<individual-name>text</individual-name>
	<token-id>1188888888888888</token-id>
	<id>text</id>
	<status>Pending</status>
	<billing>
		<city>City</city>
		<company>Company</company>
		<country>Country</country>
		<first-name>John</first-name>
		<last-name>Doe</last-name>
		<phone>Phone</phone>
		<state>State</state>
		<street>Street</street>
		<street2>Street2</street2>
		<zip>Zip</zip>
	</billing>
	<shipping>
		<city>City</city>
		<company>Company</company>
		<country>Country</country>
		<first-name>John</first-name>
		<last-name>Doe</last-name>
		<phone>Phone</phone>
		<state>State</state>
		<street>Street</street>
		<street2>Street2</street2>
		<zip>Zip</zip>
	</shipping>
	<invoice>text</invoice>
	<purchase-order>text</purchase-order>
	<customer-id>text</customer-id>
	<order-id>text</order-id>
	<email-address>text</email-address>
	<description>text</description>
	<comments>text</comments>
	<billing-is-shipping>true</billing-is-shipping>
	<status-change-date>text</status-change-date>
	<display-message>text</display-message>
	<provider-transaction-id>text</provider-transaction-id>
	<trace-number>text</trace-number>
	<settled-date>text</settled-date>
	<returned-date>text</returned-date>
	<returned-code>text</returned-code>
	<returned-message>text</returned-message>
	<ach-token>
		<account-number>1111</account-number>
		<account-type>Checking</account-type>
		<created>1100000000000000</created>
		<customer-key>customer123</customer-key>
		<default>false</default>
		<individual-name>John Doe</individual-name>
		<last-used>1100000000000000</last-used>
		<merchant-id>000008888</merchant-id>
		<routing-number>081009813</routing-number>
		<times-used>14</times-used>
		<token-description>Travel checking account</token-description>
		<token-id>1100000000000000</token-id>
		<updated>1100000000000000</updated>
	</ach-token>
	<merchant-id>text</merchant-id>
	<terminal-id>text</terminal-id>
	<software-type>MySoftware_Version1.3</software-type>
	<paya-authorization>text</paya-authorization>
</object>

Post a Debit Transaction

post

An ACH debit transaction takes money out of the customer’s account and puts it into your merchant's account.

The "check-field" keypair can check for a duplicate transaction attempt. The “check-field” points to another field you provide within the request. The field you select needs to have a value.

Fields supported: invoice, order-id, purchase-order, check-number.

Example: "check-field": "invoice", "invoice": "invoice1"

A customer's bank account can be validated using the field "validate-account". If the validation fails, an appropriate error message is returned.

Example: "validate-account": "true".

Header parameters

api-keyanyRequired

apiKeyValue

Body

application/xmlapplication/json

This model represents the ach transaction in the response

check-fieldstring · enumOptional

Field to check for duplicate transactions on such as invoice

Example: invoicePossible values:

client-ipstringOptional

Optional client ip address

Example: 111.22.22.333

dob-yearstringOptional

1999, 2000, 2009

Example: dob-year

email-receiptstringOptional

Boolean which signifies whether or not a receipt should be sent

Example: true

software-type-versionstringRequired

Include the version of software-type

Example: 1.0

typestring · enumRequiredPossible values:

validate-accountstring · enumOptional

Set to true when validating account information.

Example: truePossible values:

amountstringOptional

An absolute number with two decimal places.

routing-numberstringRequired

9 digits.

account-numberstringRequired

Account number masked to only show last four

account-typestring · enumRequiredPossible values:

standard-entry-class-codestring · enumRequired

PPD = Predetermined Payment and Deposit

Possible values:

check-numberstringOptional

This value helps with duplicate transaction checking

create-tokenstringOptional

Set to true if you would like to create a token as part of the transaction

Example: false

create-descriptionstringOptional

Pass in when creating a token if you would like to save a description wiht the token

Example: false

individual-namestringOptional

The name of the account holder.

token-idstringOptional

Pass in if you would like to run the transaction with a previously created token. The token replaces routing-number, account-number, account-type and individual name; making those fields unnecessary when paying with a token

Example: 1188888888888888

idstringOptional

Unique id of the ach transaction.

statusstring · enumOptional

Returned from GET and can be used with search filter.

Possible values:

invoicestringOptional

This value helps with duplicate transaction checking

purchase-orderstringOptional

This value helps with duplicate transaction checking

customer-idstringOptional

This value helps with duplicate transaction checking

order-idstringOptional

This value helps with duplicate transaction checking

email-addressstringOptional

Email Address of customer

descriptionstringOptional

A brief description of the product being sold

commentsstringOptional

Any additional comments to be made of the transaction

billing-is-shippingstring · enumOptional

Is the billing address the same as the shipping address?

Possible values:

status-change-datestringOptional

Last date that the status of the transaction changed

display-messagestringOptional

message to be displayed

provider-transaction-idstringOptional

transaction id from the ach provider

trace-numberstringOptional

Trace number associated with a returned or settled transaction

settled-datestringOptional

Date of settled transaction

returned-datestringOptional

Date of a returned transaction

returned-codestringOptional

Code associated with a returned transaction (NACHA)

returned-messagestringOptional

Message associated with a returned transaction (NACHA)

merchant-idstringOptional

Merchant Id of the transaction

terminal-idstringOptional

Terminal Id of the api-key used to create the transaction

software-typestringOptional

Static field referencing the software name you are building

Example: MySoftware_Version1.3

paya-authorizationstringOptional

Paya Authorization

Responses

200

OK

application/xmlapplication/json

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

HTTPcURLJavaScriptPython

POST //rest/v2/ach/transactions/debit HTTP/1.1
Host: gateway-sb.clearent.net
Content-Type: application/xml
Accept: */*
Content-Length: 1683

"<?xml version=1.0?>
<check-field>invoice</check-field>
<client-ip>111.22.22.333</client-ip>
<dob-year>dob-year</dob-year>
<email-receipt>true</email-receipt>
<software-type-version>1.0</software-type-version>
<type>Debit</type>
<validate-account>true</validate-account>
<amount>text</amount>
<routing-number>text</routing-number>
<account-number>text</account-number>
<account-type>Checking</account-type>
<standard-entry-class-code>PPD</standard-entry-class-code>
<check-number>text</check-number>
<create-token>false</create-token>
<create-description>false</create-description>
<individual-name>text</individual-name>
<token-id>1188888888888888</token-id>
<id>text</id>
<status>Pending</status>
<billing>
	<city>City</city>
	<company>Company</company>
	<country>Country</country>
	<first-name>John</first-name>
	<last-name>Doe</last-name>
	<phone>Phone</phone>
	<state>State</state>
	<street>Street</street>
	<street2>Street2</street2>
	<zip>Zip</zip>
</billing>
<shipping>
	<city>City</city>
	<company>Company</company>
	<country>Country</country>
	<first-name>John</first-name>
	<last-name>Doe</last-name>
	<phone>Phone</phone>
	<state>State</state>
	<street>Street</street>
	<street2>Street2</street2>
	<zip>Zip</zip>
</shipping>
<invoice>text</invoice>
<purchase-order>text</purchase-order>
<customer-id>text</customer-id>
<order-id>text</order-id>
<email-address>text</email-address>
<description>text</description>
<comments>text</comments>
<billing-is-shipping>true</billing-is-shipping>
<status-change-date>text</status-change-date>
<display-message>text</display-message>
<provider-transaction-id>text</provider-transaction-id>
<trace-number>text</trace-number>
<settled-date>text</settled-date>
<returned-date>text</returned-date>
<returned-code>text</returned-code>
<returned-message>text</returned-message>
<ach-token>
	<account-number>1111</account-number>
	<account-type>Checking</account-type>
	<created>1100000000000000</created>
	<customer-key>customer123</customer-key>
	<default>false</default>
	<individual-name>John Doe</individual-name>
	<last-used>1100000000000000</last-used>
	<merchant-id>000008888</merchant-id>
	<routing-number>081009813</routing-number>
	<times-used>14</times-used>
	<token-description>Travel checking account</token-description>
	<token-id>1100000000000000</token-id>
	<updated>1100000000000000</updated>
</ach-token>
<merchant-id>text</merchant-id>
<terminal-id>text</terminal-id>
<software-type>MySoftware_Version1.3</software-type>
<paya-authorization>text</paya-authorization>
"

application/xmlapplication/json

<?xml version="1.0"?>
<object>
	<check-field>invoice</check-field>
	<client-ip>111.22.22.333</client-ip>
	<dob-year>dob-year</dob-year>
	<email-receipt>true</email-receipt>
	<software-type-version>1.0</software-type-version>
	<type>Debit</type>
	<validate-account>true</validate-account>
	<amount>text</amount>
	<routing-number>text</routing-number>
	<account-number>text</account-number>
	<account-type>Checking</account-type>
	<standard-entry-class-code>PPD</standard-entry-class-code>
	<check-number>text</check-number>
	<create-token>false</create-token>
	<create-description>false</create-description>
	<individual-name>text</individual-name>
	<token-id>1188888888888888</token-id>
	<id>text</id>
	<status>Pending</status>
	<billing>
		<city>City</city>
		<company>Company</company>
		<country>Country</country>
		<first-name>John</first-name>
		<last-name>Doe</last-name>
		<phone>Phone</phone>
		<state>State</state>
		<street>Street</street>
		<street2>Street2</street2>
		<zip>Zip</zip>
	</billing>
	<shipping>
		<city>City</city>
		<company>Company</company>
		<country>Country</country>
		<first-name>John</first-name>
		<last-name>Doe</last-name>
		<phone>Phone</phone>
		<state>State</state>
		<street>Street</street>
		<street2>Street2</street2>
		<zip>Zip</zip>
	</shipping>
	<invoice>text</invoice>
	<purchase-order>text</purchase-order>
	<customer-id>text</customer-id>
	<order-id>text</order-id>
	<email-address>text</email-address>
	<description>text</description>
	<comments>text</comments>
	<billing-is-shipping>true</billing-is-shipping>
	<status-change-date>text</status-change-date>
	<display-message>text</display-message>
	<provider-transaction-id>text</provider-transaction-id>
	<trace-number>text</trace-number>
	<settled-date>text</settled-date>
	<returned-date>text</returned-date>
	<returned-code>text</returned-code>
	<returned-message>text</returned-message>
	<ach-token>
		<account-number>1111</account-number>
		<account-type>Checking</account-type>
		<created>1100000000000000</created>
		<customer-key>customer123</customer-key>
		<default>false</default>
		<individual-name>John Doe</individual-name>
		<last-used>1100000000000000</last-used>
		<merchant-id>000008888</merchant-id>
		<routing-number>081009813</routing-number>
		<times-used>14</times-used>
		<token-description>Travel checking account</token-description>
		<token-id>1100000000000000</token-id>
		<updated>1100000000000000</updated>
	</ach-token>
	<merchant-id>text</merchant-id>
	<terminal-id>text</terminal-id>
	<software-type>MySoftware_Version1.3</software-type>
	<paya-authorization>text</paya-authorization>
</object>

Reversal Transaction

post

This method is only supported if Paya is your ACH provider.

Header parameters

api-keyanyRequired

apiKeyValue

Body

application/xmlapplication/json

This model represents the ach transaction in the response

check-fieldstring · enumOptional

Field to check for duplicate transactions on such as invoice

Example: invoicePossible values:

client-ipstringOptional

Optional client ip address

Example: 111.22.22.333

dob-yearstringOptional

1999, 2000, 2009

Example: dob-year

email-receiptstringOptional

Boolean which signifies whether or not a receipt should be sent

Example: true

software-type-versionstringRequired

Include the version of software-type

Example: 1.0

typestring · enumRequiredPossible values:

validate-accountstring · enumOptional

Set to true when validating account information.

Example: truePossible values:

amountstringOptional

An absolute number with two decimal places.

routing-numberstringRequired

9 digits.

account-numberstringRequired

Account number masked to only show last four

account-typestring · enumRequiredPossible values:

standard-entry-class-codestring · enumRequired

PPD = Predetermined Payment and Deposit

Possible values:

check-numberstringOptional

This value helps with duplicate transaction checking

create-tokenstringOptional

Set to true if you would like to create a token as part of the transaction

Example: false

create-descriptionstringOptional

Pass in when creating a token if you would like to save a description wiht the token

Example: false

individual-namestringOptional

The name of the account holder.

token-idstringOptional

Pass in if you would like to run the transaction with a previously created token. The token replaces routing-number, account-number, account-type and individual name; making those fields unnecessary when paying with a token

Example: 1188888888888888

idstringOptional

Unique id of the ach transaction.

statusstring · enumOptional

Returned from GET and can be used with search filter.

Possible values:

invoicestringOptional

This value helps with duplicate transaction checking

purchase-orderstringOptional

This value helps with duplicate transaction checking

customer-idstringOptional

This value helps with duplicate transaction checking

order-idstringOptional

This value helps with duplicate transaction checking

email-addressstringOptional

Email Address of customer

descriptionstringOptional

A brief description of the product being sold

commentsstringOptional

Any additional comments to be made of the transaction

billing-is-shippingstring · enumOptional

Is the billing address the same as the shipping address?

Possible values:

status-change-datestringOptional

Last date that the status of the transaction changed

display-messagestringOptional

message to be displayed

provider-transaction-idstringOptional

transaction id from the ach provider

trace-numberstringOptional

Trace number associated with a returned or settled transaction

settled-datestringOptional

Date of settled transaction

returned-datestringOptional

Date of a returned transaction

returned-codestringOptional

Code associated with a returned transaction (NACHA)

returned-messagestringOptional

Message associated with a returned transaction (NACHA)

merchant-idstringOptional

Merchant Id of the transaction

terminal-idstringOptional

Terminal Id of the api-key used to create the transaction

software-typestringOptional

Static field referencing the software name you are building

Example: MySoftware_Version1.3

paya-authorizationstringOptional

Paya Authorization

Responses

200

OK

application/xmlapplication/json

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

HTTPcURLJavaScriptPython

POST //rest/v2/ach/transactions/reversal HTTP/1.1
Host: gateway-sb.clearent.net
Content-Type: application/xml
Accept: */*
Content-Length: 1683

"<?xml version=1.0?>
<check-field>invoice</check-field>
<client-ip>111.22.22.333</client-ip>
<dob-year>dob-year</dob-year>
<email-receipt>true</email-receipt>
<software-type-version>1.0</software-type-version>
<type>Debit</type>
<validate-account>true</validate-account>
<amount>text</amount>
<routing-number>text</routing-number>
<account-number>text</account-number>
<account-type>Checking</account-type>
<standard-entry-class-code>PPD</standard-entry-class-code>
<check-number>text</check-number>
<create-token>false</create-token>
<create-description>false</create-description>
<individual-name>text</individual-name>
<token-id>1188888888888888</token-id>
<id>text</id>
<status>Pending</status>
<billing>
	<city>City</city>
	<company>Company</company>
	<country>Country</country>
	<first-name>John</first-name>
	<last-name>Doe</last-name>
	<phone>Phone</phone>
	<state>State</state>
	<street>Street</street>
	<street2>Street2</street2>
	<zip>Zip</zip>
</billing>
<shipping>
	<city>City</city>
	<company>Company</company>
	<country>Country</country>
	<first-name>John</first-name>
	<last-name>Doe</last-name>
	<phone>Phone</phone>
	<state>State</state>
	<street>Street</street>
	<street2>Street2</street2>
	<zip>Zip</zip>
</shipping>
<invoice>text</invoice>
<purchase-order>text</purchase-order>
<customer-id>text</customer-id>
<order-id>text</order-id>
<email-address>text</email-address>
<description>text</description>
<comments>text</comments>
<billing-is-shipping>true</billing-is-shipping>
<status-change-date>text</status-change-date>
<display-message>text</display-message>
<provider-transaction-id>text</provider-transaction-id>
<trace-number>text</trace-number>
<settled-date>text</settled-date>
<returned-date>text</returned-date>
<returned-code>text</returned-code>
<returned-message>text</returned-message>
<ach-token>
	<account-number>1111</account-number>
	<account-type>Checking</account-type>
	<created>1100000000000000</created>
	<customer-key>customer123</customer-key>
	<default>false</default>
	<individual-name>John Doe</individual-name>
	<last-used>1100000000000000</last-used>
	<merchant-id>000008888</merchant-id>
	<routing-number>081009813</routing-number>
	<times-used>14</times-used>
	<token-description>Travel checking account</token-description>
	<token-id>1100000000000000</token-id>
	<updated>1100000000000000</updated>
</ach-token>
<merchant-id>text</merchant-id>
<terminal-id>text</terminal-id>
<software-type>MySoftware_Version1.3</software-type>
<paya-authorization>text</paya-authorization>
"

application/xmlapplication/json

<?xml version="1.0"?>
<object>
	<check-field>invoice</check-field>
	<client-ip>111.22.22.333</client-ip>
	<dob-year>dob-year</dob-year>
	<email-receipt>true</email-receipt>
	<software-type-version>1.0</software-type-version>
	<type>Debit</type>
	<validate-account>true</validate-account>
	<amount>text</amount>
	<routing-number>text</routing-number>
	<account-number>text</account-number>
	<account-type>Checking</account-type>
	<standard-entry-class-code>PPD</standard-entry-class-code>
	<check-number>text</check-number>
	<create-token>false</create-token>
	<create-description>false</create-description>
	<individual-name>text</individual-name>
	<token-id>1188888888888888</token-id>
	<id>text</id>
	<status>Pending</status>
	<billing>
		<city>City</city>
		<company>Company</company>
		<country>Country</country>
		<first-name>John</first-name>
		<last-name>Doe</last-name>
		<phone>Phone</phone>
		<state>State</state>
		<street>Street</street>
		<street2>Street2</street2>
		<zip>Zip</zip>
	</billing>
	<shipping>
		<city>City</city>
		<company>Company</company>
		<country>Country</country>
		<first-name>John</first-name>
		<last-name>Doe</last-name>
		<phone>Phone</phone>
		<state>State</state>
		<street>Street</street>
		<street2>Street2</street2>
		<zip>Zip</zip>
	</shipping>
	<invoice>text</invoice>
	<purchase-order>text</purchase-order>
	<customer-id>text</customer-id>
	<order-id>text</order-id>
	<email-address>text</email-address>
	<description>text</description>
	<comments>text</comments>
	<billing-is-shipping>true</billing-is-shipping>
	<status-change-date>text</status-change-date>
	<display-message>text</display-message>
	<provider-transaction-id>text</provider-transaction-id>
	<trace-number>text</trace-number>
	<settled-date>text</settled-date>
	<returned-date>text</returned-date>
	<returned-code>text</returned-code>
	<returned-message>text</returned-message>
	<ach-token>
		<account-number>1111</account-number>
		<account-type>Checking</account-type>
		<created>1100000000000000</created>
		<customer-key>customer123</customer-key>
		<default>false</default>
		<individual-name>John Doe</individual-name>
		<last-used>1100000000000000</last-used>
		<merchant-id>000008888</merchant-id>
		<routing-number>081009813</routing-number>
		<times-used>14</times-used>
		<token-description>Travel checking account</token-description>
		<token-id>1100000000000000</token-id>
		<updated>1100000000000000</updated>
	</ach-token>
	<merchant-id>text</merchant-id>
	<terminal-id>text</terminal-id>
	<software-type>MySoftware_Version1.3</software-type>
	<paya-authorization>text</paya-authorization>
</object>

Validate ACH Account

post

Use this endpoint to validate an ACH account. This does NOT submit a transaction it will only verify if the ACH account is in good standing. While we allow you to pass in an amount, we are unable to verify that the amount is in the account.

Header parameters

api-keyanyRequired

apiKeyValue

Body

application/xmlapplication/json

This model represents the ach transaction in the response

check-fieldstring · enumOptional

Field to check for duplicate transactions on such as invoice

Example: invoicePossible values:

client-ipstringOptional

Optional client ip address

Example: 111.22.22.333

dob-yearstringOptional

1999, 2000, 2009

Example: dob-year

email-receiptstringOptional

Boolean which signifies whether or not a receipt should be sent

Example: true

software-type-versionstringRequired

Include the version of software-type

Example: 1.0

typestring · enumRequiredPossible values:

validate-accountstring · enumOptional

Set to true when validating account information.

Example: truePossible values:

amountstringOptional

An absolute number with two decimal places.

routing-numberstringRequired

9 digits.

account-numberstringRequired

Account number masked to only show last four

account-typestring · enumRequiredPossible values:

standard-entry-class-codestring · enumRequired

PPD = Predetermined Payment and Deposit

Possible values:

check-numberstringOptional

This value helps with duplicate transaction checking

create-tokenstringOptional

Set to true if you would like to create a token as part of the transaction

Example: false

create-descriptionstringOptional

Pass in when creating a token if you would like to save a description wiht the token

Example: false

individual-namestringOptional

The name of the account holder.

token-idstringOptional

Pass in if you would like to run the transaction with a previously created token. The token replaces routing-number, account-number, account-type and individual name; making those fields unnecessary when paying with a token

Example: 1188888888888888

idstringOptional

Unique id of the ach transaction.

statusstring · enumOptional

Returned from GET and can be used with search filter.

Possible values:

invoicestringOptional

This value helps with duplicate transaction checking

purchase-orderstringOptional

This value helps with duplicate transaction checking

customer-idstringOptional

This value helps with duplicate transaction checking

order-idstringOptional

This value helps with duplicate transaction checking

email-addressstringOptional

Email Address of customer

descriptionstringOptional

A brief description of the product being sold

commentsstringOptional

Any additional comments to be made of the transaction

billing-is-shippingstring · enumOptional

Is the billing address the same as the shipping address?

Possible values:

status-change-datestringOptional

Last date that the status of the transaction changed

display-messagestringOptional

message to be displayed

provider-transaction-idstringOptional

transaction id from the ach provider

trace-numberstringOptional

Trace number associated with a returned or settled transaction

settled-datestringOptional

Date of settled transaction

returned-datestringOptional

Date of a returned transaction

returned-codestringOptional

Code associated with a returned transaction (NACHA)

returned-messagestringOptional

Message associated with a returned transaction (NACHA)

merchant-idstringOptional

Merchant Id of the transaction

terminal-idstringOptional

Terminal Id of the api-key used to create the transaction

software-typestringOptional

Static field referencing the software name you are building

Example: MySoftware_Version1.3

paya-authorizationstringOptional

Paya Authorization

Responses

200

OK

application/xmlapplication/json

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post

HTTPcURLJavaScriptPython

POST //rest/v2/ach/transactions/validate HTTP/1.1
Host: gateway-sb.clearent.net
Content-Type: application/xml
Accept: */*
Content-Length: 1683

"<?xml version=1.0?>
<check-field>invoice</check-field>
<client-ip>111.22.22.333</client-ip>
<dob-year>dob-year</dob-year>
<email-receipt>true</email-receipt>
<software-type-version>1.0</software-type-version>
<type>Debit</type>
<validate-account>true</validate-account>
<amount>text</amount>
<routing-number>text</routing-number>
<account-number>text</account-number>
<account-type>Checking</account-type>
<standard-entry-class-code>PPD</standard-entry-class-code>
<check-number>text</check-number>
<create-token>false</create-token>
<create-description>false</create-description>
<individual-name>text</individual-name>
<token-id>1188888888888888</token-id>
<id>text</id>
<status>Pending</status>
<billing>
	<city>City</city>
	<company>Company</company>
	<country>Country</country>
	<first-name>John</first-name>
	<last-name>Doe</last-name>
	<phone>Phone</phone>
	<state>State</state>
	<street>Street</street>
	<street2>Street2</street2>
	<zip>Zip</zip>
</billing>
<shipping>
	<city>City</city>
	<company>Company</company>
	<country>Country</country>
	<first-name>John</first-name>
	<last-name>Doe</last-name>
	<phone>Phone</phone>
	<state>State</state>
	<street>Street</street>
	<street2>Street2</street2>
	<zip>Zip</zip>
</shipping>
<invoice>text</invoice>
<purchase-order>text</purchase-order>
<customer-id>text</customer-id>
<order-id>text</order-id>
<email-address>text</email-address>
<description>text</description>
<comments>text</comments>
<billing-is-shipping>true</billing-is-shipping>
<status-change-date>text</status-change-date>
<display-message>text</display-message>
<provider-transaction-id>text</provider-transaction-id>
<trace-number>text</trace-number>
<settled-date>text</settled-date>
<returned-date>text</returned-date>
<returned-code>text</returned-code>
<returned-message>text</returned-message>
<ach-token>
	<account-number>1111</account-number>
	<account-type>Checking</account-type>
	<created>1100000000000000</created>
	<customer-key>customer123</customer-key>
	<default>false</default>
	<individual-name>John Doe</individual-name>
	<last-used>1100000000000000</last-used>
	<merchant-id>000008888</merchant-id>
	<routing-number>081009813</routing-number>
	<times-used>14</times-used>
	<token-description>Travel checking account</token-description>
	<token-id>1100000000000000</token-id>
	<updated>1100000000000000</updated>
</ach-token>
<merchant-id>text</merchant-id>
<terminal-id>text</terminal-id>
<software-type>MySoftware_Version1.3</software-type>
<paya-authorization>text</paya-authorization>
"

application/xmlapplication/json

<?xml version="1.0"?>
<object>
	<check-field>invoice</check-field>
	<client-ip>111.22.22.333</client-ip>
	<dob-year>dob-year</dob-year>
	<email-receipt>true</email-receipt>
	<software-type-version>1.0</software-type-version>
	<type>Debit</type>
	<validate-account>true</validate-account>
	<amount>text</amount>
	<routing-number>text</routing-number>
	<account-number>text</account-number>
	<account-type>Checking</account-type>
	<standard-entry-class-code>PPD</standard-entry-class-code>
	<check-number>text</check-number>
	<create-token>false</create-token>
	<create-description>false</create-description>
	<individual-name>text</individual-name>
	<token-id>1188888888888888</token-id>
	<id>text</id>
	<status>Pending</status>
	<billing>
		<city>City</city>
		<company>Company</company>
		<country>Country</country>
		<first-name>John</first-name>
		<last-name>Doe</last-name>
		<phone>Phone</phone>
		<state>State</state>
		<street>Street</street>
		<street2>Street2</street2>
		<zip>Zip</zip>
	</billing>
	<shipping>
		<city>City</city>
		<company>Company</company>
		<country>Country</country>
		<first-name>John</first-name>
		<last-name>Doe</last-name>
		<phone>Phone</phone>
		<state>State</state>
		<street>Street</street>
		<street2>Street2</street2>
		<zip>Zip</zip>
	</shipping>
	<invoice>text</invoice>
	<purchase-order>text</purchase-order>
	<customer-id>text</customer-id>
	<order-id>text</order-id>
	<email-address>text</email-address>
	<description>text</description>
	<comments>text</comments>
	<billing-is-shipping>true</billing-is-shipping>
	<status-change-date>text</status-change-date>
	<display-message>text</display-message>
	<provider-transaction-id>text</provider-transaction-id>
	<trace-number>text</trace-number>
	<settled-date>text</settled-date>
	<returned-date>text</returned-date>
	<returned-code>text</returned-code>
	<returned-message>text</returned-message>
	<ach-token>
		<account-number>1111</account-number>
		<account-type>Checking</account-type>
		<created>1100000000000000</created>
		<customer-key>customer123</customer-key>
		<default>false</default>
		<individual-name>John Doe</individual-name>
		<last-used>1100000000000000</last-used>
		<merchant-id>000008888</merchant-id>
		<routing-number>081009813</routing-number>
		<times-used>14</times-used>
		<token-description>Travel checking account</token-description>
		<token-id>1100000000000000</token-id>
		<updated>1100000000000000</updated>
	</ach-token>
	<merchant-id>text</merchant-id>
	<terminal-id>text</terminal-id>
	<software-type>MySoftware_Version1.3</software-type>
	<paya-authorization>text</paya-authorization>
</object>

Get Transaction

get

Path parameters

idanyOptional

Use the id returned in response of original POST

Header parameters

api-keyanyRequired

apiKeyValue

Responses

200

OK

application/xmlapplication/json

401

Unauthorized

403

Forbidden

404

Not Found

get

HTTPcURLJavaScriptPython

GET //rest/v2/ach/transactions/{id} HTTP/1.1
Host: gateway-sb.clearent.net
Accept: */*

<?xml version="1.0"?>
<object>
	<check-field>invoice</check-field>
	<client-ip>111.22.22.333</client-ip>
	<dob-year>dob-year</dob-year>
	<email-receipt>true</email-receipt>
	<software-type-version>1.0</software-type-version>
	<type>Debit</type>
	<validate-account>true</validate-account>
	<amount>text</amount>
	<routing-number>text</routing-number>
	<account-number>text</account-number>
	<account-type>Checking</account-type>
	<standard-entry-class-code>PPD</standard-entry-class-code>
	<check-number>text</check-number>
	<create-token>false</create-token>
	<create-description>false</create-description>
	<individual-name>text</individual-name>
	<token-id>1188888888888888</token-id>
	<id>text</id>
	<status>Pending</status>
	<billing>
		<city>City</city>
		<company>Company</company>
		<country>Country</country>
		<first-name>John</first-name>
		<last-name>Doe</last-name>
		<phone>Phone</phone>
		<state>State</state>
		<street>Street</street>
		<street2>Street2</street2>
		<zip>Zip</zip>
	</billing>
	<shipping>
		<city>City</city>
		<company>Company</company>
		<country>Country</country>
		<first-name>John</first-name>
		<last-name>Doe</last-name>
		<phone>Phone</phone>
		<state>State</state>
		<street>Street</street>
		<street2>Street2</street2>
		<zip>Zip</zip>
	</shipping>
	<invoice>text</invoice>
	<purchase-order>text</purchase-order>
	<customer-id>text</customer-id>
	<order-id>text</order-id>
	<email-address>text</email-address>
	<description>text</description>
	<comments>text</comments>
	<billing-is-shipping>true</billing-is-shipping>
	<status-change-date>text</status-change-date>
	<display-message>text</display-message>
	<provider-transaction-id>text</provider-transaction-id>
	<trace-number>text</trace-number>
	<settled-date>text</settled-date>
	<returned-date>text</returned-date>
	<returned-code>text</returned-code>
	<returned-message>text</returned-message>
	<ach-token>
		<account-number>1111</account-number>
		<account-type>Checking</account-type>
		<created>1100000000000000</created>
		<customer-key>customer123</customer-key>
		<default>false</default>
		<individual-name>John Doe</individual-name>
		<last-used>1100000000000000</last-used>
		<merchant-id>000008888</merchant-id>
		<routing-number>081009813</routing-number>
		<times-used>14</times-used>
		<token-description>Travel checking account</token-description>
		<token-id>1100000000000000</token-id>
		<updated>1100000000000000</updated>
	</ach-token>
	<merchant-id>text</merchant-id>
	<terminal-id>text</terminal-id>
	<software-type>MySoftware_Version1.3</software-type>
	<paya-authorization>text</paya-authorization>
</object>

Void Transaction

delete

Only transactions with a "status": "PENDING" can be voided.

Path parameters

idanyOptional

Use the id returned in response of original POST

Header parameters

api-keyanyRequired

apiKeyValue

Responses

200

OK

application/xmlapplication/json

204

No Content

401

Unauthorized

403

Forbidden

delete

HTTPcURLJavaScriptPython

DELETE //rest/v2/ach/transactions/{id} HTTP/1.1
Host: gateway-sb.clearent.net
Accept: */*

<?xml version="1.0"?>
<object>
	<check-field>invoice</check-field>
	<client-ip>111.22.22.333</client-ip>
	<dob-year>dob-year</dob-year>
	<email-receipt>true</email-receipt>
	<software-type-version>1.0</software-type-version>
	<type>Debit</type>
	<validate-account>true</validate-account>
	<amount>text</amount>
	<routing-number>text</routing-number>
	<account-number>text</account-number>
	<account-type>Checking</account-type>
	<standard-entry-class-code>PPD</standard-entry-class-code>
	<check-number>text</check-number>
	<create-token>false</create-token>
	<create-description>false</create-description>
	<individual-name>text</individual-name>
	<token-id>1188888888888888</token-id>
	<id>text</id>
	<status>Pending</status>
	<billing>
		<city>City</city>
		<company>Company</company>
		<country>Country</country>
		<first-name>John</first-name>
		<last-name>Doe</last-name>
		<phone>Phone</phone>
		<state>State</state>
		<street>Street</street>
		<street2>Street2</street2>
		<zip>Zip</zip>
	</billing>
	<shipping>
		<city>City</city>
		<company>Company</company>
		<country>Country</country>
		<first-name>John</first-name>
		<last-name>Doe</last-name>
		<phone>Phone</phone>
		<state>State</state>
		<street>Street</street>
		<street2>Street2</street2>
		<zip>Zip</zip>
	</shipping>
	<invoice>text</invoice>
	<purchase-order>text</purchase-order>
	<customer-id>text</customer-id>
	<order-id>text</order-id>
	<email-address>text</email-address>
	<description>text</description>
	<comments>text</comments>
	<billing-is-shipping>true</billing-is-shipping>
	<status-change-date>text</status-change-date>
	<display-message>text</display-message>
	<provider-transaction-id>text</provider-transaction-id>
	<trace-number>text</trace-number>
	<settled-date>text</settled-date>
	<returned-date>text</returned-date>
	<returned-code>text</returned-code>
	<returned-message>text</returned-message>
	<ach-token>
		<account-number>1111</account-number>
		<account-type>Checking</account-type>
		<created>1100000000000000</created>
		<customer-key>customer123</customer-key>
		<default>false</default>
		<individual-name>John Doe</individual-name>
		<last-used>1100000000000000</last-used>
		<merchant-id>000008888</merchant-id>
		<routing-number>081009813</routing-number>
		<times-used>14</times-used>
		<token-description>Travel checking account</token-description>
		<token-id>1100000000000000</token-id>
		<updated>1100000000000000</updated>
	</ach-token>
	<merchant-id>text</merchant-id>
	<terminal-id>text</terminal-id>
	<software-type>MySoftware_Version1.3</software-type>
	<paya-authorization>text</paya-authorization>
</object>