Ach Transactions

Ach Mobile Transactions Controller

Credit Transaction

post

Provide the 'jwt' as a header called 'achmobilejwt'. This is the transaction token returned from the successfulTransactionToken method of the Clearent Mobile framework. See our Android SDK (https://github.com/clearent/android-idtech-sdk) or iOS Framework (https://github.com/clearent/ClearentIdtechIOSFramework) for details. Any amount value $1.00 or greater will produce an approval. Any amount value under $1.00 will produce a decline for your testing.

ACH Credit transactions are used for the transfer of funds from the merchant's bank account to the customer's bank account. Inside the clearentRequest field, set the required fields, and click, 'Try Me'.

The achmobilejwt header is required along with this required field: amount.

Header parameters

api-keyanyRequired

apiKeyValue

achmobilejwtanyRequired

achMobileJwtValue

Body

application/xmlapplication/json

account-numberstringOptional

account number

Example: 1234567890

account-typestring · enumOptional

account type

Example: CheckingPossible values:

billing-is-shippingstringOptional

True if shipping address matches billing address

Example: false

check-field-midbooleanOptional

Optional duplication check for transactions. If you send in true we will validate the check-field field sent in is not duplicated for EMV transactions on a merchant level.

Example: true

client-ipstringOptional

IP Address of where request originated (Create for ecommerce apps)

Example: 127.0.0.1

commentsstringOptional

Additional comments about the transaction

Example: Paint the canoe red

customer-idstringOptional

Customer Identifier of the transaction

Example: Customer 1234

descriptionstringOptional

Description of the transaction

Example: Transaction desc

email-addressstringOptional

email address to associate to the transaction

Example: [email protected]

email-receiptstringOptional

pass in if you would like to email a receipt. If true, email-address is required.

Example: false

individual-namestringRequired

The name of the account holder.

Example: John Doe

invoicestringOptional

VarChar value up to 100 characters.

Example: invoice123

order-idstringOptional

Order Id

Example: 99988d

purchase-orderstringOptional

VarChar value up to 100 characters.

Example: PO789

routing-numberstringOptional

routing number

Example: 063100277

software-typestringOptional

Not Required, but will help with troubleshooting if you have issues or problems

Example: MySoftware_Version1.3

standard-entry-class-codestringOptional

tip-amountstringOptional

optional on a SALE. Requires 2 decimal places.

Example: 0.90

typestring · enumRequired

Type of transaction you would like to run;Debit transfers fund from the customer's bank account to your (merchant) bank account. Credit transfers funds from your (merchant) bank account to the customer's bank account

Example: CREDITPossible values:

validate-accountstring · enumOptional

Set to true when validating account information.

Example: truePossible values:

amountstringRequired

amount of transaction

Example: 80.00

idstringOptional

unique id returned for debit or credit ach transactions

software-type-versionstringOptional

Helps with troubleshooting if you have issues or problems

create-tokenstringOptional

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

Example: false

token-descriptionstringOptional

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

Example: false

check-fieldstringOptional

Optional duplication check for transactions. If you send in a check field we will validate that field is not duplicated for EMV transactions.

Example: invoice

Responses

200

Successful Transaction

application/xmlapplication/json

201

Created

400

Something is wrong with your request

401

Unauthorized

402

Business Exception (decline, etc)

403

Forbidden

404

Not Found

500

Internal server error

post

/rest/v2/ach/mobile/transactions/credit

HTTPcURLJavaScriptPython

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

"<?xml version=1.0?>
<account-number>1234567890</account-number>
<account-type>Checking</account-type>
<billing>
	<city>St Louis</city>
	<company>Test Company</company>
	<country>United States</country>
	<first-name>John</first-name>
	<from-zip>85284</from-zip>
	<last-name>Doe</last-name>
	<phone>3148889999</phone>
	<state>MO</state>
	<street>123 Example Street</street>
	<street2>Suite 700</street2>
	<zip>85284</zip>
</billing>
<billing-is-shipping>false</billing-is-shipping>
<check-field-mid>true</check-field-mid>
<client-ip>127.0.0.1</client-ip>
<comments>Paint the canoe red</comments>
<customer-id>Customer 1234</customer-id>
<description>Transaction desc</description>
<email-address>[email protected]</email-address>
<email-receipt>false</email-receipt>
<individual-name>John Doe</individual-name>
<invoice>invoice123</invoice>
<order-id>99988d</order-id>
<platform-fees>
	<fee-name>DealManager</fee-name>
</platform-fees>
<purchase-order>PO789</purchase-order>
<routing-number>063100277</routing-number>
<shipping>
	<city>St Louis</city>
	<company>Test Company</company>
	<country>United States</country>
	<first-name>John</first-name>
	<from-zip>85284</from-zip>
	<last-name>Doe</last-name>
	<phone>3148889999</phone>
	<state>MO</state>
	<street>123 Example Street</street>
	<street2>Suite 700</street2>
	<zip>85284</zip>
</shipping>
<software-type>MySoftware_Version1.3</software-type>
<standard-entry-class-code>text</standard-entry-class-code>
<tip-amount>0.90</tip-amount>
<type>CREDIT</type>
<validate-account>true</validate-account>
<amount>80.00</amount>
<id>text</id>
<software-type-version>text</software-type-version>
<create-token>false</create-token>
<token-description>false</token-description>
<check-field>invoice</check-field>
"

application/xmlapplication/json

<?xml version="1.0"?>
<object>
	<type>Debit</type>
	<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>
	<individual-name>text</individual-name>
	<id>text</id>
	<status>Pending</status>
	<billing>
		<city>St Louis</city>
		<company>Test Company</company>
		<country>United States</country>
		<first-name>John</first-name>
		<from-zip>85284</from-zip>
		<last-name>Doe</last-name>
		<phone>3148889999</phone>
		<state>MO</state>
		<street>123 Example Street</street>
		<street2>Suite 700</street2>
		<zip>85284</zip>
	</billing>
	<shipping>
		<city>St Louis</city>
		<company>Test Company</company>
		<country>United States</country>
		<first-name>John</first-name>
		<from-zip>85284</from-zip>
		<last-name>Doe</last-name>
		<phone>3148889999</phone>
		<state>MO</state>
		<street>123 Example Street</street>
		<street2>Suite 700</street2>
		<zip>85284</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>

Debit Transaction

post

Provide the 'jwt' as a header called 'achmobilejwt'. This is the transaction token returned from the successfulTransactionToken method of the Clearent Mobile framework. See our Android SDK (https://github.com/clearent/android-idtech-sdk) or iOS Framework (https://github.com/clearent/ClearentIdtechIOSFramework) for details. Any amount value under $1.00 will produce a decline for your testing.

ACH Debit transactions are used the transfer of funds from the customer’s bank account to the merchant's bank account. Inside the clearentRequest field, set the required fields, and click, 'Try Me'.

The achmobilejwt header is required along with this required field: amount.

Header parameters

api-keyanyRequired

apiKeyValue

achmobilejwtanyRequired

achMobileJwtValue

Body

application/xmlapplication/json

account-numberstringOptional

account number

Example: 1234567890

account-typestring · enumOptional

account type

Example: CheckingPossible values:

billing-is-shippingstringOptional

True if shipping address matches billing address

Example: false

check-field-midbooleanOptional

Optional duplication check for transactions. If you send in true we will validate the check-field field sent in is not duplicated for EMV transactions on a merchant level.

Example: true

client-ipstringOptional

IP Address of where request originated (Create for ecommerce apps)

Example: 127.0.0.1

commentsstringOptional

Additional comments about the transaction

Example: Paint the canoe red

customer-idstringOptional

Customer Identifier of the transaction

Example: Customer 1234

descriptionstringOptional

Description of the transaction

Example: Transaction desc

email-addressstringOptional

email address to associate to the transaction

Example: [email protected]

email-receiptstringOptional

pass in if you would like to email a receipt. If true, email-address is required.

Example: false

individual-namestringRequired

The name of the account holder.

Example: John Doe

invoicestringOptional

VarChar value up to 100 characters.

Example: invoice123

order-idstringOptional

Order Id

Example: 99988d

purchase-orderstringOptional

VarChar value up to 100 characters.

Example: PO789

routing-numberstringOptional

routing number

Example: 063100277

software-typestringOptional

Not Required, but will help with troubleshooting if you have issues or problems

Example: MySoftware_Version1.3

standard-entry-class-codestringOptional

tip-amountstringOptional

optional on a SALE. Requires 2 decimal places.

Example: 0.90

typestring · enumRequired

Type of transaction you would like to run;Debit transfers fund from the customer's bank account to your (merchant) bank account. Credit transfers funds from your (merchant) bank account to the customer's bank account

Example: CREDITPossible values:

validate-accountstring · enumOptional

Set to true when validating account information.

Example: truePossible values:

amountstringRequired

amount of transaction

Example: 80.00

idstringOptional

unique id returned for debit or credit ach transactions

software-type-versionstringOptional

Helps with troubleshooting if you have issues or problems

create-tokenstringOptional

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

Example: false

token-descriptionstringOptional

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

Example: false

check-fieldstringOptional

Optional duplication check for transactions. If you send in a check field we will validate that field is not duplicated for EMV transactions.

Example: invoice

Responses

200

Successful Transaction

application/xmlapplication/json

201

Created

400

Something is wrong with your request

401

Unauthorized

402

Business Exception (decline, etc)

403

Forbidden

404

Not Found

500

Internal server error

post

/rest/v2/ach/mobile/transactions/debit

HTTPcURLJavaScriptPython

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

"<?xml version=1.0?>
<account-number>1234567890</account-number>
<account-type>Checking</account-type>
<billing>
	<city>St Louis</city>
	<company>Test Company</company>
	<country>United States</country>
	<first-name>John</first-name>
	<from-zip>85284</from-zip>
	<last-name>Doe</last-name>
	<phone>3148889999</phone>
	<state>MO</state>
	<street>123 Example Street</street>
	<street2>Suite 700</street2>
	<zip>85284</zip>
</billing>
<billing-is-shipping>false</billing-is-shipping>
<check-field-mid>true</check-field-mid>
<client-ip>127.0.0.1</client-ip>
<comments>Paint the canoe red</comments>
<customer-id>Customer 1234</customer-id>
<description>Transaction desc</description>
<email-address>[email protected]</email-address>
<email-receipt>false</email-receipt>
<individual-name>John Doe</individual-name>
<invoice>invoice123</invoice>
<order-id>99988d</order-id>
<platform-fees>
	<fee-name>DealManager</fee-name>
</platform-fees>
<purchase-order>PO789</purchase-order>
<routing-number>063100277</routing-number>
<shipping>
	<city>St Louis</city>
	<company>Test Company</company>
	<country>United States</country>
	<first-name>John</first-name>
	<from-zip>85284</from-zip>
	<last-name>Doe</last-name>
	<phone>3148889999</phone>
	<state>MO</state>
	<street>123 Example Street</street>
	<street2>Suite 700</street2>
	<zip>85284</zip>
</shipping>
<software-type>MySoftware_Version1.3</software-type>
<standard-entry-class-code>text</standard-entry-class-code>
<tip-amount>0.90</tip-amount>
<type>CREDIT</type>
<validate-account>true</validate-account>
<amount>80.00</amount>
<id>text</id>
<software-type-version>text</software-type-version>
<create-token>false</create-token>
<token-description>false</token-description>
<check-field>invoice</check-field>
"

application/xmlapplication/json

<?xml version="1.0"?>
<object>
	<type>Debit</type>
	<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>
	<individual-name>text</individual-name>
	<id>text</id>
	<status>Pending</status>
	<billing>
		<city>St Louis</city>
		<company>Test Company</company>
		<country>United States</country>
		<first-name>John</first-name>
		<from-zip>85284</from-zip>
		<last-name>Doe</last-name>
		<phone>3148889999</phone>
		<state>MO</state>
		<street>123 Example Street</street>
		<street2>Suite 700</street2>
		<zip>85284</zip>
	</billing>
	<shipping>
		<city>St Louis</city>
		<company>Test Company</company>
		<country>United States</country>
		<first-name>John</first-name>
		<from-zip>85284</from-zip>
		<last-name>Doe</last-name>
		<phone>3148889999</phone>
		<state>MO</state>
		<street>123 Example Street</street>
		<street2>Suite 700</street2>
		<zip>85284</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>