search
GithubHelp CenterStatus pageBecome a Partner

Mobile Transactions

Mobile Gateway Controller

hashtag
Authorization Transaction

post

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.

Header parameters
api-keyanyRequired

apiKeyValue

mobilejwtanyRequired

mobileJwtValue

Body
add-tax-to-amountbooleanOptional

This field controls sales-tax-amount with respect to the total amount used for authorization and capture

authorization-codestringOptional

Required for Forced Sale. The authorization code of the transactions obtained from another source

Example: AC789U
billing-is-shippingstringOptional

True if shipping address matches billing address

Example: false
cardstringOptional

card number

Example: 4111111111111111
card-inquirybooleanOptional
check-field-midbooleanOptional

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

Example: true
client-ipstringOptional

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

Example: 127.0.0.1
commentsstringOptional

Additional comments about the transaction

Example: Paint the canoe red
cscstringOptional

csc/cvv is the 3 or 4 digit number on the back of the card

Example: 999
customer-idstringOptional

Customer Identifier of the transaction

Example: Customer 1234
descriptionstringOptional

Description of the transaction

Example: Transaction desc
email-addressstringOptional

email address to associate to the transaction

Example: [email protected]
email-receiptstringOptional

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

Example: false
invoicestringOptional

VarChar value up to 100 characters.

Example: invoice123
order-idstringOptional

Order Id

Example: 99988d
purchase-orderstringOptional

VarChar value up to 100 characters.

Example: PO789
sales-tax-amountstringOptional

Optional 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.

Example: 90.00
sales-tax-typestring · enumOptional

Optional for Capture and Sale transactions, required to qualify with Level II

Example: LOCAL_SALES_TAXPossible values:
secure3dstringOptional

Optional; encrypted CAVV data for 3DS

secure3d-ecistringOptional

Optional; 3DS Electronic Commerce Indicator

service-feestringOptional

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)

Example: 2.90
software-typestringOptional

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

Example: MySoftware_Version1.3
tip-amountstringOptional

optional on a SALE. Requires 2 decimal places.

Example: 0.90
typestring · enumRequired

Type of transaction you would like to run

Example: SALEPossible values:
amountstringRequired

amount of transaction

Example: 80.00
signature-base-64-imagestringOptional

Provide a signature as a base 64 image and we will save it for you to retrieve later (from the signature endpoint).

idstringOptional

unique id returned for auth,sale,forced sale, or refund

software-type-versionstringOptional

Helps with troubleshooting if you have issues or problems

create-tokenstringOptional

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

Example: false
token-descriptionstringOptional

Required if create-token is true. Description of the token (ie savings acct

check-fieldstringOptional

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

Example: invoice
Responses
chevron-right
200

Successful Transaction

payloadTypestringOptional
post
/rest/v2/mobile/transactions/auth

hashtag
Forced Sale Transaction

post

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.

Header parameters
api-keyanyRequired

apiKeyValue

mobilejwtanyRequired

mobileJwtValue

Body
add-tax-to-amountbooleanOptional

This field controls sales-tax-amount with respect to the total amount used for authorization and capture

authorization-codestringOptional

Required for Forced Sale. The authorization code of the transactions obtained from another source

Example: AC789U
billing-is-shippingstringOptional

True if shipping address matches billing address

Example: false
cardstringOptional

card number

Example: 4111111111111111
card-inquirybooleanOptional
check-field-midbooleanOptional

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

Example: true
client-ipstringOptional

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

Example: 127.0.0.1
commentsstringOptional

Additional comments about the transaction

Example: Paint the canoe red
cscstringOptional

csc/cvv is the 3 or 4 digit number on the back of the card

Example: 999
customer-idstringOptional

Customer Identifier of the transaction

Example: Customer 1234
descriptionstringOptional

Description of the transaction

Example: Transaction desc
email-addressstringOptional

email address to associate to the transaction

Example: [email protected]
email-receiptstringOptional

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

Example: false
invoicestringOptional

VarChar value up to 100 characters.

Example: invoice123
order-idstringOptional

Order Id

Example: 99988d
purchase-orderstringOptional

VarChar value up to 100 characters.

Example: PO789
sales-tax-amountstringOptional

Optional 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.

Example: 90.00
sales-tax-typestring · enumOptional

Optional for Capture and Sale transactions, required to qualify with Level II

Example: LOCAL_SALES_TAXPossible values:
secure3dstringOptional

Optional; encrypted CAVV data for 3DS

secure3d-ecistringOptional

Optional; 3DS Electronic Commerce Indicator

service-feestringOptional

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)

