ACH Tokens

Ach Token Controller

Create an ACH token

post

Header parameters

api-keyanyRequired

api key

Body

application/xmlapplication/json

Use this model when creating a new ach token

account-numberstringRequired

1 to 17 digits.

Example: 123456789

account-typestring · enumRequiredExample: CheckingPossible values:

customer-keystringOptional

customer associated to token

defaultbooleanOptional

true if this should be the default method to charge customers

individual-namestringRequired

The name of the account holder.

Example: John Doe

routing-numberstringRequired

9 digits.

Example: 081009813

software-typestringOptional

Name of your software you are using to reach this endpoint

Example: MySoftware

software-type-versionstringOptional

Version of your software you are using to reach this endpoint

Example: v1.0

token-descriptionstringOptional

A description of the token

Example: Business checking account

Responses

200

Successful Token Creation

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/tokens

HTTPcURLJavaScriptPython

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

"<?xml version=1.0?>
<account-number>123456789</account-number>
<account-type>Checking</account-type>
<customer-key>text</customer-key>
<default>false</default>
<individual-name>John Doe</individual-name>
<routing-number>081009813</routing-number>
<software-type>MySoftware</software-type>
<software-type-version>v1.0</software-type-version>
<token-description>Business checking account</token-description>
"

application/xmlapplication/json

<?xml version="1.0"?>
<object>
	<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>
	<payloadType>text</payloadType>
</object>

Get ACH Token

get

Path parameters

tokenIdanyRequired

tokenId

token-idanyRequired

token-id

Header parameters

api-keyanyRequired

api key

Responses

200

Success

application/xmlapplication/json

400

Something is wrong with your request

401

Unauthorized

402

Business Exception (decline, etc.)

403

Forbidden

404

Not Found

500

Internal server error

get

/rest/v2/ach/tokens/{tokenId}

HTTPcURLJavaScriptPython

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

<?xml version="1.0"?>
<object>
	<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>
	<payloadType>text</payloadType>
</object>

Update an ACH token

put

Path parameters

tokenIdanyRequired

tokenId

Header parameters

api-keyanyRequired

api key

Body

application/xmlapplication/json

Use this model when creating a new ach token

account-numberstringRequired

1 to 17 digits.

Example: 123456789

account-typestring · enumRequiredExample: CheckingPossible values:

customer-keystringOptional

customer associated to token

defaultbooleanOptional

true if this should be the default method to charge customers

individual-namestringRequired

The name of the account holder.

Example: John Doe

routing-numberstringRequired

9 digits.

Example: 081009813

software-typestringOptional

Name of your software you are using to reach this endpoint

Example: MySoftware

software-type-versionstringOptional

Version of your software you are using to reach this endpoint

Example: v1.0

token-descriptionstringOptional

A description of the token

Example: Business checking account

Responses

200

Successful Token Update

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

put

/rest/v2/ach/tokens/{tokenId}

HTTPcURLJavaScriptPython

PUT /rest/v2/ach/tokens/{tokenId} HTTP/1.1
Host: gateway-sb.clearent.net/
Content-Type: application/xml
Accept: */*
Content-Length: 260

"<?xml version=1.0?>
<account-number>123456789</account-number>
<account-type>Checking</account-type>
<customer-key>text</customer-key>
<default>false</default>
<individual-name>John Doe</individual-name>
<routing-number>081009813</routing-number>
<software-type>MySoftware</software-type>
<software-type-version>v1.0</software-type-version>
<token-description>Business checking account</token-description>
"

application/xmlapplication/json

<?xml version="1.0"?>
<object>
	<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>
	<payloadType>text</payloadType>
</object>

Delete an ACH Token

delete

Path parameters

tokenIdanyRequired

tokenId

token-idanyRequired

token-id

Header parameters

api-keyanyRequired

api key

Responses

200

Success

application/xmlapplication/json

204

No Content

400

Something is wrong with your request

401

Unauthorized

402

Business Exception (decline, etc.)

403

Forbidden

500

Internal server error

delete

/rest/v2/ach/tokens/{tokenId}

HTTPcURLJavaScriptPython

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

<?xml version="1.0"?>
<object>
	<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>
	<payloadType>text</payloadType>
</object>