Semi Integrated Transactions
Transaction Controller
apiKeyValue
Required for Forced Sale. The authorization code of the transactions obtained from another source
AC789UTrue if shipping address matches billing address
falsecard number or credit card token
4111111111111111When tokenizing the card our system will run a card inquiry by default to ensure the card is valid prior to storing the card. To override this pass false.
trueOptional field to signify cash back amount when using EBT cash benefits
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.
trueIP Address of where request orginiated (Create for ecommerce apps)
127.0.0.1Additonal Comments about the transaction
Bad tipper .90 on 80.00 transactionUsed for FULL EMV integrations only (not for semi integrated)
falseUsed for FULL EMV integrations only (not for semi integrated)
falseOptional field to pass with transactions where you pass the card data
999Customer Identifier of the transaction
Customer 1234Description of the transaction
Transaction descpass in if you would like to email a receipt. If true, email-address is required.
falseEncrypted Track Data can be passed instead of card number, Requires TrackFromat to be set
VarChar value up to 100 characters.
invoice123Optional field to signify if card being used is an American Express card
Optional field to signify if terminal being used is a SP30
Order Id
99988dpass in if you would like to check partial authorization.
VarChar value up to 100 characters.
PO789Optional for Capture and Sale transctions, required to qualify with Level II
90.00Optional for Capture and Sale transactions, required to qualify with Level II
LOCAL_SALES_TAXPossible values: Optional on a SALE/Capture. Requires 2 decimal places. Must be less than or equal to 3.99% of total amount (amount + sales-tax-amount + tip-amount)
2.90Not Required, but will help with troubleshooting if you have isseus or problems
MySoftware_Verrsion1.3optional on a SALE/Capture. Requires 2 decimal places.
0.90Clear Text track data can be passed instead of card
Type of transaction you would like to run
SALEPossible values: Field required when using EBT electronic voucher
Field required when using EBT electronic voucher
amount of transaction
80.00expiration date, MMyy format
0932id returned on a sale or auth; use for void, capture, refund, and tip-adjust
Not Required, but will help with troubleshooting if you have isseus or problems
Required if create-token is true. Type of card
VISAPossible values: pass in if you would like to create a token as part of the transaction, Optional on an AUTH or SALE
falsepass in if you would like to use a legacy token in your transaction request, Optional on an AUTH or SALE
falseRequired if create-token is true. Description of the token (ie savings acct
Encrypted Track Data can be passed instead of card, the format of that encrypted data
Optional duplication check for transactions. If you send in a check field we will validate that field is not duplicated for EMV transactions.
invoiceUsed for FULL EMV integrations only (not for semi integrated)
Used for FULL EMV integrations only (not for semi integrated)
Used for FULL EMV integrations only (not for semi integrated)
Used for FULL EMV integrations only (not for semi integrated)
POST //rest/v2/terminal/transactions HTTP/1.1
Host: gateway-sb.clearent.net
Content-Type: application/xml
Accept: */*
Content-Length: 1688
"<?xml version=1.0?>
<authorization-code>AC789U</authorization-code>
<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>
<card>4111111111111111</card>
<card-inquiry>true</card-inquiry>
<cash-back-amount>text</cash-back-amount>
<check-field-mid>true</check-field-mid>
<client-ip>127.0.0.1</client-ip>
<comments>Bad tipper .90 on 80.00 transaction</comments>
<contactless>false</contactless>
<contactless-device>false</contactless-device>
<csc>999</csc>
<customer-id>Customer 1234</customer-id>
<description>Transaction desc</description>
<email-address>[email protected]</email-address>
<email-receipt>false</email-receipt>
<encrypted-track-data>text</encrypted-track-data>
<invoice>invoice123</invoice>
<is-amex>false</is-amex>
<is-sp30>false</is-sp30>
<level3>TRUE</level3>
<order-id>99988d</order-id>
<partial-authorization>false</partial-authorization>
<pin-data>text</pin-data>
<platform-fees>
<fee-name>DealManager</fee-name>
</platform-fees>
<purchase-order>PO789</purchase-order>
<sales-tax-amount>90.00</sales-tax-amount>
<sales-tax-type>LOCAL_SALES_TAX</sales-tax-type>
<service-fee>2.90</service-fee>
<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_Verrsion1.3</software-type>
<tip-amount>0.90</tip-amount>
<track2-data>text</track2-data>
<type>SALE</type>
<voucher-approval-code>text</voucher-approval-code>
<voucher-serial-number>text</voucher-serial-number>
<amount>80.00</amount>
<exp-date>0932</exp-date>
<id>text</id>
<software-type-version>text</software-type-version>
<card-type>VISA</card-type>
<create-token>false</create-token>
<merchant-legacy-token>false</merchant-legacy-token>
<token-description>text</token-description>
<track-format>MAGTEK</track-format>
<check-field>invoice</check-field>
<cvm>NON (None)</cvm>
<emv-data>text</emv-data>
<emv-entry-method>EMV_DIP</emv-entry-method>
<key-serial-number>text</key-serial-number>
"<?xml version="1.0"?>
<object>
<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>
<card>text</card>
<cash-back-amount>text</cash-back-amount>
<ebt-additional-amounts>
<account-type>text</account-type>
<amount>text</amount>
<amount-type>text</amount-type>
</ebt-additional-amounts>
<emv>
<application-id>A0000000041010</application-id>
<application-name>Visa Debit</application-name>
<application-transaction-counter>text</application-transaction-counter>
<iad>text</iad>
<terminal-verification-results>0400088000</terminal-verification-results>
<transaction-certificate>text</transaction-certificate>
<transaction-status-information>E800</transaction-status-information>
</emv>
<level3>TRUE</level3>
<partial-approved>false</partial-approved>
<partial-authorization>false</partial-authorization>
<serverId>text</serverId>
<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>
<voucher-approval-code>text</voucher-approval-code>
<voucher-serial-number>text</voucher-serial-number>
<amount>text</amount>
<authorization-code>AE12368</authorization-code>
<avs-result-code>X</avs-result-code>
<avs-result-code-description>All digits match (9-digit Zip Code)</avs-result-code-description>
<avs-street>Example Street</avs-street>
<avs-zip>85284</avs-zip>
<base-amount>text</base-amount>
<batch-string-id>000101</batch-string-id>
<billing-is-shipping>true</billing-is-shipping>
<card-type>VISA</card-type>
<check-field-duplicate>false</check-field-duplicate>
<client-ip>127.0.0.1</client-ip>
<comments>These are my comments</comments>
<contactless>false</contactless>
<contactless-device>false</contactless-device>
<created>8/10/2017 12:12:12:00 UTC</created>
<csc>999</csc>
<csc-result-code>X</csc-result-code>
<csc-result-code-description>Service provider did not respond</csc-result-code-description>
<customer-first-name>John</customer-first-name>
<customer-id>1234Customer</customer-id>
<customer-last-name>Doe</customer-last-name>
<cvm>NON</cvm>
<description>transaction description</description>
<display-message>Transaction Approved</display-message>
<email-address>[email protected]</email-address>
<emv-data>0099daje93993903</emv-data>
<emv-data-response>text</emv-data-response>
<emv-entry-method>EMV_DIP</emv-entry-method>
<entry-method>EMV_DIP</entry-method>
<exp-date>1232</exp-date>
<first-recurring-transaction>false</first-recurring-transaction>
<id>123456</id>
<invoice>Test56</invoice>
<key-serial-number>0099daje93993903</key-serial-number>
<last-four>text</last-four>
<merchant-id>text</merchant-id>
<order-id>order99</order-id>
<original-amount>12.00</original-amount>
<pending>false</pending>
<plan-name>Plan 56</plan-name>
<platform-fees>
<fee-name>DealManager</fee-name>
</platform-fees>
<purchase-order>purcahseOrder88</purchase-order>
<ref-id>568972</ref-id>
<result>APPROVED</result>
<result-code>000</result-code>
<sales-tax-amount>6.00</sales-tax-amount>
<sales-tax-type>text</sales-tax-type>
<service-fee>text</service-fee>
<settled>false</settled>
<signature-base-64-image>text</signature-base-64-image>
<software-type>MySoftware_Version1.3</software-type>
<status>approved</status>
<surcharge-applied>false</surcharge-applied>
<terminal-id>text</terminal-id>
<tip-adjusted>false</tip-adjusted>
<tip-adjusted-amount>1.00</tip-adjusted-amount>
<tip-amount>0.20</tip-amount>
<type>SALE</type>
<voided>false</voided>
<voided-auth>false</voided-auth>
<token-description>text</token-description>
</object>
If you run an authorization, in order to settle the transaction you MUST run a capture. To run a capture see our transaction endpoint (rest/v2/transactions/capture). You only need to pass in the amount and type. In this case the terminal will collect relevant card data. Here is an example of a minimal working transaction {"amount":"2.00", "type":"AUTH"}
apiKeyValue
Required for Forced Sale. The authorization code of the transactions obtained from another source
AC789UTrue if shipping address matches billing address
falsecard number or credit card token
4111111111111111When tokenizing the card our system will run a card inquiry by default to ensure the card is valid prior to storing the card. To override this pass false.
trueOptional field to signify cash back amount when using EBT cash benefits
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.
trueIP Address of where request orginiated (Create for ecommerce apps)
127.0.0.1Additonal Comments about the transaction
Bad tipper .90 on 80.00 transactionUsed for FULL EMV integrations only (not for semi integrated)
falseUsed for FULL EMV integrations only (not for semi integrated)
falseOptional field to pass with transactions where you pass the card data
999Customer Identifier of the transaction
Customer 1234Description of the transaction
Transaction descpass in if you would like to email a receipt. If true, email-address is required.
falseEncrypted Track Data can be passed instead of card number, Requires TrackFromat to be set
VarChar value up to 100 characters.
invoice123Optional field to signify if card being used is an American Express card
Optional field to signify if terminal being used is a SP30
Order Id
99988dpass in if you would like to check partial authorization.
VarChar value up to 100 characters.
PO789Optional for Capture and Sale transctions, required to qualify with Level II
90.00Optional for Capture and Sale transactions, required to qualify with Level II
LOCAL_SALES_TAXPossible values: Optional on a SALE/Capture. Requires 2 decimal places. Must be less than or equal to 3.99% of total amount (amount + sales-tax-amount + tip-amount)
2.90Not Required, but will help with troubleshooting if you have isseus or problems
MySoftware_Verrsion1.3optional on a SALE/Capture. Requires 2 decimal places.
0.90Clear Text track data can be passed instead of card
Type of transaction you would like to run
SALEPossible values: Field required when using EBT electronic voucher
Field required when using EBT electronic voucher
amount of transaction
80.00expiration date, MMyy format
0932id returned on a sale or auth; use for void, capture, refund, and tip-adjust
Not Required, but will help with troubleshooting if you have isseus or problems
Required if create-token is true. Type of card
VISAPossible values: pass in if you would like to create a token as part of the transaction, Optional on an AUTH or SALE
falsepass in if you would like to use a legacy token in your transaction request, Optional on an AUTH or SALE
falseRequired if create-token is true. Description of the token (ie savings acct
Encrypted Track Data can be passed instead of card, the format of that encrypted data
Optional duplication check for transactions. If you send in a check field we will validate that field is not duplicated for EMV transactions.
invoiceUsed for FULL EMV integrations only (not for semi integrated)
Used for FULL EMV integrations only (not for semi integrated)
Used for FULL EMV integrations only (not for semi integrated)
Used for FULL EMV integrations only (not for semi integrated)
POST //rest/v2/terminal/transactions/auth HTTP/1.1
Host: gateway-sb.clearent.net
Content-Type: application/xml
Accept: */*
Content-Length: 1688
"<?xml version=1.0?>
<authorization-code>AC789U</authorization-code>
<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>
<card>4111111111111111</card>
<card-inquiry>true</card-inquiry>
<cash-back-amount>text</cash-back-amount>
<check-field-mid>true</check-field-mid>
<client-ip>127.0.0.1</client-ip>
<comments>Bad tipper .90 on 80.00 transaction</comments>
<contactless>false</contactless>
<contactless-device>false</contactless-device>
<csc>999</csc>
<customer-id>Customer 1234</customer-id>
<description>Transaction desc</description>
<email-address>[email protected]</email-address>
<email-receipt>false</email-receipt>
<encrypted-track-data>text</encrypted-track-data>
<invoice>invoice123</invoice>
<is-amex>false</is-amex>
<is-sp30>false</is-sp30>
<level3>TRUE</level3>
<order-id>99988d</order-id>
<partial-authorization>false</partial-authorization>
<pin-data>text</pin-data>
<platform-fees>
<fee-name>DealManager</fee-name>
</platform-fees>
<purchase-order>PO789</purchase-order>
<sales-tax-amount>90.00</sales-tax-amount>
<sales-tax-type>LOCAL_SALES_TAX</sales-tax-type>
<service-fee>2.90</service-fee>
<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_Verrsion1.3</software-type>
<tip-amount>0.90</tip-amount>
<track2-data>text</track2-data>
<type>SALE</type>
<voucher-approval-code>text</voucher-approval-code>
<voucher-serial-number>text</voucher-serial-number>
<amount>80.00</amount>
<exp-date>0932</exp-date>
<id>text</id>
<software-type-version>text</software-type-version>
<card-type>VISA</card-type>
<create-token>false</create-token>
<merchant-legacy-token>false</merchant-legacy-token>
<token-description>text</token-description>
<track-format>MAGTEK</track-format>
<check-field>invoice</check-field>
<cvm>NON (None)</cvm>
<emv-data>text</emv-data>
<emv-entry-method>EMV_DIP</emv-entry-method>
<key-serial-number>text</key-serial-number>
"<?xml version="1.0"?>
<object>
<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>
<card>text</card>
<cash-back-amount>text</cash-back-amount>
<ebt-additional-amounts>
<account-type>text</account-type>
<amount>text</amount>
<amount-type>text</amount-type>
</ebt-additional-amounts>
<emv>
<application-id>A0000000041010</application-id>
<application-name>Visa Debit</application-name>
<application-transaction-counter>text</application-transaction-counter>
<iad>text</iad>
<terminal-verification-results>0400088000</terminal-verification-results>
<transaction-certificate>text</transaction-certificate>
<transaction-status-information>E800</transaction-status-information>
</emv>
<level3>TRUE</level3>
<partial-approved>false</partial-approved>
<partial-authorization>false</partial-authorization>
<serverId>text</serverId>
<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>
<voucher-approval-code>text</voucher-approval-code>
<voucher-serial-number>text</voucher-serial-number>
<amount>text</amount>
<authorization-code>AE12368</authorization-code>
<avs-result-code>X</avs-result-code>
<avs-result-code-description>All digits match (9-digit Zip Code)</avs-result-code-description>
<avs-street>Example Street</avs-street>
<avs-zip>85284</avs-zip>
<base-amount>text</base-amount>
<batch-string-id>000101</batch-string-id>
<billing-is-shipping>true</billing-is-shipping>
<card-type>VISA</card-type>
<check-field-duplicate>false</check-field-duplicate>
<client-ip>127.0.0.1</client-ip>
<comments>These are my comments</comments>
<contactless>false</contactless>
<contactless-device>false</contactless-device>
<created>8/10/2017 12:12:12:00 UTC</created>
<csc>999</csc>
<csc-result-code>X</csc-result-code>
<csc-result-code-description>Service provider did not respond</csc-result-code-description>
<customer-first-name>John</customer-first-name>
<customer-id>1234Customer</customer-id>
<customer-last-name>Doe</customer-last-name>
<cvm>NON</cvm>
<description>transaction description</description>
<display-message>Transaction Approved</display-message>
<email-address>[email protected]</email-address>
<emv-data>0099daje93993903</emv-data>
<emv-data-response>text</emv-data-response>
<emv-entry-method>EMV_DIP</emv-entry-method>
<entry-method>EMV_DIP</entry-method>
<exp-date>1232</exp-date>
<first-recurring-transaction>false</first-recurring-transaction>
<id>123456</id>
<invoice>Test56</invoice>
<key-serial-number>0099daje93993903</key-serial-number>
<last-four>text</last-four>
<merchant-id>text</merchant-id>
<order-id>order99</order-id>
<original-amount>12.00</original-amount>
<pending>false</pending>
<plan-name>Plan 56</plan-name>
<platform-fees>
<fee-name>DealManager</fee-name>
</platform-fees>
<purchase-order>purcahseOrder88</purchase-order>
<ref-id>568972</ref-id>
<result>APPROVED</result>
<result-code>000</result-code>
<sales-tax-amount>6.00</sales-tax-amount>
<sales-tax-type>text</sales-tax-type>
<service-fee>text</service-fee>
<settled>false</settled>
<signature-base-64-image>text</signature-base-64-image>
<software-type>MySoftware_Version1.3</software-type>
<status>approved</status>
<surcharge-applied>false</surcharge-applied>
<terminal-id>text</terminal-id>
<tip-adjusted>false</tip-adjusted>
<tip-adjusted-amount>1.00</tip-adjusted-amount>
<tip-amount>0.20</tip-amount>
<type>SALE</type>
<voided>false</voided>
<voided-auth>false</voided-auth>
<token-description>text</token-description>
</object>
A forced sale, is a transaction where you already have the authorization code, and you are forcing that through, you are not obtaining a new authorization. If possible run a sale, this should be used only for special cases. You only need to pass in the amount and type. In this case the terminal will collect relevant card data. Here is an example of a minimal working transaction {"amount":"2.00", "type":"FORCED SALE"}
apiKeyValue
Required for Forced Sale. The authorization code of the transactions obtained from another source
AC789UTrue if shipping address matches billing address
falsecard number or credit card token
4111111111111111When tokenizing the card our system will run a card inquiry by default to ensure the card is valid prior to storing the card. To override this pass false.
trueOptional field to signify cash back amount when using EBT cash benefits
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.
trueIP Address of where request orginiated (Create for ecommerce apps)
127.0.0.1Additonal Comments about the transaction
Bad tipper .90 on 80.00 transactionUsed for FULL EMV integrations only (not for semi integrated)
falseUsed for FULL EMV integrations only (not for semi integrated)
falseOptional field to pass with transactions where you pass the card data
999Customer Identifier of the transaction
Customer 1234Description of the transaction
Transaction descpass in if you would like to email a receipt. If true, email-address is required.
falseEncrypted Track Data can be passed instead of card number, Requires TrackFromat to be set
VarChar value up to 100 characters.
invoice123Optional field to signify if card being used is an American Express card
Optional field to signify if terminal being used is a SP30
Order Id
99988dpass in if you would like to check partial authorization.
VarChar value up to 100 characters.
PO789Optional for Capture and Sale transctions, required to qualify with Level II
90.00Optional for Capture and Sale transactions, required to qualify with Level II
LOCAL_SALES_TAXPossible values: Optional on a SALE/Capture. Requires 2 decimal places. Must be less than or equal to 3.99% of total amount (amount + sales-tax-amount + tip-amount)
2.90Not Required, but will help with troubleshooting if you have isseus or problems
MySoftware_Verrsion1.3optional on a SALE/Capture. Requires 2 decimal places.
0.90Clear Text track data can be passed instead of card
Type of transaction you would like to run
SALEPossible values: Field required when using EBT electronic voucher
Field required when using EBT electronic voucher
amount of transaction
80.00expiration date, MMyy format
0932id returned on a sale or auth; use for void, capture, refund, and tip-adjust
Not Required, but will help with troubleshooting if you have isseus or problems
Required if create-token is true. Type of card
VISAPossible values: pass in if you would like to create a token as part of the transaction, Optional on an AUTH or SALE
falsepass in if you would like to use a legacy token in your transaction request, Optional on an AUTH or SALE
falseRequired if create-token is true. Description of the token (ie savings acct
Encrypted Track Data can be passed instead of card, the format of that encrypted data
Optional duplication check for transactions. If you send in a check field we will validate that field is not duplicated for EMV transactions.
invoiceUsed for FULL EMV integrations only (not for semi integrated)
Used for FULL EMV integrations only (not for semi integrated)
Used for FULL EMV integrations only (not for semi integrated)
Used for FULL EMV integrations only (not for semi integrated)
POST //rest/v2/terminal/transactions/forced-sale HTTP/1.1
Host: gateway-sb.clearent.net
Content-Type: application/xml
Accept: */*
Content-Length: 1688
"<?xml version=1.0?>
<authorization-code>AC789U</authorization-code>
<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>
<card>4111111111111111</card>
<card-inquiry>true</card-inquiry>
<cash-back-amount>text</cash-back-amount>
<check-field-mid>true</check-field-mid>
<client-ip>127.0.0.1</client-ip>
<comments>Bad tipper .90 on 80.00 transaction</comments>
<contactless>false</contactless>
<contactless-device>false</contactless-device>
<csc>999</csc>
<customer-id>Customer 1234</customer-id>
<description>Transaction desc</description>
<email-address>[email protected]</email-address>
<email-receipt>false</email-receipt>
<encrypted-track-data>text</encrypted-track-data>
<invoice>invoice123</invoice>
<is-amex>false</is-amex>
<is-sp30>false</is-sp30>
<level3>TRUE</level3>
<order-id>99988d</order-id>
<partial-authorization>false</partial-authorization>
<pin-data>text</pin-data>
<platform-fees>
<fee-name>DealManager</fee-name>
</platform-fees>
<purchase-order>PO789</purchase-order>
<sales-tax-amount>90.00</sales-tax-amount>
<sales-tax-type>LOCAL_SALES_TAX</sales-tax-type>
<service-fee>2.90</service-fee>
<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_Verrsion1.3</software-type>
<tip-amount>0.90</tip-amount>
<track2-data>text</track2-data>
<type>SALE</type>
<voucher-approval-code>text</voucher-approval-code>
<voucher-serial-number>text</voucher-serial-number>
<amount>80.00</amount>
<exp-date>0932</exp-date>
<id>text</id>
<software-type-version>text</software-type-version>
<card-type>VISA</card-type>
<create-token>false</create-token>
<merchant-legacy-token>false</merchant-legacy-token>
<token-description>text</token-description>
<track-format>MAGTEK</track-format>
<check-field>invoice</check-field>
<cvm>NON (None)</cvm>
<emv-data>text</emv-data>
<emv-entry-method>EMV_DIP</emv-entry-method>
<key-serial-number>text</key-serial-number>
"<?xml version="1.0"?>
<object>
<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>
<card>text</card>
<cash-back-amount>text</cash-back-amount>
<ebt-additional-amounts>
<account-type>text</account-type>
<amount>text</amount>
<amount-type>text</amount-type>
</ebt-additional-amounts>
<emv>
<application-id>A0000000041010</application-id>
<application-name>Visa Debit</application-name>
<application-transaction-counter>text</application-transaction-counter>
<iad>text</iad>
<terminal-verification-results>0400088000</terminal-verification-results>
<transaction-certificate>text</transaction-certificate>
<transaction-status-information>E800</transaction-status-information>
</emv>
<level3>TRUE</level3>
<partial-approved>false</partial-approved>
<partial-authorization>false</partial-authorization>
<serverId>text</serverId>
<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>
<voucher-approval-code>text</voucher-approval-code>
<voucher-serial-number>text</voucher-serial-number>
<amount>text</amount>
<authorization-code>AE12368</authorization-code>
<avs-result-code>X</avs-result-code>
<avs-result-code-description>All digits match (9-digit Zip Code)</avs-result-code-description>
<avs-street>Example Street</avs-street>
<avs-zip>85284</avs-zip>
<base-amount>text</base-amount>
<batch-string-id>000101</batch-string-id>
<billing-is-shipping>true</billing-is-shipping>
<card-type>VISA</card-type>
<check-field-duplicate>false</check-field-duplicate>
<client-ip>127.0.0.1</client-ip>
<comments>These are my comments</comments>
<contactless>false</contactless>
<contactless-device>false</contactless-device>
<created>8/10/2017 12:12:12:00 UTC</created>
<csc>999</csc>
<csc-result-code>X</csc-result-code>
<csc-result-code-description>Service provider did not respond</csc-result-code-description>
<customer-first-name>John</customer-first-name>
<customer-id>1234Customer</customer-id>
<customer-last-name>Doe</customer-last-name>
<cvm>NON</cvm>
<description>transaction description</description>
<display-message>Transaction Approved</display-message>
<email-address>[email protected]</email-address>
<emv-data>0099daje93993903</emv-data>
<emv-data-response>text</emv-data-response>
<emv-entry-method>EMV_DIP</emv-entry-method>
<entry-method>EMV_DIP</entry-method>
<exp-date>1232</exp-date>
<first-recurring-transaction>false</first-recurring-transaction>
<id>123456</id>
<invoice>Test56</invoice>
<key-serial-number>0099daje93993903</key-serial-number>
<last-four>text</last-four>
<merchant-id>text</merchant-id>
<order-id>order99</order-id>
<original-amount>12.00</original-amount>
<pending>false</pending>
<plan-name>Plan 56</plan-name>
<platform-fees>
<fee-name>DealManager</fee-name>
</platform-fees>
<purchase-order>purcahseOrder88</purchase-order>
<ref-id>568972</ref-id>
<result>APPROVED</result>
<result-code>000</result-code>
<sales-tax-amount>6.00</sales-tax-amount>
<sales-tax-type>text</sales-tax-type>
<service-fee>text</service-fee>
<settled>false</settled>
<signature-base-64-image>text</signature-base-64-image>
<software-type>MySoftware_Version1.3</software-type>
<status>approved</status>
<surcharge-applied>false</surcharge-applied>
<terminal-id>text</terminal-id>
<tip-adjusted>false</tip-adjusted>
<tip-adjusted-amount>1.00</tip-adjusted-amount>
<tip-amount>0.20</tip-amount>
<type>SALE</type>
<voided>false</voided>
<voided-auth>false</voided-auth>
<token-description>text</token-description>
</object>
You only need to pass in the amount and type. In this case the terminal will collect relevant card data. Here is an example of a minimal working transaction {"amount":"2.00", "type":"REFUND"}
apiKeyValue
Required for Forced Sale. The authorization code of the transactions obtained from another source
AC789UTrue if shipping address matches billing address
falsecard number or credit card token
4111111111111111When tokenizing the card our system will run a card inquiry by default to ensure the card is valid prior to storing the card. To override this pass false.
trueOptional field to signify cash back amount when using EBT cash benefits
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.
trueIP Address of where request orginiated (Create for ecommerce apps)
127.0.0.1Additonal Comments about the transaction
Bad tipper .90 on 80.00 transactionUsed for FULL EMV integrations only (not for semi integrated)
falseUsed for FULL EMV integrations only (not for semi integrated)
falseOptional field to pass with transactions where you pass the card data
999Customer Identifier of the transaction
Customer 1234Description of the transaction
Transaction descpass in if you would like to email a receipt. If true, email-address is required.
falseEncrypted Track Data can be passed instead of card number, Requires TrackFromat to be set
VarChar value up to 100 characters.
invoice123Optional field to signify if card being used is an American Express card
Optional field to signify if terminal being used is a SP30
Order Id
99988dpass in if you would like to check partial authorization.
VarChar value up to 100 characters.
PO789Optional for Capture and Sale transctions, required to qualify with Level II
90.00Optional for Capture and Sale transactions, required to qualify with Level II
LOCAL_SALES_TAXPossible values: Optional on a SALE/Capture. Requires 2 decimal places. Must be less than or equal to 3.99% of total amount (amount + sales-tax-amount + tip-amount)
2.90Not Required, but will help with troubleshooting if you have isseus or problems
MySoftware_Verrsion1.3optional on a SALE/Capture. Requires 2 decimal places.
0.90Clear Text track data can be passed instead of card
Type of transaction you would like to run
SALEPossible values: Field required when using EBT electronic voucher
Field required when using EBT electronic voucher
amount of transaction
80.00expiration date, MMyy format
0932id returned on a sale or auth; use for void, capture, refund, and tip-adjust
Not Required, but will help with troubleshooting if you have isseus or problems
Required if create-token is true. Type of card
VISAPossible values: pass in if you would like to create a token as part of the transaction, Optional on an AUTH or SALE
falsepass in if you would like to use a legacy token in your transaction request, Optional on an AUTH or SALE
falseRequired if create-token is true. Description of the token (ie savings acct
Encrypted Track Data can be passed instead of card, the format of that encrypted data
Optional duplication check for transactions. If you send in a check field we will validate that field is not duplicated for EMV transactions.
invoiceUsed for FULL EMV integrations only (not for semi integrated)
Used for FULL EMV integrations only (not for semi integrated)
Used for FULL EMV integrations only (not for semi integrated)
Used for FULL EMV integrations only (not for semi integrated)
POST //rest/v2/terminal/transactions/refund HTTP/1.1
Host: gateway-sb.clearent.net
Content-Type: application/xml
Accept: */*
Content-Length: 1688
"<?xml version=1.0?>
<authorization-code>AC789U</authorization-code>
<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>
<card>4111111111111111</card>
<card-inquiry>true</card-inquiry>
<cash-back-amount>text</cash-back-amount>
<check-field-mid>true</check-field-mid>
<client-ip>127.0.0.1</client-ip>
<comments>Bad tipper .90 on 80.00 transaction</comments>
<contactless>false</contactless>
<contactless-device>false</contactless-device>
<csc>999</csc>
<customer-id>Customer 1234</customer-id>
<description>Transaction desc</description>
<email-address>[email protected]</email-address>
<email-receipt>false</email-receipt>
<encrypted-track-data>text</encrypted-track-data>
<invoice>invoice123</invoice>
<is-amex>false</is-amex>
<is-sp30>false</is-sp30>
<level3>TRUE</level3>
<order-id>99988d</order-id>
<partial-authorization>false</partial-authorization>
<pin-data>text</pin-data>
<platform-fees>
<fee-name>DealManager</fee-name>
</platform-fees>
<purchase-order>PO789</purchase-order>
<sales-tax-amount>90.00</sales-tax-amount>
<sales-tax-type>LOCAL_SALES_TAX</sales-tax-type>
<service-fee>2.90</service-fee>
<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_Verrsion1.3</software-type>
<tip-amount>0.90</tip-amount>
<track2-data>text</track2-data>
<type>SALE</type>
<voucher-approval-code>text</voucher-approval-code>
<voucher-serial-number>text</voucher-serial-number>
<amount>80.00</amount>
<exp-date>0932</exp-date>
<id>text</id>
<software-type-version>text</software-type-version>
<card-type>VISA</card-type>
<create-token>false</create-token>
<merchant-legacy-token>false</merchant-legacy-token>
<token-description>text</token-description>
<track-format>MAGTEK</track-format>
<check-field>invoice</check-field>
<cvm>NON (None)</cvm>
<emv-data>text</emv-data>
<emv-entry-method>EMV_DIP</emv-entry-method>
<key-serial-number>text</key-serial-number>
"<?xml version="1.0"?>
<object>
<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>
<card>text</card>
<cash-back-amount>text</cash-back-amount>
<ebt-additional-amounts>
<account-type>text</account-type>
<amount>text</amount>
<amount-type>text</amount-type>
</ebt-additional-amounts>
<emv>
<application-id>A0000000041010</application-id>
<application-name>Visa Debit</application-name>
<application-transaction-counter>text</application-transaction-counter>
<iad>text</iad>
<terminal-verification-results>0400088000</terminal-verification-results>
<transaction-certificate>text</transaction-certificate>
<transaction-status-information>E800</transaction-status-information>
</emv>
<level3>TRUE</level3>
<partial-approved>false</partial-approved>
<partial-authorization>false</partial-authorization>
<serverId>text</serverId>
<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>
<voucher-approval-code>text</voucher-approval-code>
<voucher-serial-number>text</voucher-serial-number>
<amount>text</amount>
<authorization-code>AE12368</authorization-code>
<avs-result-code>X</avs-result-code>
<avs-result-code-description>All digits match (9-digit Zip Code)</avs-result-code-description>
<avs-street>Example Street</avs-street>
<avs-zip>85284</avs-zip>
<base-amount>text</base-amount>
<batch-string-id>000101</batch-string-id>
<billing-is-shipping>true</billing-is-shipping>
<card-type>VISA</card-type>
<check-field-duplicate>false</check-field-duplicate>
<client-ip>127.0.0.1</client-ip>
<comments>These are my comments</comments>
<contactless>false</contactless>
<contactless-device>false</contactless-device>
<created>8/10/2017 12:12:12:00 UTC</created>
<csc>999</csc>
<csc-result-code>X</csc-result-code>
<csc-result-code-description>Service provider did not respond</csc-result-code-description>
<customer-first-name>John</customer-first-name>
<customer-id>1234Customer</customer-id>
<customer-last-name>Doe</customer-last-name>
<cvm>NON</cvm>
<description>transaction description</description>
<display-message>Transaction Approved</display-message>
<email-address>[email protected]</email-address>
<emv-data>0099daje93993903</emv-data>
<emv-data-response>text</emv-data-response>
<emv-entry-method>EMV_DIP</emv-entry-method>
<entry-method>EMV_DIP</entry-method>
<exp-date>1232</exp-date>
<first-recurring-transaction>false</first-recurring-transaction>
<id>123456</id>
<invoice>Test56</invoice>
<key-serial-number>0099daje93993903</key-serial-number>
<last-four>text</last-four>
<merchant-id>text</merchant-id>
<order-id>order99</order-id>
<original-amount>12.00</original-amount>
<pending>false</pending>
<plan-name>Plan 56</plan-name>
<platform-fees>
<fee-name>DealManager</fee-name>
</platform-fees>
<purchase-order>purcahseOrder88</purchase-order>
<ref-id>568972</ref-id>
<result>APPROVED</result>
<result-code>000</result-code>
<sales-tax-amount>6.00</sales-tax-amount>
<sales-tax-type>text</sales-tax-type>
<service-fee>text</service-fee>
<settled>false</settled>
<signature-base-64-image>text</signature-base-64-image>
<software-type>MySoftware_Version1.3</software-type>
<status>approved</status>
<surcharge-applied>false</surcharge-applied>
<terminal-id>text</terminal-id>
<tip-adjusted>false</tip-adjusted>
<tip-adjusted-amount>1.00</tip-adjusted-amount>
<tip-amount>0.20</tip-amount>
<type>SALE</type>
<voided>false</voided>
<voided-auth>false</voided-auth>
<token-description>text</token-description>
</object>
You only need to pass in the amount and type. In this case the terminal will collect relevant card data. Here is an example of a minimal working transaction {"amount":"2.00", "type":"SALE"}
api key provided
Required for Forced Sale. The authorization code of the transactions obtained from another source
AC789UTrue if shipping address matches billing address
falsecard number or credit card token
4111111111111111When tokenizing the card our system will run a card inquiry by default to ensure the card is valid prior to storing the card. To override this pass false.
trueOptional field to signify cash back amount when using EBT cash benefits
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.
trueIP Address of where request orginiated (Create for ecommerce apps)
127.0.0.1Additonal Comments about the transaction
Bad tipper .90 on 80.00 transactionUsed for FULL EMV integrations only (not for semi integrated)
falseUsed for FULL EMV integrations only (not for semi integrated)
falseOptional field to pass with transactions where you pass the card data
999Customer Identifier of the transaction
Customer 1234Description of the transaction
Transaction descpass in if you would like to email a receipt. If true, email-address is required.
falseEncrypted Track Data can be passed instead of card number, Requires TrackFromat to be set
VarChar value up to 100 characters.
invoice123Optional field to signify if card being used is an American Express card
Optional field to signify if terminal being used is a SP30
Order Id
99988dpass in if you would like to check partial authorization.
VarChar value up to 100 characters.
PO789Optional for Capture and Sale transctions, required to qualify with Level II
90.00Optional for Capture and Sale transactions, required to qualify with Level II
LOCAL_SALES_TAXPossible values: Optional on a SALE/Capture. Requires 2 decimal places. Must be less than or equal to 3.99% of total amount (amount + sales-tax-amount + tip-amount)
2.90Not Required, but will help with troubleshooting if you have isseus or problems
MySoftware_Verrsion1.3optional on a SALE/Capture. Requires 2 decimal places.
0.90Clear Text track data can be passed instead of card
Type of transaction you would like to run
SALEPossible values: Field required when using EBT electronic voucher
Field required when using EBT electronic voucher
amount of transaction
80.00expiration date, MMyy format
0932id returned on a sale or auth; use for void, capture, refund, and tip-adjust
Not Required, but will help with troubleshooting if you have isseus or problems
Required if create-token is true. Type of card
VISAPossible values: pass in if you would like to create a token as part of the transaction, Optional on an AUTH or SALE
falsepass in if you would like to use a legacy token in your transaction request, Optional on an AUTH or SALE
falseRequired if create-token is true. Description of the token (ie savings acct
Encrypted Track Data can be passed instead of card, the format of that encrypted data
Optional duplication check for transactions. If you send in a check field we will validate that field is not duplicated for EMV transactions.
invoiceUsed for FULL EMV integrations only (not for semi integrated)
Used for FULL EMV integrations only (not for semi integrated)
Used for FULL EMV integrations only (not for semi integrated)
Used for FULL EMV integrations only (not for semi integrated)
POST //rest/v2/terminal/transactions/sale HTTP/1.1
Host: gateway-sb.clearent.net
Content-Type: application/xml
Accept: */*
Content-Length: 1688
"<?xml version=1.0?>
<authorization-code>AC789U</authorization-code>
<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>
<card>4111111111111111</card>
<card-inquiry>true</card-inquiry>
<cash-back-amount>text</cash-back-amount>
<check-field-mid>true</check-field-mid>
<client-ip>127.0.0.1</client-ip>
<comments>Bad tipper .90 on 80.00 transaction</comments>
<contactless>false</contactless>
<contactless-device>false</contactless-device>
<csc>999</csc>
<customer-id>Customer 1234</customer-id>
<description>Transaction desc</description>
<email-address>[email protected]</email-address>
<email-receipt>false</email-receipt>
<encrypted-track-data>text</encrypted-track-data>
<invoice>invoice123</invoice>
<is-amex>false</is-amex>
<is-sp30>false</is-sp30>
<level3>TRUE</level3>
<order-id>99988d</order-id>
<partial-authorization>false</partial-authorization>
<pin-data>text</pin-data>
<platform-fees>
<fee-name>DealManager</fee-name>
</platform-fees>
<purchase-order>PO789</purchase-order>
<sales-tax-amount>90.00</sales-tax-amount>
<sales-tax-type>LOCAL_SALES_TAX</sales-tax-type>
<service-fee>2.90</service-fee>
<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_Verrsion1.3</software-type>
<tip-amount>0.90</tip-amount>
<track2-data>text</track2-data>
<type>SALE</type>
<voucher-approval-code>text</voucher-approval-code>
<voucher-serial-number>text</voucher-serial-number>
<amount>80.00</amount>
<exp-date>0932</exp-date>
<id>text</id>
<software-type-version>text</software-type-version>
<card-type>VISA</card-type>
<create-token>false</create-token>
<merchant-legacy-token>false</merchant-legacy-token>
<token-description>text</token-description>
<track-format>MAGTEK</track-format>
<check-field>invoice</check-field>
<cvm>NON (None)</cvm>
<emv-data>text</emv-data>
<emv-entry-method>EMV_DIP</emv-entry-method>
<key-serial-number>text</key-serial-number>
"<?xml version="1.0"?>
<object>
<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>
<card>text</card>
<cash-back-amount>text</cash-back-amount>
<ebt-additional-amounts>
<account-type>text</account-type>
<amount>text</amount>
<amount-type>text</amount-type>
</ebt-additional-amounts>
<emv>
<application-id>A0000000041010</application-id>
<application-name>Visa Debit</application-name>
<application-transaction-counter>text</application-transaction-counter>
<iad>text</iad>
<terminal-verification-results>0400088000</terminal-verification-results>
<transaction-certificate>text</transaction-certificate>
<transaction-status-information>E800</transaction-status-information>
</emv>
<level3>TRUE</level3>
<partial-approved>false</partial-approved>
<partial-authorization>false</partial-authorization>
<serverId>text</serverId>
<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>
<voucher-approval-code>text</voucher-approval-code>
<voucher-serial-number>text</voucher-serial-number>
<amount>text</amount>
<authorization-code>AE12368</authorization-code>
<avs-result-code>X</avs-result-code>
<avs-result-code-description>All digits match (9-digit Zip Code)</avs-result-code-description>
<avs-street>Example Street</avs-street>
<avs-zip>85284</avs-zip>
<base-amount>text</base-amount>
<batch-string-id>000101</batch-string-id>
<billing-is-shipping>true</billing-is-shipping>
<card-type>VISA</card-type>
<check-field-duplicate>false</check-field-duplicate>
<client-ip>127.0.0.1</client-ip>
<comments>These are my comments</comments>
<contactless>false</contactless>
<contactless-device>false</contactless-device>
<created>8/10/2017 12:12:12:00 UTC</created>
<csc>999</csc>
<csc-result-code>X</csc-result-code>
<csc-result-code-description>Service provider did not respond</csc-result-code-description>
<customer-first-name>John</customer-first-name>
<customer-id>1234Customer</customer-id>
<customer-last-name>Doe</customer-last-name>
<cvm>NON</cvm>
<description>transaction description</description>
<display-message>Transaction Approved</display-message>
<email-address>[email protected]</email-address>
<emv-data>0099daje93993903</emv-data>
<emv-data-response>text</emv-data-response>
<emv-entry-method>EMV_DIP</emv-entry-method>
<entry-method>EMV_DIP</entry-method>
<exp-date>1232</exp-date>
<first-recurring-transaction>false</first-recurring-transaction>
<id>123456</id>
<invoice>Test56</invoice>
<key-serial-number>0099daje93993903</key-serial-number>
<last-four>text</last-four>
<merchant-id>text</merchant-id>
<order-id>order99</order-id>
<original-amount>12.00</original-amount>
<pending>false</pending>
<plan-name>Plan 56</plan-name>
<platform-fees>
<fee-name>DealManager</fee-name>
</platform-fees>
<purchase-order>purcahseOrder88</purchase-order>
<ref-id>568972</ref-id>
<result>APPROVED</result>
<result-code>000</result-code>
<sales-tax-amount>6.00</sales-tax-amount>
<sales-tax-type>text</sales-tax-type>
<service-fee>text</service-fee>
<settled>false</settled>
<signature-base-64-image>text</signature-base-64-image>
<software-type>MySoftware_Version1.3</software-type>
<status>approved</status>
<surcharge-applied>false</surcharge-applied>
<terminal-id>text</terminal-id>
<tip-adjusted>false</tip-adjusted>
<tip-adjusted-amount>1.00</tip-adjusted-amount>
<tip-amount>0.20</tip-amount>
<type>SALE</type>
<voided>false</voided>
<voided-auth>false</voided-auth>
<token-description>text</token-description>
</object>
If you want to just collect card data and create a token for future use. You only need to pass in the amount as 0.00 and type as auth as well as the create-token field. This will check the card is valid but will not auth any amounts. In this case the terminal will collect relevant card data. Here is an example of a minimal working transaction {"amount":0.00", "type":"AUTH","create-token":"true"}
apiKeyValue
Required for Forced Sale. The authorization code of the transactions obtained from another source
AC789UTrue if shipping address matches billing address
falsecard number or credit card token
4111111111111111When tokenizing the card our system will run a card inquiry by default to ensure the card is valid prior to storing the card. To override this pass false.
trueOptional field to signify cash back amount when using EBT cash benefits
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.
trueIP Address of where request orginiated (Create for ecommerce apps)
127.0.0.1Additonal Comments about the transaction
Bad tipper .90 on 80.00 transactionUsed for FULL EMV integrations only (not for semi integrated)
falseUsed for FULL EMV integrations only (not for semi integrated)
falseOptional field to pass with transactions where you pass the card data
999Customer Identifier of the transaction
Customer 1234Description of the transaction
Transaction descpass in if you would like to email a receipt. If true, email-address is required.
falseEncrypted Track Data can be passed instead of card number, Requires TrackFromat to be set
VarChar value up to 100 characters.
invoice123Optional field to signify if card being used is an American Express card
Optional field to signify if terminal being used is a SP30
Order Id
99988dpass in if you would like to check partial authorization.
VarChar value up to 100 characters.
PO789Optional for Capture and Sale transctions, required to qualify with Level II
90.00Optional for Capture and Sale transactions, required to qualify with Level II
LOCAL_SALES_TAXPossible values: Optional on a SALE/Capture. Requires 2 decimal places. Must be less than or equal to 3.99% of total amount (amount + sales-tax-amount + tip-amount)
2.90Not Required, but will help with troubleshooting if you have isseus or problems
MySoftware_Verrsion1.3optional on a SALE/Capture. Requires 2 decimal places.
0.90Clear Text track data can be passed instead of card
Type of transaction you would like to run
SALEPossible values: Field required when using EBT electronic voucher
Field required when using EBT electronic voucher
amount of transaction
80.00expiration date, MMyy format
0932id returned on a sale or auth; use for void, capture, refund, and tip-adjust
Not Required, but will help with troubleshooting if you have isseus or problems
Required if create-token is true. Type of card
VISAPossible values: pass in if you would like to create a token as part of the transaction, Optional on an AUTH or SALE
falsepass in if you would like to use a legacy token in your transaction request, Optional on an AUTH or SALE
falseRequired if create-token is true. Description of the token (ie savings acct
Encrypted Track Data can be passed instead of card, the format of that encrypted data
Optional duplication check for transactions. If you send in a check field we will validate that field is not duplicated for EMV transactions.
invoiceUsed for FULL EMV integrations only (not for semi integrated)
Used for FULL EMV integrations only (not for semi integrated)
Used for FULL EMV integrations only (not for semi integrated)
Used for FULL EMV integrations only (not for semi integrated)
POST //rest/v2/terminal/transactions/token-only HTTP/1.1
Host: gateway-sb.clearent.net
Content-Type: application/xml
Accept: */*
Content-Length: 1688
"<?xml version=1.0?>
<authorization-code>AC789U</authorization-code>
<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>
<card>4111111111111111</card>
<card-inquiry>true</card-inquiry>
<cash-back-amount>text</cash-back-amount>
<check-field-mid>true</check-field-mid>
<client-ip>127.0.0.1</client-ip>
<comments>Bad tipper .90 on 80.00 transaction</comments>
<contactless>false</contactless>
<contactless-device>false</contactless-device>
<csc>999</csc>
<customer-id>Customer 1234</customer-id>
<description>Transaction desc</description>
<email-address>[email protected]</email-address>
<email-receipt>false</email-receipt>
<encrypted-track-data>text</encrypted-track-data>
<invoice>invoice123</invoice>
<is-amex>false</is-amex>
<is-sp30>false</is-sp30>
<level3>TRUE</level3>
<order-id>99988d</order-id>
<partial-authorization>false</partial-authorization>
<pin-data>text</pin-data>
<platform-fees>
<fee-name>DealManager</fee-name>
</platform-fees>
<purchase-order>PO789</purchase-order>
<sales-tax-amount>90.00</sales-tax-amount>
<sales-tax-type>LOCAL_SALES_TAX</sales-tax-type>
<service-fee>2.90</service-fee>
<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_Verrsion1.3</software-type>
<tip-amount>0.90</tip-amount>
<track2-data>text</track2-data>
<type>SALE</type>
<voucher-approval-code>text</voucher-approval-code>
<voucher-serial-number>text</voucher-serial-number>
<amount>80.00</amount>
<exp-date>0932</exp-date>
<id>text</id>
<software-type-version>text</software-type-version>
<card-type>VISA</card-type>
<create-token>false</create-token>
<merchant-legacy-token>false</merchant-legacy-token>
<token-description>text</token-description>
<track-format>MAGTEK</track-format>
<check-field>invoice</check-field>
<cvm>NON (None)</cvm>
<emv-data>text</emv-data>
<emv-entry-method>EMV_DIP</emv-entry-method>
<key-serial-number>text</key-serial-number>
"<?xml version="1.0"?>
<object>
<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>
<card>text</card>
<cash-back-amount>text</cash-back-amount>
<ebt-additional-amounts>
<account-type>text</account-type>
<amount>text</amount>
<amount-type>text</amount-type>
</ebt-additional-amounts>
<emv>
<application-id>A0000000041010</application-id>
<application-name>Visa Debit</application-name>
<application-transaction-counter>text</application-transaction-counter>
<iad>text</iad>
<terminal-verification-results>0400088000</terminal-verification-results>
<transaction-certificate>text</transaction-certificate>
<transaction-status-information>E800</transaction-status-information>
</emv>
<level3>TRUE</level3>
<partial-approved>false</partial-approved>
<partial-authorization>false</partial-authorization>
<serverId>text</serverId>
<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>
<voucher-approval-code>text</voucher-approval-code>
<voucher-serial-number>text</voucher-serial-number>
<amount>text</amount>
<authorization-code>AE12368</authorization-code>
<avs-result-code>X</avs-result-code>
<avs-result-code-description>All digits match (9-digit Zip Code)</avs-result-code-description>
<avs-street>Example Street</avs-street>
<avs-zip>85284</avs-zip>
<base-amount>text</base-amount>
<batch-string-id>000101</batch-string-id>
<billing-is-shipping>true</billing-is-shipping>
<card-type>VISA</card-type>
<check-field-duplicate>false</check-field-duplicate>
<client-ip>127.0.0.1</client-ip>
<comments>These are my comments</comments>
<contactless>false</contactless>
<contactless-device>false</contactless-device>
<created>8/10/2017 12:12:12:00 UTC</created>
<csc>999</csc>
<csc-result-code>X</csc-result-code>
<csc-result-code-description>Service provider did not respond</csc-result-code-description>
<customer-first-name>John</customer-first-name>
<customer-id>1234Customer</customer-id>
<customer-last-name>Doe</customer-last-name>
<cvm>NON</cvm>
<description>transaction description</description>
<display-message>Transaction Approved</display-message>
<email-address>[email protected]</email-address>
<emv-data>0099daje93993903</emv-data>
<emv-data-response>text</emv-data-response>
<emv-entry-method>EMV_DIP</emv-entry-method>
<entry-method>EMV_DIP</entry-method>
<exp-date>1232</exp-date>
<first-recurring-transaction>false</first-recurring-transaction>
<id>123456</id>
<invoice>Test56</invoice>
<key-serial-number>0099daje93993903</key-serial-number>
<last-four>text</last-four>
<merchant-id>text</merchant-id>
<order-id>order99</order-id>
<original-amount>12.00</original-amount>
<pending>false</pending>
<plan-name>Plan 56</plan-name>
<platform-fees>
<fee-name>DealManager</fee-name>
</platform-fees>
<purchase-order>purcahseOrder88</purchase-order>
<ref-id>568972</ref-id>
<result>APPROVED</result>
<result-code>000</result-code>
<sales-tax-amount>6.00</sales-tax-amount>
<sales-tax-type>text</sales-tax-type>
<service-fee>text</service-fee>
<settled>false</settled>
<signature-base-64-image>text</signature-base-64-image>
<software-type>MySoftware_Version1.3</software-type>
<status>approved</status>
<surcharge-applied>false</surcharge-applied>
<terminal-id>text</terminal-id>
<tip-adjusted>false</tip-adjusted>
<tip-adjusted-amount>1.00</tip-adjusted-amount>
<tip-amount>0.20</tip-amount>
<type>SALE</type>
<voided>false</voided>
<voided-auth>false</voided-auth>
<token-description>text</token-description>
</object>
Was this helpful?