Example: 2.90
software-typestringOptional

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

Example: MySoftware_Version1.3
tip-amountstringOptional

optional on a SALE. Requires 2 decimal places.

Example: 0.90
typestring · enumRequired

Type of transaction you would like to run

Example: SALEPossible values:
amountstringRequired

amount of transaction

Example: 80.00
signature-base-64-imagestringOptional

Provide a signature as a base 64 image and we will save it for you to retrieve later (from the signature endpoint).

idstringOptional

unique id returned for auth,sale,forced sale, or refund

software-type-versionstringOptional

Helps with troubleshooting if you have issues or problems

create-tokenstringOptional

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

Example: false
token-descriptionstringOptional

Required if create-token is true. Description of the token (ie savings acct

check-fieldstringOptional

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

Example: invoice
Responses
chevron-right
200

Successful Transaction

payloadTypestringOptional
post
/rest/v2/mobile/transactions/forced-sale

hashtag
Refund Transaction

post

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.

Header parameters
api-keyanyRequired

apiKeyValue

mobilejwtanyRequired

mobileJwtValue

Body
add-tax-to-amountbooleanOptional

This field controls sales-tax-amount with respect to the total amount used for authorization and capture

authorization-codestringOptional

Required for Forced Sale. The authorization code of the transactions obtained from another source

Example: AC789U
billing-is-shippingstringOptional

True if shipping address matches billing address

Example: false
cardstringOptional

card number

Example: 4111111111111111
card-inquirybooleanOptional
check-field-midbooleanOptional

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

Example: true
client-ipstringOptional

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

Example: 127.0.0.1
commentsstringOptional

Additional comments about the transaction

Example: Paint the canoe red
cscstringOptional

csc/cvv is the 3 or 4 digit number on the back of the card

Example: 999
customer-idstringOptional

Customer Identifier of the transaction

Example: Customer 1234
descriptionstringOptional

Description of the transaction

Example: Transaction desc
email-addressstringOptional

email address to associate to the transaction

Example: [email protected]
email-receiptstringOptional

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

Example: false
invoicestringOptional

VarChar value up to 100 characters.

Example: invoice123
order-idstringOptional

Order Id

Example: 99988d
purchase-orderstringOptional

VarChar value up to 100 characters.

Example: PO789
sales-tax-amountstringOptional

Optional 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.

Example: 90.00
sales-tax-typestring · enumOptional

Optional for Capture and Sale transactions, required to qualify with Level II

Example: LOCAL_SALES_TAXPossible values:
secure3dstringOptional

Optional; encrypted CAVV data for 3DS

secure3d-ecistringOptional

Optional; 3DS Electronic Commerce Indicator

service-feestringOptional

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)

Example: 2.90
software-typestringOptional

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

Example: MySoftware_Version1.3
tip-amountstringOptional

optional on a SALE. Requires 2 decimal places.

Example: 0.90
typestring · enumRequired

Type of transaction you would like to run

Example: SALEPossible values:
amountstringRequired

amount of transaction

Example: 80.00
signature-base-64-imagestringOptional

Provide a signature as a base 64 image and we will save it for you to retrieve later (from the signature endpoint).

idstringOptional

unique id returned for auth,sale,forced sale, or refund

software-type-versionstringOptional

Helps with troubleshooting if you have issues or problems

create-tokenstringOptional

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

Example: false
token-descriptionstringOptional

