Mobile Transactions
Mobile Gateway Controller
Provide the 'jwt' as a header called 'mobilejwt'. 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.
To perform a token-only request, send a “amount”:“0.00” with “create-token”:“true”.
Example: { "type":"auth", "amount":"0.00", "create-token":"true", "software-type":"AwesomePayments", "software-type-version":"1" } The mobilejwt header is required along with these required fields: amount, software-type, and software-type-version.
apiKeyValue
mobileJwtValue
This field controls sales-tax-amount with respect to the total amount used for authorization and capture
Required for Forced Sale. The authorization code of the transactions obtained from another source
AC789UTrue if shipping address matches billing address
falsecard number
4111111111111111Optional 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 originated (Create for ecommerce apps)
127.0.0.1Additional comments about the transaction
Paint the canoe redcsc/cvv is the 3 or 4 digit number on the back of the card
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.
falseVarChar value up to 100 characters.
invoice123Order Id
99988dVarChar value up to 100 characters.
PO789Optional for Capture and Sale transactions, required to qualify with Level II. Sales tax amount will be added to transaction amount for auth/capture unless the add-tax-to-amount field is used and set to false.
90.00Optional for Capture and Sale transactions, required to qualify with Level II
LOCAL_SALES_TAXPossible values: Optional; encrypted CAVV data for 3DS
Optional; 3DS Electronic Commerce Indicator
Optional on a SALE. 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 issues or problems
MySoftware_Version1.3optional on a SALE. Requires 2 decimal places.
0.90Type of transaction you would like to run
SALEPossible values: amount of transaction
80.00Provide a signature as a base 64 image and we will save it for you to retrieve later (from the signature endpoint).
unique id returned for auth,sale,forced sale, or refund
Helps with troubleshooting if you have issues or problems
Set to true and we will store the card for this transaction. We will return a token representing the card. Save this token and present it to us with future payment transactions for this customer. Optional on an AUTH or SALE
falseRequired if create-token is true. Description of the token (ie savings acct
Optional duplication check for transactions. If you send in a check field we will validate that field is not duplicated for EMV transactions.
invoicePOST //rest/v2/mobile/transactions/auth HTTP/1.1
Host: gateway-sb.clearent.net
Content-Type: application/xml
Accept: */*
Content-Length: 1314
"<?xml version=1.0?>
<add-tax-to-amount>false</add-tax-to-amount>
<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>
<check-field-mid>true</check-field-mid>
<client-ip>127.0.0.1</client-ip>
<comments>Paint the canoe red</comments>
<csc>999</csc>
<customer-id>Customer 1234</customer-id>
<description>Transaction desc</description>
<email-address>[email protected]</email-address>
<email-receipt>false</email-receipt>
<invoice>invoice123</invoice>
<level3>TRUE</level3>
<order-id>99988d</order-id>
<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>
<secure3d>text</secure3d>
<secure3d-eci>text</secure3d-eci>
<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_Version1.3</software-type>
<tip-amount>0.90</tip-amount>
<type>SALE</type>
<amount>80.00</amount>
<signature-base-64-image>text</signature-base-64-image>
<id>text</id>
<software-type-version>text</software-type-version>
<create-token>false</create-token>
<token-description>text</token-description>
<check-field>invoice</check-field>
"<?xml version="1.0"?>
<object>
<payloadType>text</payloadType>
<transaction>
<action>
<client-key>text</client-key>
<data>
<ANY_ADDITIONAL_PROPERTY>text</ANY_ADDITIONAL_PROPERTY>
</data>
<environment>text</environment>
<locale>text</locale>
<method>text</method>
<payment-method-type>text</payment-method-type>
<qr-code-data>text</qr-code-data>
<sub-type>text</sub-type>
<type>text</type>
<url>text</url>
</action>
<add-tax-to-amount>false</add-tax-to-amount>
<additional-amounts>
<account-type>text</account-type>
<amount>text</amount>
<amount-type>text</amount-type>
</additional-amounts>
<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>
<create-token>true</create-token>
<digital-wallet-type>GOOGLE</digital-wallet-type>
<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>
<external-transaction-reference>text</external-transaction-reference>
<funding-reference>text</funding-reference>
<issuer_id>10</issuer_id>
<level3>TRUE</level3>
<moto>true</moto>
<network-transaction-reference>text</network-transaction-reference>
<original-processing-party-reference>text</original-processing-party-reference>
<partial-approved>false</partial-approved>
<partial-authorization>false</partial-authorization>
<processing-party-reference>text</processing-party-reference>
<secure3d-eci>text</secure3d-eci>
<secure3d-result-code>text</secure3d-result-code>
<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>
<token-id>text</token-id>
<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>
<currency>text</currency>
<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>
<total-amount>text</total-amount>
<type>SALE</type>
<voided>false</voided>
<voided-auth>false</voided-auth>
<token-description>text</token-description>
</transaction>
</object>
Provide the 'jwt' as a header called 'mobilejwt'. 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.
A forced sale is a transaction initiated by the merchant with the intent of force a posting of the transaction without receiving prior auth from the issuer; or, when receiving a “voice approval”. Forced sales do not require a matching auth.
The mobilejwt header is required along with these required fields: amount, software-type, and software-type-version.
apiKeyValue
mobileJwtValue
This field controls sales-tax-amount with respect to the total amount used for authorization and capture
Required for Forced Sale. The authorization code of the transactions obtained from another source
AC789UTrue if shipping address matches billing address
falsecard number
4111111111111111Optional 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 originated (Create for ecommerce apps)
127.0.0.1Additional comments about the transaction
Paint the canoe redcsc/cvv is the 3 or 4 digit number on the back of the card
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.
falseVarChar value up to 100 characters.
invoice123Order Id
99988dVarChar value up to 100 characters.
PO789Optional for Capture and Sale transactions, required to qualify with Level II. Sales tax amount will be added to transaction amount for auth/capture unless the add-tax-to-amount field is used and set to false.
90.00Optional for Capture and Sale transactions, required to qualify with Level II
LOCAL_SALES_TAXPossible values: Optional; encrypted CAVV data for 3DS
Optional; 3DS Electronic Commerce Indicator
Optional on a SALE. 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 issues or problems
MySoftware_Version1.3optional on a SALE. Requires 2 decimal places.
0.90Type of transaction you would like to run
SALEPossible values: amount of transaction
80.00Provide a signature as a base 64 image and we will save it for you to retrieve later (from the signature endpoint).
unique id returned for auth,sale,forced sale, or refund
Helps with troubleshooting if you have issues or problems
Set to true and we will store the card for this transaction. We will return a token representing the card. Save this token and present it to us with future payment transactions for this customer. Optional on an AUTH or SALE
falseRequired if create-token is true. Description of the token (ie savings acct
Optional duplication check for transactions. If you send in a check field we will validate that field is not duplicated for EMV transactions.
invoicePOST //rest/v2/mobile/transactions/forced-sale HTTP/1.1
Host: gateway-sb.clearent.net
Content-Type: application/xml
Accept: */*
Content-Length: 1314
"<?xml version=1.0?>
<add-tax-to-amount>false</add-tax-to-amount>
<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>
<check-field-mid>true</check-field-mid>
<client-ip>127.0.0.1</client-ip>
<comments>Paint the canoe red</comments>
<csc>999</csc>
<customer-id>Customer 1234</customer-id>
<description>Transaction desc</description>
<email-address>[email protected]</email-address>
<email-receipt>false</email-receipt>
<invoice>invoice123</invoice>
<level3>TRUE</level3>
<order-id>99988d</order-id>
<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>
<secure3d>text</secure3d>
<secure3d-eci>text</secure3d-eci>
<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_Version1.3</software-type>
<tip-amount>0.90</tip-amount>
<type>SALE</type>
<amount>80.00</amount>
<signature-base-64-image>text</signature-base-64-image>
<id>text</id>
<software-type-version>text</software-type-version>
<create-token>false</create-token>
<token-description>text</token-description>
<check-field>invoice</check-field>
"<?xml version="1.0"?>
<object>
<payloadType>text</payloadType>
<transaction>
<action>
<client-key>text</client-key>
<data>
<ANY_ADDITIONAL_PROPERTY>text</ANY_ADDITIONAL_PROPERTY>
</data>
<environment>text</environment>
<locale>text</locale>
<method>text</method>
<payment-method-type>text</payment-method-type>
<qr-code-data>text</qr-code-data>
<sub-type>text</sub-type>
<type>text</type>
<url>text</url>
</action>
<add-tax-to-amount>false</add-tax-to-amount>
<additional-amounts>
<account-type>text</account-type>
<amount>text</amount>
<amount-type>text</amount-type>
</additional-amounts>
<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>
<create-token>true</create-token>
<digital-wallet-type>GOOGLE</digital-wallet-type>
<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>
<external-transaction-reference>text</external-transaction-reference>
<funding-reference>text</funding-reference>
<issuer_id>10</issuer_id>
<level3>TRUE</level3>
<moto>true</moto>
<network-transaction-reference>text</network-transaction-reference>
<original-processing-party-reference>text</original-processing-party-reference>
<partial-approved>false</partial-approved>
<partial-authorization>false</partial-authorization>
<processing-party-reference>text</processing-party-reference>
<secure3d-eci>text</secure3d-eci>
<secure3d-result-code>text</secure3d-result-code>
<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>
<token-id>text</token-id>
<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>
<currency>text</currency>
<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>
<total-amount>text</total-amount>
<type>SALE</type>
<voided>false</voided>
<voided-auth>false</voided-auth>
<token-description>text</token-description>
</transaction>
</object>
Provide the 'jwt' as a header called 'mobilejwt'. 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.
Refunds are only allowed for financial transactions (Sale and Capture) and are limited to the less than or equal to the original Sale or Capture amount. There are 2 ways to perform refund. A matched refund you send in the id of the transaction and the amount to refund. This api does not support matched refunds (use /rest/v2/transactions). This API supports unmatched refund (while the card is present).
The mobilejwt header is required along with these required fields: amount, software-type, and software-type-version.
apiKeyValue
mobileJwtValue
This field controls sales-tax-amount with respect to the total amount used for authorization and capture
Required for Forced Sale. The authorization code of the transactions obtained from another source
AC789UTrue if shipping address matches billing address
falsecard number
4111111111111111Optional 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 originated (Create for ecommerce apps)
127.0.0.1Additional comments about the transaction
Paint the canoe redcsc/cvv is the 3 or 4 digit number on the back of the card
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.
falseVarChar value up to 100 characters.
invoice123Order Id
99988dVarChar value up to 100 characters.
PO789Optional for Capture and Sale transactions, required to qualify with Level II. Sales tax amount will be added to transaction amount for auth/capture unless the add-tax-to-amount field is used and set to false.
90.00Optional for Capture and Sale transactions, required to qualify with Level II
LOCAL_SALES_TAXPossible values: Optional; encrypted CAVV data for 3DS
Optional; 3DS Electronic Commerce Indicator
Optional on a SALE. 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 issues or problems
MySoftware_Version1.3optional on a SALE. Requires 2 decimal places.
0.90Type of transaction you would like to run
SALEPossible values: amount of transaction
80.00Provide a signature as a base 64 image and we will save it for you to retrieve later (from the signature endpoint).
unique id returned for auth,sale,forced sale, or refund
Helps with troubleshooting if you have issues or problems
Set to true and we will store the card for this transaction. We will return a token representing the card. Save this token and present it to us with future payment transactions for this customer. Optional on an AUTH or SALE
falseRequired if create-token is true. Description of the token (ie savings acct
Optional duplication check for transactions. If you send in a check field we will validate that field is not duplicated for EMV transactions.
invoicePOST //rest/v2/mobile/transactions/refund HTTP/1.1
Host: gateway-sb.clearent.net
Content-Type: application/xml
Accept: */*
Content-Length: 1314
"<?xml version=1.0?>
<add-tax-to-amount>false</add-tax-to-amount>
<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>
<check-field-mid>true</check-field-mid>
<client-ip>127.0.0.1</client-ip>
<comments>Paint the canoe red</comments>
<csc>999</csc>
<customer-id>Customer 1234</customer-id>
<description>Transaction desc</description>
<email-address>[email protected]</email-address>
<email-receipt>false</email-receipt>
<invoice>invoice123</invoice>
<level3>TRUE</level3>
<order-id>99988d</order-id>
<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>
<secure3d>text</secure3d>
<secure3d-eci>text</secure3d-eci>
<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_Version1.3</software-type>
<tip-amount>0.90</tip-amount>
<type>SALE</type>
<amount>80.00</amount>
<signature-base-64-image>text</signature-base-64-image>
<id>text</id>
<software-type-version>text</software-type-version>
<create-token>false</create-token>
<token-description>text</token-description>
<check-field>invoice</check-field>
"<?xml version="1.0"?>
<object>
<payloadType>text</payloadType>
<transaction>
<action>
<client-key>text</client-key>
<data>
<ANY_ADDITIONAL_PROPERTY>text</ANY_ADDITIONAL_PROPERTY>
</data>
<environment>text</environment>
<locale>text</locale>
<method>text</method>
<payment-method-type>text</payment-method-type>
<qr-code-data>text</qr-code-data>
<sub-type>text</sub-type>
<type>text</type>
<url>text</url>
</action>
<add-tax-to-amount>false</add-tax-to-amount>
<additional-amounts>
<account-type>text</account-type>
<amount>text</amount>
<amount-type>text</amount-type>
</additional-amounts>
<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>
<create-token>true</create-token>
<digital-wallet-type>GOOGLE</digital-wallet-type>
<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>
<external-transaction-reference>text</external-transaction-reference>
<funding-reference>text</funding-reference>
<issuer_id>10</issuer_id>
<level3>TRUE</level3>
<moto>true</moto>
<network-transaction-reference>text</network-transaction-reference>
<original-processing-party-reference>text</original-processing-party-reference>
<partial-approved>false</partial-approved>
<partial-authorization>false</partial-authorization>
<processing-party-reference>text</processing-party-reference>
<secure3d-eci>text</secure3d-eci>
<secure3d-result-code>text</secure3d-result-code>
<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>
<token-id>text</token-id>
<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>
<currency>text</currency>
<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>
<total-amount>text</total-amount>
<type>SALE</type>
<voided>false</voided>
<voided-auth>false</voided-auth>
<token-description>text</token-description>
</transaction>
</object>
Provide the 'jwt' as a header called 'mobilejwt'. 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. All values above $1.00 will work. Anything under $1.00 will produce a decline for your testing. Used for the immediate purchase of goods and services . A sale is an Auth and Capture transaction. Once approved it is automatically included in the open batch for settlement. Inside the clearentRequest field, set the required fields, and hit try me. The mobilejwt header is required along with these required Fields: amount, software-type, and software-type-version.
apiKeyValue
mobileJwtValue
This field controls sales-tax-amount with respect to the total amount used for authorization and capture
Required for Forced Sale. The authorization code of the transactions obtained from another source
AC789UTrue if shipping address matches billing address
falsecard number
4111111111111111Optional 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 originated (Create for ecommerce apps)
127.0.0.1Additional comments about the transaction
Paint the canoe redcsc/cvv is the 3 or 4 digit number on the back of the card
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.
falseVarChar value up to 100 characters.
invoice123Order Id
99988dVarChar value up to 100 characters.
PO789Optional for Capture and Sale transactions, required to qualify with Level II. Sales tax amount will be added to transaction amount for auth/capture unless the add-tax-to-amount field is used and set to false.
90.00Optional for Capture and Sale transactions, required to qualify with Level II
LOCAL_SALES_TAXPossible values: Optional; encrypted CAVV data for 3DS
Optional; 3DS Electronic Commerce Indicator
Optional on a SALE. 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 issues or problems
MySoftware_Version1.3optional on a SALE. Requires 2 decimal places.
0.90Type of transaction you would like to run
SALEPossible values: amount of transaction
80.00Provide a signature as a base 64 image and we will save it for you to retrieve later (from the signature endpoint).
unique id returned for auth,sale,forced sale, or refund
Helps with troubleshooting if you have issues or problems
Set to true and we will store the card for this transaction. We will return a token representing the card. Save this token and present it to us with future payment transactions for this customer. Optional on an AUTH or SALE
falseRequired if create-token is true. Description of the token (ie savings acct
Optional duplication check for transactions. If you send in a check field we will validate that field is not duplicated for EMV transactions.
invoicePOST //rest/v2/mobile/transactions/sale HTTP/1.1
Host: gateway-sb.clearent.net
Content-Type: application/xml
Accept: */*
Content-Length: 1314
"<?xml version=1.0?>
<add-tax-to-amount>false</add-tax-to-amount>
<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>
<check-field-mid>true</check-field-mid>
<client-ip>127.0.0.1</client-ip>
<comments>Paint the canoe red</comments>
<csc>999</csc>
<customer-id>Customer 1234</customer-id>
<description>Transaction desc</description>
<email-address>[email protected]</email-address>
<email-receipt>false</email-receipt>
<invoice>invoice123</invoice>
<level3>TRUE</level3>
<order-id>99988d</order-id>
<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>
<secure3d>text</secure3d>
<secure3d-eci>text</secure3d-eci>
<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_Version1.3</software-type>
<tip-amount>0.90</tip-amount>
<type>SALE</type>
<amount>80.00</amount>
<signature-base-64-image>text</signature-base-64-image>
<id>text</id>
<software-type-version>text</software-type-version>
<create-token>false</create-token>
<token-description>text</token-description>
<check-field>invoice</check-field>
"<?xml version="1.0"?>
<object>
<action>
<client-key>text</client-key>
<data>
<ANY_ADDITIONAL_PROPERTY>text</ANY_ADDITIONAL_PROPERTY>
</data>
<environment>text</environment>
<locale>text</locale>
<method>text</method>
<payment-method-type>text</payment-method-type>
<qr-code-data>text</qr-code-data>
<sub-type>text</sub-type>
<type>text</type>
<url>text</url>
</action>
<add-tax-to-amount>false</add-tax-to-amount>
<additional-amounts>
<account-type>text</account-type>
<amount>text</amount>
<amount-type>text</amount-type>
</additional-amounts>
<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>
<create-token>true</create-token>
<digital-wallet-type>GOOGLE</digital-wallet-type>
<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>
<external-transaction-reference>text</external-transaction-reference>
<funding-reference>text</funding-reference>
<issuer_id>10</issuer_id>
<level3>TRUE</level3>
<moto>true</moto>
<network-transaction-reference>text</network-transaction-reference>
<original-processing-party-reference>text</original-processing-party-reference>
<partial-approved>false</partial-approved>
<partial-authorization>false</partial-authorization>
<processing-party-reference>text</processing-party-reference>
<secure3d-eci>text</secure3d-eci>
<secure3d-result-code>text</secure3d-result-code>
<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>
<token-id>text</token-id>
<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>
<currency>text</currency>
<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>
<total-amount>text</total-amount>
<type>SALE</type>
<voided>false</voided>
<voided-auth>false</voided-auth>
<token-description>text</token-description>
</object>
Was this helpful?