Objects

Transaction Object

All fields are in alpha-numeric format.

Field Name Notes
amount Amount of the Transactions.
authorization-code Authorization code from issuer.
avs-result-code Status of AVS check with the issuer.
avs-street Status of AVS check with the issuer.
avs-zip Status of AVS check with the issuer.
id ID of the transaction. This can be used to do follow up transactions (i.e., void, refund, capture, etc.).
invoice Invoice number if one was provided in the request.
description Description if one was provided in the request.
comments Comments if they were provided in the request.
original-amount Original Amount of the transaction.
tip-amount Tip amount if one was provided. If tip is adjusted this will be the adjusted tip amount.
tip-adjusted-amount The difference between the new tip amount and original tip amount. Only present on an adjusted tip.
server-id Server ID if one was provided in the request.
created Date transaction was run.
ref-id ID of transactions that is tied to current transaction. For example, for a capture transaction the auth’s transaction id will be populated in the ref-id.
entry-method How the data was entered, keyed or swiped.
first-recurring-transaction Indicator if transaction was the first transaction to initiate recurring payments.
batch-string-id The number of the batch that this transaction was included in.
type Type of transaction (i.e., void, capture, auth, refund).
order-id Order Id if one was provided in the request.
purchase-order Purchase order number if one was provided in the request.
customer-id Customer Id if one was provided in the request.
email-address Email address if one was provided in the request.
result Result of the transaction. APPROVED, DECLINED, etc.
display-message Display friendly result of the transaction.
result-code Numeric response message
billing-is-shipping True if billing address and shipping address are the same.
shipping Address Object represents the shipping address. Not returned if no shipping address was provided or if the billing-is-shipping is set to true.
billing Address Object represents the billing address. Not returned if no address was provided.
card Last 4 digits of the card number.
tip-adjusted True if tip was adjusted from original amount.
exp-date Expiration date of the card.
csc CSC of the card, Not returned if no csc was provided.
csc-result-code Not returned if no CSC was provided.
client-ip Ip of originated transaction. Not returned if not provided.

Links Object

The Links Object contains information about the approved transaction for future reference.

Field Name Format Notes
rel A/N Transaction or Token
href A/N Link to transaction approved or token created.
id A/N Id of object returned in the payload element. It can be an approved transaction id or a token created id.

Address Object

The address object is the contact information provided as part of the transaction. This is typically used for eCommerce transactions that have AVS validation. The same object is returned for either billing or shipping information. All fields are alpha-numeric format.

Field Name Notes
first-name First name of purchaser
last-name Last name of purchaser
company Company
street Street
street2 Street Line 2
city City
state State
zip Zip code
country Country
phone Phone number if one was provided in the request

Token Object

Field Name Format Notes
token-id N Identifier of the token created. This value can be used in the “card” field of any transaction.
times-used A/N Number of times the token id has been used in transactions.
status A/N Active or Inactive
created A/N Date and time the token was created.
last-four A/N Last four digits of card number provided in the request.
card-type A/N Card type provided in the request.
description A/N Description if one was provided in the request.
avs-address A/N Address provided in the request.
avs-zip A/N Avs Zip provided in the request.

Batch Object

The Batch Object contains information for open and closed batches. All fields are alpha-numeric format.

Field Name Notes
id Batch ID
refund-count Number of refunded transaction in the batch
refund-total Total amount of refunded transactions in the batch
sales-count Number of sale transactions in the batch
sales-total Total amount of sale in the batch
net-amount Net amount of transactions in a batch
status OPEN or CLOSED
total-count Total number of transactions in the batch
confirmation-code Batch confirmation code not returned if batch is open
settled Date and time batch was settled. Not returned if batch is open

GET Transactions

Requests for transaction information are submitted to the Clearent Payment Gateway using the HTTP GET method, with a URL.

Once the GET is executed the Transaction Object from above will be returned. In order to limit or filter the results and to organize their presentation, certain fields can be specified as part of the query string appended to the URL, as in the following examples:

Supported Fields

Name Description
id Numeric

Id of the transaction. This can be used to do follow up transactions (i.e., void, refund, capture, etc.).

amount Numeric

Amount of the Transactions.

type Alpha

Type of transaction I.e., void, capture, auth, refund).

result Alpha

Result of the transaction. APPROVED, DECLINED, etc.

last-four Numeric

Last four digits of the card number submitted.

authorization-code Alpha-numeric

Authorization code from issuer.

invoice Alpha-numeric

Invoice number if one was provided in the request.

order-id Alpha-numeric

Order Id if one was provided in the request.

page-size Numeric

Default: 25

Format:

Limits the number of transactions returned by this method. Maximum is 100.

page Numeric

Default: 1

Specifies which page of results is returned. Page index starts at “1”. For example: if page=2 and page_size=50, then this method will return transactions 51 – 100 (or the maximum batches available). If no transactions exist in this range, then a blank list is returned.

descending Alpha

Default: true

Specifies which direction to sort the batch list by. Valid values are true and false.

start-date Alpha-numeric

Filters the transactions list by the created date / time. Setting start-date will return transactions that were processed after this date / time. Setting both start-date and end-date creates a range. See the “Valid Date / Time Formats” list below.

end-date Alpha-numeric

Filters the transactions list by the created date / time. Setting start-date will return transactions that were processed after this date / time. Setting both start-date and end-date creates a range. See the “Valid Date / Time Formats” list below.

Valid formats for the “start-date” and “end-date” fields include the following:
• 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

XML

JSON