Required if create-token is true. Description of the token (ie savings acct

check-fieldstringOptional

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

Example: invoice
Responses
chevron-right
200

Successful Transaction

payloadTypestringOptional
post
/rest/v2/mobile/transactions/refund

hashtag
Sale Transaction

post

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.

Header parameters
api-keyanyRequired

apiKeyValue

mobilejwtanyRequired

mobileJwtValue

Body
add-tax-to-amountbooleanOptional

This field controls sales-tax-amount with respect to the total amount used for authorization and capture

authorization-codestringOptional

Required for Forced Sale. The authorization code of the transactions obtained from another source

Example: AC789U
billing-is-shippingstringOptional

True if shipping address matches billing address

Example: false
cardstringOptional

card number

Example: 4111111111111111
card-inquirybooleanOptional
check-field-midbooleanOptional

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

Example: true
client-ipstringOptional

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

Example: 127.0.0.1
commentsstringOptional

Additional comments about the transaction

Example: Paint the canoe red
cscstringOptional

csc/cvv is the 3 or 4 digit number on the back of the card

Example: 999
customer-idstringOptional

Customer Identifier of the transaction

Example: Customer 1234
descriptionstringOptional

Description of the transaction

Example: Transaction desc
email-addressstringOptional

email address to associate to the transaction

Example: [email protected]
email-receiptstringOptional

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

Example: false
invoicestringOptional

VarChar value up to 100 characters.

Example: invoice123
order-idstringOptional

Order Id

Example: 99988d
purchase-orderstringOptional

VarChar value up to 100 characters.

Example: PO789
sales-tax-amountstringOptional

Optional 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.

Example: 90.00
sales-tax-typestring · enumOptional

Optional for Capture and Sale transactions, required to qualify with Level II

Example: LOCAL_SALES_TAXPossible values:
secure3dstringOptional

Optional; encrypted CAVV data for 3DS

secure3d-ecistringOptional

Optional; 3DS Electronic Commerce Indicator

service-feestringOptional

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)

Example: 2.90
software-typestringOptional

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

Example: MySoftware_Version1.3
tip-amountstringOptional

optional on a SALE. Requires 2 decimal places.

Example: 0.90
typestring · enumRequired

Type of transaction you would like to run

Example: SALEPossible values:
amountstringRequired

amount of transaction

Example: 80.00
signature-base-64-imagestringOptional

Provide a signature as a base 64 image and we will save it for you to retrieve later (from the signature endpoint).

idstringOptional

unique id returned for auth,sale,forced sale, or refund

software-type-versionstringOptional

Helps with troubleshooting if you have issues or problems

create-tokenstringOptional

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

Example: false
token-descriptionstringOptional

Required if create-token is true. Description of the token (ie savings acct

check-fieldstringOptional

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

Example: invoice
Responses
chevron-right
200

Successful Transaction

add-tax-to-amountbooleanOptional

False if sales tax amount was not added to the passed in amount

cardstringOptional

Masked Card data from the request

cash-back-amountstringOptional

Optional field to signify cash back amount when using EBT cash benefits

create-tokenbooleanOptional
digital-wallet-typestringOptional

Optional field to indicate Google or Apple pay

Example: GOOGLE
external-transaction-referencestringOptional
funding-referencestringOptional
issuer_idstringOptional

Issuer id for payments such as ideal

Example: 10
motobooleanOptional
network-transaction-referencestringOptional
original-processing-party-referencestringOptional
partial-approvedbooleanOptional

Given when partial authorization has been approved

partial-authorizationbooleanOptional

pass in if you would like to check partial authorization.

processing-party-referencestringOptional
secure3d-ecistringOptional

Optional; 3DS Electronic Commerce Indicator

secure3d-result-codestringOptional
serverIdstringOptional
token-idstringOptional
voucher-approval-codestringOptional

Field required when using EBT electronic voucher

voucher-serial-numberstringOptional

Field required when using EBT electronic voucher

amountstringOptional

Amount of transaction

authorization-codestringOptional

Authorization code from card brands

Example: AE12368
avs-result-codestring · enumOptional

Result Code For AVS Match

Example: XPossible values:
avs-result-code-descriptionstringOptional

Description for AVS match

Example: All digits match (9-digit Zip Code)
avs-streetstringOptional

Billing Address Street

Example: Example Street
avs-zipstringOptional

Billing address Zip

Example: 85284
base-amountstringOptional

When there is no 'service-fee', then this is the same as 'original-amount'. When there is a 'service-fee', then this is the 'original-amount' minus the 'service-fee' applied

batch-string-idstringOptional

String value of the batch ID left padded with zeros

Example: 000101
billing-is-shippingstringOptional

true if shipping address matches billing address

Example: true
card-typestringOptional

Type Of card

Example: VISA
check-field-duplicatebooleanOptional

When you send a 'check-field' in the request and a duplicate transaction is found this will return true.

client-ipstringOptional

IP address passed in during transaction

Example: 127.0.0.1
commentsstringOptional

Comments passed in as part of the transaction

Example: These are my comments
contactlessstringOptional

True if was contactless transaction

Example: false
contactless-devicestringOptional

true if contactless transaction from a device

Example: false
createdstringOptional

Date in UTC the transaction was initiated.

Example: 8/10/2017 12:12:12:00 UTC
cscstringOptional

CSC

Example: 999
csc-result-codestring · enumOptional

Result Code For CSC Match

Example: XPossible values:
csc-result-code-descriptionstringOptional

Description for CSC match

Example: Service provider did not respond
currencystringOptional

Currency of transaction

customer-first-namestringOptional

First Name of Customer

Example: John
customer-idstringOptional

customer id passed in with the transaction

Example: 1234Customer
customer-last-namestringOptional

Last Name of Customer

Example: Doe
cvmstring · enumOptional

card verification method determined by EMV Terminal

Example: NONPossible values:
descriptionstringOptional

Description passed in as part of the transaction

Example: transaction description
display-messagestringOptional

Displayable message about transaction result

Example: Transaction Approved
email-addressstringOptional

email address passed in with the transaction

Example: [email protected]
emv-datastringOptional

EMV Data Passed from the terminal

Example: 0099daje93993903
emv-data-responsestringOptional

EMV response data from issuer

emv-entry-methodstring · enumOptional

Entry method of the card in the EMV Terminal

Example: EMV_DIPPossible values:
entry-methodstringOptional

Method Used to enter transaction, Swipe/Manual.

Example: EMV_DIP
exp-datestringOptional

MMYY

Example: 1232
first-recurring-transactionstringOptional

true if it is the first recurring transaction on a plan

Example: false
idstringOptional

Id of the transactions (Important for searching)

Example: 123456
invoicestringOptional

Invoice number passed in as part of the transaction

Example: Test56
key-serial-numberstringOptional

serial number of encrypted device

Example: 0099daje93993903
last-fourstringOptional

Last four digits of credit card

merchant-idstringOptional

Merchant Id of the transaction

order-idstringOptional

Order id passed in with the transaction

Example: order99
original-amountstringOptional

Original amount of transaction prior to any modification

Example: 12.00
pendingstringOptional

True auth has not been captured

Example: false
plan-namestringOptional

Name of plan transaction was ran under

Example: Plan 56
purchase-orderstringOptional

purchase order passed in with the transaction

Example: purcahseOrder88
ref-idstringOptional

Reference ID of a related transaction (Example on a return refId is the orginal sale/capture)

Example: 568972
resultstring · enumOptional

Result of the transaction

Example: APPROVEDPossible values:
result-codestringOptional

Result code associated with transaction result

Example: 000
sales-tax-amountstringOptional

Amount of sales tax

Example: 6.00
sales-tax-typestringOptional

Type of sales Tax

service-feestringOptional

Service fee applied to the transaction

settledstringOptional

True if batch was settled.

Example: false
signature-base-64-imagestringOptional

Signature from EMV device

software-typestringOptional

Static field referencing the software name you are building

Example: MySoftware_Version1.3
statusstringOptional

status

Example: approved
surcharge-appliedbooleanOptional

When you send a 'surcharge' in the request and the system determines it will be used we will return true.

terminal-idstringOptional

Terminal Id of the transaction

tip-adjustedstringOptional

True if tip was adjusted

Example: false
tip-adjusted-amountstringOptional

amount of the new tip after a tip adjust

Example: 1.00
tip-amountstringOptional

Amount of tip for the transaction

Example: 0.20
total-amountstringOptional

Total amount of transaction

typestring · enumOptional

transaction type

Example: SALEPossible values:
voidedstringOptional

True if transaction was voided

Example: false
voided-authstringOptional

True if auth was voided

Example: false
token-descriptionstringOptional

Description of the token passed into the request (ie savings acct

post
/rest/v2/mobile/transactions/sale

Last updated

Was this helpful?