Transactions
Transaction Controller
Transactions will only be available in the Quest system for up to 90 days. Valid formats for the ‘start-date’ and ‘end-date’ fields include the following: MM-dd-yyyy hh:mm a, MM-dd-yy HH:mm, MM-dd-yy HH:mm z, yyyy-MM-dd HH:mm, yyyy-MM-dd HH:mm z
Level of transaction search. Default is terminal level. Set to 'merchant' to query all terminals for this merchant.
ID of the transaction. This can be used to do follow-up transactions (void, refund, capture, etc.)
Amount of the transactions
type of transaction
status of the transaction (APPROVED, DECLINED, etc)
last four digits of card number submitted
authorization code from issuer
invoice number if one was included in the request
order ID if one was included in the request
result message (i.e. "transaction approved")
filters the transactions list by the created date/time. Setting start date will return transactions that were processed after this date/time. Setting both start and end date creates a range
use with start date to create range
page number
page-size
list results in descending order, default is true
api-key-value
Success
No Content
Something is wrong with your request
Unauthorized
Business Exception (decline, etc.)
Internal server error
GET //rest/v2/transactions HTTP/1.1
Host: gateway-sb.clearent.net
Accept: */*
{
"payloadType": "text",
"transaction": {
"action": {
"client-key": "text",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"environment": "text",
"locale": "text",
"method": "text",
"payment-method-type": "text",
"qr-code-data": "text",
"sub-type": "text",
"type": "text",
"url": "text"
},
"add-tax-to-amount": false,
"additional-amounts": [
{
"account-type": "text",
"amount": "text",
"amount-type": "text"
}
],
"billing": {
"city": "St Louis",
"company": "Test Company",
"country": "United States",
"first-name": "John",
"from-zip": "85284",
"last-name": "Doe",
"phone": "3148889999",
"state": "MO",
"street": "123 Example Street",
"street2": "Suite 700",
"zip": "85284"
},
"card": "text",
"create-token": true,
"digital-wallet-type": "GOOGLE",
"emv": {
"application-id": "A0000000041010",
"application-name": "Visa Debit",
"application-transaction-counter": "text",
"iad": "text",
"terminal-verification-results": "0400088000",
"transaction-certificate": "text",
"transaction-status-information": "E800"
},
"external-transaction-reference": "text",
"funding-reference": "text",
"issuer_id": "10",
"level3": "TRUE",
"moto": true,
"network-transaction-reference": "text",
"original-processing-party-reference": "text",
"partial-approved": false,
"partial-authorization": false,
"processing-party-reference": "text",
"secure3d-eci": "text",
"secure3d-result-code": "text",
"serverId": "text",
"shipping": {
"city": "St Louis",
"company": "Test Company",
"country": "United States",
"first-name": "John",
"from-zip": "85284",
"last-name": "Doe",
"phone": "3148889999",
"state": "MO",
"street": "123 Example Street",
"street2": "Suite 700",
"zip": "85284"
},
"token-id": "text",
"amount": "text",
"authorization-code": "AE12368",
"avs-result-code": "X",
"avs-result-code-description": "All digits match (9-digit Zip Code)",
"avs-street": "Example Street",
"avs-zip": "85284",
"base-amount": "text",
"batch-string-id": "000101",
"billing-is-shipping": "true",
"card-type": "VISA",
"check-field-duplicate": false,
"client-ip": "127.0.0.1",
"comments": "These are my comments",
"contactless": "false",
"contactless-device": "false",
"created": "8/10/2017 12:12:12:00 UTC",
"csc": "999",
"csc-result-code": "X",
"csc-result-code-description": "Service provider did not respond",
"currency": "text",
"customer-first-name": "John",
"customer-id": "1234Customer",
"customer-last-name": "Doe",
"cvm": "NON",
"description": "transaction description",
"display-message": "Transaction Approved",
"email-address": "[email protected]",
"emv-data": "0099daje93993903",
"emv-data-response": "text",
"emv-entry-method": "EMV_DIP",
"entry-method": "EMV_DIP",
"exp-date": "1232",
"first-recurring-transaction": "false",
"id": "123456",
"invoice": "Test56",
"key-serial-number": "0099daje93993903",
"last-four": "text",
"merchant-id": "text",
"order-id": "order99",
"original-amount": "12.00",
"pending": "false",
"plan-name": "Plan 56",
"platform-fees": [
{
"fee-name": "DealManager"
}
],
"purchase-order": "purcahseOrder88",
"ref-id": "568972",
"result": "APPROVED",
"result-code": "000",
"sales-tax-amount": "6.00",
"sales-tax-type": "text",
"service-fee": "text",
"settled": "false",
"signature-base-64-image": "text",
"software-type": "MySoftware_Version1.3",
"status": "approved",
"surcharge-applied": false,
"terminal-id": "text",
"tip-adjusted": "false",
"tip-adjusted-amount": "1.00",
"tip-amount": "0.20",
"total-amount": "text",
"type": "SALE",
"voided": "false",
"voided-auth": "false",
"token-description": "text"
}
}Any amount value $1.00 or greater will produce an approval. Any amount value under $1.00 will produce a decline for your testing.
This endpoint used when a merchant wishes to obtain a pre-approval, auth only, or “pre auth”. An auth is later closed with a capture.
Required Fields for Sale: { "type": "AUTH", "exp-date":"for test any future date", "amount": "1.00", "card": "4111111111111111" }
apiKeyValue
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 or credit card token. When merchant-legacy-token flag is true, this is merchant token id, used for identifying the 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 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, 3- or 4- digit number
999Customer Identifier of the transaction
Customer 1234Description of the transaction
Transaction descemail address to associate to the transaction
[email protected]pass 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 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 field to indicate Google or Apple pay
GOOGLEOptional field to identify transaction from Google or Apple pay
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). The service-fee amount will be added to the transaction amount, under certain conditions, with the total used for auth/capture.
2.90Not Required, but will help with troubleshooting if you have issues or problems
MySoftware_Version1.3optional on a SALE/Capture. Requires 2 decimal places. The tip-amount will be added to the transaction amount provided; the total will be used for auth/capture.
0.90Clear Text track data can be passed instead of card
Type of transaction you would like to run
SALEPossible values: 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)
Successful Transaction
Something is wrong with your request
Unauthorized
Business Exception (decline, etc.)
Internal server error
POST //rest/v2/transactions/auth HTTP/1.1
Host: gateway-sb.clearent.net
Content-Type: application/json
Accept: */*
Content-Length: 1716
{
"add-tax-to-amount": false,
"authorization-code": "AC789U",
"billing": {
"city": "St Louis",
"company": "Test Company",
"country": "United States",
"first-name": "John",
"from-zip": "85284",
"last-name": "Doe",
"phone": "3148889999",
"state": "MO",
"street": "123 Example Street",
"street2": "Suite 700",
"zip": "85284"
},
"billing-is-shipping": "false",
"card": "4111111111111111",
"card-inquiry": true,
"check-field-mid": true,
"client-ip": "127.0.0.1",
"comments": "Bad tipper .90 on 80.00 transaction",
"contactless": "false",
"contactless-device": "false",
"csc": "999",
"customer-id": "Customer 1234",
"description": "Transaction desc",
"email-address": "[email protected]",
"email-receipt": "false",
"encrypted-track-data": "text",
"invoice": "invoice123",
"is-amex": false,
"is-sp30": false,
"level3": "TRUE",
"order-id": "99988d",
"partial-authorization": false,
"pin-data": "text",
"platform-fees": [
{
"fee-name": "DealManager"
}
],
"purchase-order": "PO789",
"sales-tax-amount": "90.00",
"sales-tax-type": "LOCAL_SALES_TAX",
"secure3d": "text",
"secure3d-eci": "text",
"secure3d-platform": "GOOGLE",
"secure3d-xid": "text",
"service-fee": "2.90",
"shipping": {
"city": "St Louis",
"company": "Test Company",
"country": "United States",
"first-name": "John",
"from-zip": "85284",
"last-name": "Doe",
"phone": "3148889999",
"state": "MO",
"street": "123 Example Street",
"street2": "Suite 700",
"zip": "85284"
},
"software-type": "MySoftware_Version1.3",
"tip-amount": "0.90",
"track2-data": "text",
"type": "SALE",
"amount": "80.00",
"exp-date": "0932",
"id": "text",
"software-type-version": "text",
"card-type": "VISA",
"create-token": "false",
"merchant-legacy-token": "false",
"token-description": "text",
"track-format": "MAGTEK",
"check-field": "invoice",
"cvm": "NON (None)",
"emv-data": "text",
"emv-entry-method": "EMV_DIP",
"key-serial-number": "text"
}{
"payloadType": "text",
"transaction": {
"action": {
"client-key": "text",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"environment": "text",
"locale": "text",
"method": "text",
"payment-method-type": "text",
"qr-code-data": "text",
"sub-type": "text",
"type": "text",
"url": "text"
},
"add-tax-to-amount": false,
"additional-amounts": [
{
"account-type": "text",
"amount": "text",
"amount-type": "text"
}
],
"billing": {
"city": "St Louis",
"company": "Test Company",
"country": "United States",
"first-name": "John",
"from-zip": "85284",
"last-name": "Doe",
"phone": "3148889999",
"state": "MO",
"street": "123 Example Street",
"street2": "Suite 700",
"zip": "85284"
},
"card": "text",
"create-token": true,
"digital-wallet-type": "GOOGLE",
"emv": {
"application-id": "A0000000041010",
"application-name": "Visa Debit",
"application-transaction-counter": "text",
"iad": "text",
"terminal-verification-results": "0400088000",
"transaction-certificate": "text",
"transaction-status-information": "E800"
},
"external-transaction-reference": "text",
"funding-reference": "text",
"issuer_id": "10",
"level3": "TRUE",
"moto": true,
"network-transaction-reference": "text",
"original-processing-party-reference": "text",
"partial-approved": false,
"partial-authorization": false,
"processing-party-reference": "text",
"secure3d-eci": "text",
"secure3d-result-code": "text",
"serverId": "text",
"shipping": {
"city": "St Louis",
"company": "Test Company",
"country": "United States",
"first-name": "John",
"from-zip": "85284",
"last-name": "Doe",
"phone": "3148889999",
"state": "MO",
"street": "123 Example Street",
"street2": "Suite 700",
"zip": "85284"
},
"token-id": "text",
"amount": "text",
"authorization-code": "AE12368",
"avs-result-code": "X",
"avs-result-code-description": "All digits match (9-digit Zip Code)",
"avs-street": "Example Street",
"avs-zip": "85284",
"base-amount": "text",
"batch-string-id": "000101",
"billing-is-shipping": "true",
"card-type": "VISA",
"check-field-duplicate": false,
"client-ip": "127.0.0.1",
"comments": "These are my comments",
"contactless": "false",
"contactless-device": "false",
"created": "8/10/2017 12:12:12:00 UTC",
"csc": "999",
"csc-result-code": "X",
"csc-result-code-description": "Service provider did not respond",
"currency": "text",
"customer-first-name": "John",
"customer-id": "1234Customer",
"customer-last-name": "Doe",
"cvm": "NON",
"description": "transaction description",
"display-message": "Transaction Approved",
"email-address": "[email protected]",
"emv-data": "0099daje93993903",
"emv-data-response": "text",
"emv-entry-method": "EMV_DIP",
"entry-method": "EMV_DIP",
"exp-date": "1232",
"first-recurring-transaction": "false",
"id": "123456",
"invoice": "Test56",
"key-serial-number": "0099daje93993903",
"last-four": "text",
"merchant-id": "text",
"order-id": "order99",
"original-amount": "12.00",
"pending": "false",
"plan-name": "Plan 56",
"platform-fees": [
{
"fee-name": "DealManager"
}
],
"purchase-order": "purcahseOrder88",
"ref-id": "568972",
"result": "APPROVED",
"result-code": "000",
"sales-tax-amount": "6.00",
"sales-tax-type": "text",
"service-fee": "text",
"settled": "false",
"signature-base-64-image": "text",
"software-type": "MySoftware_Version1.3",
"status": "approved",
"surcharge-applied": false,
"terminal-id": "text",
"tip-adjusted": "false",
"tip-adjusted-amount": "1.00",
"tip-amount": "0.20",
"total-amount": "text",
"type": "SALE",
"voided": "false",
"voided-auth": "false",
"token-description": "text"
}
}Allows merchants to finalize previously authorized transactions. Inside the clearentRequest field, set the required fields, and hit try me. Required Fields for capture: {"type": "capture", "id":"id of transaction to capture", "amount": "1.00"}
apiKeyValue
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 or credit card token. When merchant-legacy-token flag is true, this is merchant token id, used for identifying the 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 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, 3- or 4- digit number
999Customer Identifier of the transaction
Customer 1234Description of the transaction
Transaction descemail address to associate to the transaction
[email protected]pass 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 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 field to indicate Google or Apple pay
GOOGLEOptional field to identify transaction from Google or Apple pay
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). The service-fee amount will be added to the transaction amount, under certain conditions, with the total used for auth/capture.
2.90Not Required, but will help with troubleshooting if you have issues or problems
MySoftware_Version1.3optional on a SALE/Capture. Requires 2 decimal places. The tip-amount will be added to the transaction amount provided; the total will be used for auth/capture.
0.90Clear Text track data can be passed instead of card
Type of transaction you would like to run
SALEPossible values: 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)
Successful Transaction
Something is wrong with your request
Unauthorized
Business Exception (decline, etc.)
Internal server error
POST //rest/v2/transactions/capture HTTP/1.1
Host: gateway-sb.clearent.net
Content-Type: application/json
Accept: */*
Content-Length: 1716
{
"add-tax-to-amount": false,
"authorization-code": "AC789U",
"billing": {
"city": "St Louis",
"company": "Test Company",
"country": "United States",
"first-name": "John",
"from-zip": "85284",
"last-name": "Doe",
"phone": "3148889999",
"state": "MO",
"street": "123 Example Street",
"street2": "Suite 700",
"zip": "85284"
},
"billing-is-shipping": "false",
"card": "4111111111111111",
"card-inquiry": true,
"check-field-mid": true,
"client-ip": "127.0.0.1",
"comments": "Bad tipper .90 on 80.00 transaction",
"contactless": "false",
"contactless-device": "false",
"csc": "999",
"customer-id": "Customer 1234",
"description": "Transaction desc",
"email-address": "[email protected]",
"email-receipt": "false",
"encrypted-track-data": "text",
"invoice": "invoice123",
"is-amex": false,
"is-sp30": false,
"level3": "TRUE",
"order-id": "99988d",
"partial-authorization": false,
"pin-data": "text",
"platform-fees": [
{
"fee-name": "DealManager"
}
],
"purchase-order": "PO789",
"sales-tax-amount": "90.00",
"sales-tax-type": "LOCAL_SALES_TAX",
"secure3d": "text",
"secure3d-eci": "text",
"secure3d-platform": "GOOGLE",
"secure3d-xid": "text",
"service-fee": "2.90",
"shipping": {
"city": "St Louis",
"company": "Test Company",
"country": "United States",
"first-name": "John",
"from-zip": "85284",
"last-name": "Doe",
"phone": "3148889999",
"state": "MO",
"street": "123 Example Street",
"street2": "Suite 700",
"zip": "85284"
},
"software-type": "MySoftware_Version1.3",
"tip-amount": "0.90",
"track2-data": "text",
"type": "SALE",
"amount": "80.00",
"exp-date": "0932",
"id": "text",
"software-type-version": "text",
"card-type": "VISA",
"create-token": "false",
"merchant-legacy-token": "false",
"token-description": "text",
"track-format": "MAGTEK",
"check-field": "invoice",
"cvm": "NON (None)",
"emv-data": "text",
"emv-entry-method": "EMV_DIP",
"key-serial-number": "text"
}{
"payloadType": "text",
"transaction": {
"action": {
"client-key": "text",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"environment": "text",
"locale": "text",
"method": "text",
"payment-method-type": "text",
"qr-code-data": "text",
"sub-type": "text",
"type": "text",
"url": "text"
},
"add-tax-to-amount": false,
"additional-amounts": [
{
"account-type": "text",
"amount": "text",
"amount-type": "text"
}
],
"billing": {
"city": "St Louis",
"company": "Test Company",
"country": "United States",
"first-name": "John",
"from-zip": "85284",
"last-name": "Doe",
"phone": "3148889999",
"state": "MO",
"street": "123 Example Street",
"street2": "Suite 700",
"zip": "85284"
},
"card": "text",
"create-token": true,
"digital-wallet-type": "GOOGLE",
"emv": {
"application-id": "A0000000041010",
"application-name": "Visa Debit",
"application-transaction-counter": "text",
"iad": "text",
"terminal-verification-results": "0400088000",
"transaction-certificate": "text",
"transaction-status-information": "E800"
},
"external-transaction-reference": "text",
"funding-reference": "text",
"issuer_id": "10",
"level3": "TRUE",
"moto": true,
"network-transaction-reference": "text",
"original-processing-party-reference": "text",
"partial-approved": false,
"partial-authorization": false,
"processing-party-reference": "text",
"secure3d-eci": "text",
"secure3d-result-code": "text",
"serverId": "text",
"shipping": {
"city": "St Louis",
"company": "Test Company",
"country": "United States",
"first-name": "John",
"from-zip": "85284",
"last-name": "Doe",
"phone": "3148889999",
"state": "MO",
"street": "123 Example Street",
"street2": "Suite 700",
"zip": "85284"
},
"token-id": "text",
"amount": "text",
"authorization-code": "AE12368",
"avs-result-code": "X",
"avs-result-code-description": "All digits match (9-digit Zip Code)",
"avs-street": "Example Street",
"avs-zip": "85284",
"base-amount": "text",
"batch-string-id": "000101",
"billing-is-shipping": "true",
"card-type": "VISA",
"check-field-duplicate": false,
"client-ip": "127.0.0.1",
"comments": "These are my comments",
"contactless": "false",
"contactless-device": "false",
"created": "8/10/2017 12:12:12:00 UTC",
"csc": "999",
"csc-result-code": "X",
"csc-result-code-description": "Service provider did not respond",
"currency": "text",
"customer-first-name": "John",
"customer-id": "1234Customer",
"customer-last-name": "Doe",
"cvm": "NON",
"description": "transaction description",
"display-message": "Transaction Approved",
"email-address": "[email protected]",
"emv-data": "0099daje93993903",
"emv-data-response": "text",
"emv-entry-method": "EMV_DIP",
"entry-method": "EMV_DIP",
"exp-date": "1232",
"first-recurring-transaction": "false",
"id": "123456",
"invoice": "Test56",
"key-serial-number": "0099daje93993903",
"last-four": "text",
"merchant-id": "text",
"order-id": "order99",
"original-amount": "12.00",
"pending": "false",
"plan-name": "Plan 56",
"platform-fees": [
{
"fee-name": "DealManager"
}
],
"purchase-order": "purcahseOrder88",
"ref-id": "568972",
"result": "APPROVED",
"result-code": "000",
"sales-tax-amount": "6.00",
"sales-tax-type": "text",
"service-fee": "text",
"settled": "false",
"signature-base-64-image": "text",
"software-type": "MySoftware_Version1.3",
"status": "approved",
"surcharge-applied": false,
"terminal-id": "text",
"tip-adjusted": "false",
"tip-adjusted-amount": "1.00",
"tip-amount": "0.20",
"total-amount": "text",
"type": "SALE",
"voided": "false",
"voided-auth": "false",
"token-description": "text"
}
}All values must be above $1.00. Working with any amount under $1.00 will result in a decline during testing. A Forced Sale is a transaction initiated by the merchant with the intent to force the posting of the transaction. This occurs without receiving prior authorization from the issuer or when a “voice approval” is obtained. A Forced Sale does not require a matching authorization. Required fields for Forced Sale: {"type": "FORCED SALE", "exp-date": "for test any future date", "amount": "1.00", "card": "4111111111111111"}
apiKeyValue
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 or credit card token. When merchant-legacy-token flag is true, this is merchant token id, used for identifying the 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 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, 3- or 4- digit number
999Customer Identifier of the transaction
Customer 1234Description of the transaction
Transaction descemail address to associate to the transaction
[email protected]pass 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 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 field to indicate Google or Apple pay
GOOGLEOptional field to identify transaction from Google or Apple pay
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). The service-fee amount will be added to the transaction amount, under certain conditions, with the total used for auth/capture.
2.90Not Required, but will help with troubleshooting if you have issues or problems
MySoftware_Version1.3optional on a SALE/Capture. Requires 2 decimal places. The tip-amount will be added to the transaction amount provided; the total will be used for auth/capture.
0.90Clear Text track data can be passed instead of card
Type of transaction you would like to run
SALEPossible values: 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)
Successful Transaction
Something is wrong with your request
Unauthorized
Business Exception (decline, etc.)
Internal server error
POST //rest/v2/transactions/forced-sale HTTP/1.1
Host: gateway-sb.clearent.net
Content-Type: application/json
Accept: */*
Content-Length: 1716
{
"add-tax-to-amount": false,
"authorization-code": "AC789U",
"billing": {
"city": "St Louis",
"company": "Test Company",
"country": "United States",
"first-name": "John",
"from-zip": "85284",
"last-name": "Doe",
"phone": "3148889999",
"state": "MO",
"street": "123 Example Street",
"street2": "Suite 700",
"zip": "85284"
},
"billing-is-shipping": "false",
"card": "4111111111111111",
"card-inquiry": true,
"check-field-mid": true,
"client-ip": "127.0.0.1",
"comments": "Bad tipper .90 on 80.00 transaction",
"contactless": "false",
"contactless-device": "false",
"csc": "999",
"customer-id": "Customer 1234",
"description": "Transaction desc",
"email-address": "[email protected]",
"email-receipt": "false",
"encrypted-track-data": "text",
"invoice": "invoice123",
"is-amex": false,
"is-sp30": false,
"level3": "TRUE",
"order-id": "99988d",
"partial-authorization": false,
"pin-data": "text",
"platform-fees": [
{
"fee-name": "DealManager"
}
],
"purchase-order": "PO789",
"sales-tax-amount": "90.00",
"sales-tax-type": "LOCAL_SALES_TAX",
"secure3d": "text",
"secure3d-eci": "text",
"secure3d-platform": "GOOGLE",
"secure3d-xid": "text",
"service-fee": "2.90",
"shipping": {
"city": "St Louis",
"company": "Test Company",
"country": "United States",
"first-name": "John",
"from-zip": "85284",
"last-name": "Doe",
"phone": "3148889999",
"state": "MO",
"street": "123 Example Street",
"street2": "Suite 700",
"zip": "85284"
},
"software-type": "MySoftware_Version1.3",
"tip-amount": "0.90",
"track2-data": "text",
"type": "SALE",
"amount": "80.00",
"exp-date": "0932",
"id": "text",
"software-type-version": "text",
"card-type": "VISA",
"create-token": "false",
"merchant-legacy-token": "false",
"token-description": "text",
"track-format": "MAGTEK",
"check-field": "invoice",
"cvm": "NON (None)",
"emv-data": "text",
"emv-entry-method": "EMV_DIP",
"key-serial-number": "text"
}{
"payloadType": "text",
"transaction": {
"action": {
"client-key": "text",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"environment": "text",
"locale": "text",
"method": "text",
"payment-method-type": "text",
"qr-code-data": "text",
"sub-type": "text",
"type": "text",
"url": "text"
},
"add-tax-to-amount": false,
"additional-amounts": [
{
"account-type": "text",
"amount": "text",
"amount-type": "text"
}
],
"billing": {
"city": "St Louis",
"company": "Test Company",
"country": "United States",
"first-name": "John",
"from-zip": "85284",
"last-name": "Doe",
"phone": "3148889999",
"state": "MO",
"street": "123 Example Street",
"street2": "Suite 700",
"zip": "85284"
},
"card": "text",
"create-token": true,
"digital-wallet-type": "GOOGLE",
"emv": {
"application-id": "A0000000041010",
"application-name": "Visa Debit",
"application-transaction-counter": "text",
"iad": "text",
"terminal-verification-results": "0400088000",
"transaction-certificate": "text",
"transaction-status-information": "E800"
},
"external-transaction-reference": "text",
"funding-reference": "text",
"issuer_id": "10",
"level3": "TRUE",
"moto": true,
"network-transaction-reference": "text",
"original-processing-party-reference": "text",
"partial-approved": false,
"partial-authorization": false,
"processing-party-reference": "text",
"secure3d-eci": "text",
"secure3d-result-code": "text",
"serverId": "text",
"shipping": {
"city": "St Louis",
"company": "Test Company",
"country": "United States",
"first-name": "John",
"from-zip": "85284",
"last-name": "Doe",
"phone": "3148889999",
"state": "MO",
"street": "123 Example Street",
"street2": "Suite 700",
"zip": "85284"
},
"token-id": "text",
"amount": "text",
"authorization-code": "AE12368",
"avs-result-code": "X",
"avs-result-code-description": "All digits match (9-digit Zip Code)",
"avs-street": "Example Street",
"avs-zip": "85284",
"base-amount": "text",
"batch-string-id": "000101",
"billing-is-shipping": "true",
"card-type": "VISA",
"check-field-duplicate": false,
"client-ip": "127.0.0.1",
"comments": "These are my comments",
"contactless": "false",
"contactless-device": "false",
"created": "8/10/2017 12:12:12:00 UTC",
"csc": "999",
"csc-result-code": "X",
"csc-result-code-description": "Service provider did not respond",
"currency": "text",
"customer-first-name": "John",
"customer-id": "1234Customer",
"customer-last-name": "Doe",
"cvm": "NON",
"description": "transaction description",
"display-message": "Transaction Approved",
"email-address": "[email protected]",
"emv-data": "0099daje93993903",
"emv-data-response": "text",
"emv-entry-method": "EMV_DIP",
"entry-method": "EMV_DIP",
"exp-date": "1232",
"first-recurring-transaction": "false",
"id": "123456",
"invoice": "Test56",
"key-serial-number": "0099daje93993903",
"last-four": "text",
"merchant-id": "text",
"order-id": "order99",
"original-amount": "12.00",
"pending": "false",
"plan-name": "Plan 56",
"platform-fees": [
{
"fee-name": "DealManager"
}
],
"purchase-order": "purcahseOrder88",
"ref-id": "568972",
"result": "APPROVED",
"result-code": "000",
"sales-tax-amount": "6.00",
"sales-tax-type": "text",
"service-fee": "text",
"settled": "false",
"signature-base-64-image": "text",
"software-type": "MySoftware_Version1.3",
"status": "approved",
"surcharge-applied": false,
"terminal-id": "text",
"tip-adjusted": "false",
"tip-adjusted-amount": "1.00",
"tip-amount": "0.20",
"total-amount": "text",
"type": "SALE",
"voided": "false",
"voided-auth": "false",
"token-description": "text"
}
}All values above $1.00. Will working anything under $1.00 will produce a decline for your testing. Allows merchant to refund a previously settled transaction and submit the refund for processing. Refunds are only allowed for financial transactios (sale and capture) and are typically limited to the original authorization amount, or a lesser amounr in some cases. There are 2 ways to perform refund. A matched refund you send in the id of the transaction and the amount to refund. While in an unmatched refund you send in the card number. In the match scenario, it will only refund up to the total amount of the previous transaction. Inside the clearentRequest field, set the required fields, and hit try me.Required Fields for refund: Matched Refund: {"type": "refund", "id":"id of transaction to refund", "amount": "1.00"} - Unmatched Refund:{"type": "REFUND", "exp-date":"for test any future date", "amount": "1.00", "card": "4111111111111111"}
apiKeyValue
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 or credit card token. When merchant-legacy-token flag is true, this is merchant token id, used for identifying the 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 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, 3- or 4- digit number
999Customer Identifier of the transaction
Customer 1234Description of the transaction
Transaction descemail address to associate to the transaction
[email protected]pass 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 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 field to indicate Google or Apple pay
GOOGLEOptional field to identify transaction from Google or Apple pay
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). The service-fee amount will be added to the transaction amount, under certain conditions, with the total used for auth/capture.
2.90Not Required, but will help with troubleshooting if you have issues or problems
MySoftware_Version1.3optional on a SALE/Capture. Requires 2 decimal places. The tip-amount will be added to the transaction amount provided; the total will be used for auth/capture.
0.90Clear Text track data can be passed instead of card
Type of transaction you would like to run
SALEPossible values: 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)
Successful Transaction
Something is wrong with your request
Unauthorized
Business Exception (decline, etc.)
Internal server error
POST //rest/v2/transactions/refund HTTP/1.1
Host: gateway-sb.clearent.net
Content-Type: application/json
Accept: */*
Content-Length: 1716
{
"add-tax-to-amount": false,
"authorization-code": "AC789U",
"billing": {
"city": "St Louis",
"company": "Test Company",
"country": "United States",
"first-name": "John",
"from-zip": "85284",
"last-name": "Doe",
"phone": "3148889999",
"state": "MO",
"street": "123 Example Street",
"street2": "Suite 700",
"zip": "85284"
},
"billing-is-shipping": "false",
"card": "4111111111111111",
"card-inquiry": true,
"check-field-mid": true,
"client-ip": "127.0.0.1",
"comments": "Bad tipper .90 on 80.00 transaction",
"contactless": "false",
"contactless-device": "false",
"csc": "999",
"customer-id": "Customer 1234",
"description": "Transaction desc",
"email-address": "[email protected]",
"email-receipt": "false",
"encrypted-track-data": "text",
"invoice": "invoice123",
"is-amex": false,
"is-sp30": false,
"level3": "TRUE",
"order-id": "99988d",
"partial-authorization": false,
"pin-data": "text",
"platform-fees": [
{
"fee-name": "DealManager"
}
],
"purchase-order": "PO789",
"sales-tax-amount": "90.00",
"sales-tax-type": "LOCAL_SALES_TAX",
"secure3d": "text",
"secure3d-eci": "text",
"secure3d-platform": "GOOGLE",
"secure3d-xid": "text",
"service-fee": "2.90",
"shipping": {
"city": "St Louis",
"company": "Test Company",
"country": "United States",
"first-name": "John",
"from-zip": "85284",
"last-name": "Doe",
"phone": "3148889999",
"state": "MO",
"street": "123 Example Street",
"street2": "Suite 700",
"zip": "85284"
},
"software-type": "MySoftware_Version1.3",
"tip-amount": "0.90",
"track2-data": "text",
"type": "SALE",
"amount": "80.00",
"exp-date": "0932",
"id": "text",
"software-type-version": "text",
"card-type": "VISA",
"create-token": "false",
"merchant-legacy-token": "false",
"token-description": "text",
"track-format": "MAGTEK",
"check-field": "invoice",
"cvm": "NON (None)",
"emv-data": "text",
"emv-entry-method": "EMV_DIP",
"key-serial-number": "text"
}{
"payloadType": "text",
"transaction": {
"action": {
"client-key": "text",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"environment": "text",
"locale": "text",
"method": "text",
"payment-method-type": "text",
"qr-code-data": "text",
"sub-type": "text",
"type": "text",
"url": "text"
},
"add-tax-to-amount": false,
"additional-amounts": [
{
"account-type": "text",
"amount": "text",
"amount-type": "text"
}
],
"billing": {
"city": "St Louis",
"company": "Test Company",
"country": "United States",
"first-name": "John",
"from-zip": "85284",
"last-name": "Doe",
"phone": "3148889999",
"state": "MO",
"street": "123 Example Street",
"street2": "Suite 700",
"zip": "85284"
},
"card": "text",
"create-token": true,
"digital-wallet-type": "GOOGLE",
"emv": {
"application-id": "A0000000041010",
"application-name": "Visa Debit",
"application-transaction-counter": "text",
"iad": "text",
"terminal-verification-results": "0400088000",
"transaction-certificate": "text",
"transaction-status-information": "E800"
},
"external-transaction-reference": "text",
"funding-reference": "text",
"issuer_id": "10",
"level3": "TRUE",
"moto": true,
"network-transaction-reference": "text",
"original-processing-party-reference": "text",
"partial-approved": false,
"partial-authorization": false,
"processing-party-reference": "text",
"secure3d-eci": "text",
"secure3d-result-code": "text",
"serverId": "text",
"shipping": {
"city": "St Louis",
"company": "Test Company",
"country": "United States",
"first-name": "John",
"from-zip": "85284",
"last-name": "Doe",
"phone": "3148889999",
"state": "MO",
"street": "123 Example Street",
"street2": "Suite 700",
"zip": "85284"
},
"token-id": "text",
"amount": "text",
"authorization-code": "AE12368",
"avs-result-code": "X",
"avs-result-code-description": "All digits match (9-digit Zip Code)",
"avs-street": "Example Street",
"avs-zip": "85284",
"base-amount": "text",
"batch-string-id": "000101",
"billing-is-shipping": "true",
"card-type": "VISA",
"check-field-duplicate": false,
"client-ip": "127.0.0.1",
"comments": "These are my comments",
"contactless": "false",
"contactless-device": "false",
"created": "8/10/2017 12:12:12:00 UTC",
"csc": "999",
"csc-result-code": "X",
"csc-result-code-description": "Service provider did not respond",
"currency": "text",
"customer-first-name": "John",
"customer-id": "1234Customer",
"customer-last-name": "Doe",
"cvm": "NON",
"description": "transaction description",
"display-message": "Transaction Approved",
"email-address": "[email protected]",
"emv-data": "0099daje93993903",
"emv-data-response": "text",
"emv-entry-method": "EMV_DIP",
"entry-method": "EMV_DIP",
"exp-date": "1232",
"first-recurring-transaction": "false",
"id": "123456",
"invoice": "Test56",
"key-serial-number": "0099daje93993903",
"last-four": "text",
"merchant-id": "text",
"order-id": "order99",
"original-amount": "12.00",
"pending": "false",
"plan-name": "Plan 56",
"platform-fees": [
{
"fee-name": "DealManager"
}
],
"purchase-order": "purcahseOrder88",
"ref-id": "568972",
"result": "APPROVED",
"result-code": "000",
"sales-tax-amount": "6.00",
"sales-tax-type": "text",
"service-fee": "text",
"settled": "false",
"signature-base-64-image": "text",
"software-type": "MySoftware_Version1.3",
"status": "approved",
"surcharge-applied": false,
"terminal-id": "text",
"tip-adjusted": "false",
"tip-adjusted-amount": "1.00",
"tip-amount": "0.20",
"total-amount": "text",
"type": "SALE",
"voided": "false",
"voided-auth": "false",
"token-description": "text"
}
}All values above $1.00. Will working 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. Required Fields for Sale: The type of transactions. va {"type": "SALE", "exp-date":"for test any future date", "amount": "1.00", "card": "4111111111111111"}
api key provided
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 or credit card token. When merchant-legacy-token flag is true, this is merchant token id, used for identifying the 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 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, 3- or 4- digit number
999Customer Identifier of the transaction
Customer 1234Description of the transaction
Transaction descemail address to associate to the transaction
[email protected]pass 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 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 field to indicate Google or Apple pay
GOOGLEOptional field to identify transaction from Google or Apple pay
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). The service-fee amount will be added to the transaction amount, under certain conditions, with the total used for auth/capture.
2.90Not Required, but will help with troubleshooting if you have issues or problems
MySoftware_Version1.3optional on a SALE/Capture. Requires 2 decimal places. The tip-amount will be added to the transaction amount provided; the total will be used for auth/capture.
0.90Clear Text track data can be passed instead of card
Type of transaction you would like to run
SALEPossible values: 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)
Successful Transaction
Something is wrong with your request
Unauthorized
Business Exception (decline, etc.)
Internal server error
POST //rest/v2/transactions/sale HTTP/1.1
Host: gateway-sb.clearent.net
Content-Type: application/json
Accept: */*
Content-Length: 1716
{
"add-tax-to-amount": false,
"authorization-code": "AC789U",
"billing": {
"city": "St Louis",
"company": "Test Company",
"country": "United States",
"first-name": "John",
"from-zip": "85284",
"last-name": "Doe",
"phone": "3148889999",
"state": "MO",
"street": "123 Example Street",
"street2": "Suite 700",
"zip": "85284"
},
"billing-is-shipping": "false",
"card": "4111111111111111",
"card-inquiry": true,
"check-field-mid": true,
"client-ip": "127.0.0.1",
"comments": "Bad tipper .90 on 80.00 transaction",
"contactless": "false",
"contactless-device": "false",
"csc": "999",
"customer-id": "Customer 1234",
"description": "Transaction desc",
"email-address": "[email protected]",
"email-receipt": "false",
"encrypted-track-data": "text",
"invoice": "invoice123",
"is-amex": false,
"is-sp30": false,
"level3": "TRUE",
"order-id": "99988d",
"partial-authorization": false,
"pin-data": "text",
"platform-fees": [
{
"fee-name": "DealManager"
}
],
"purchase-order": "PO789",
"sales-tax-amount": "90.00",
"sales-tax-type": "LOCAL_SALES_TAX",
"secure3d": "text",
"secure3d-eci": "text",
"secure3d-platform": "GOOGLE",
"secure3d-xid": "text",
"service-fee": "2.90",
"shipping": {
"city": "St Louis",
"company": "Test Company",
"country": "United States",
"first-name": "John",
"from-zip": "85284",
"last-name": "Doe",
"phone": "3148889999",
"state": "MO",
"street": "123 Example Street",
"street2": "Suite 700",
"zip": "85284"
},
"software-type": "MySoftware_Version1.3",
"tip-amount": "0.90",
"track2-data": "text",
"type": "SALE",
"amount": "80.00",
"exp-date": "0932",
"id": "text",
"software-type-version": "text",
"card-type": "VISA",
"create-token": "false",
"merchant-legacy-token": "false",
"token-description": "text",
"track-format": "MAGTEK",
"check-field": "invoice",
"cvm": "NON (None)",
"emv-data": "text",
"emv-entry-method": "EMV_DIP",
"key-serial-number": "text"
}{
"payloadType": "text",
"transaction": {
"action": {
"client-key": "text",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"environment": "text",
"locale": "text",
"method": "text",
"payment-method-type": "text",
"qr-code-data": "text",
"sub-type": "text",
"type": "text",
"url": "text"
},
"add-tax-to-amount": false,
"additional-amounts": [
{
"account-type": "text",
"amount": "text",
"amount-type": "text"
}
],
"billing": {
"city": "St Louis",
"company": "Test Company",
"country": "United States",
"first-name": "John",
"from-zip": "85284",
"last-name": "Doe",
"phone": "3148889999",
"state": "MO",
"street": "123 Example Street",
"street2": "Suite 700",
"zip": "85284"
},
"card": "text",
"create-token": true,
"digital-wallet-type": "GOOGLE",
"emv": {
"application-id": "A0000000041010",
"application-name": "Visa Debit",
"application-transaction-counter": "text",
"iad": "text",
"terminal-verification-results": "0400088000",
"transaction-certificate": "text",
"transaction-status-information": "E800"
},
"external-transaction-reference": "text",
"funding-reference": "text",
"issuer_id": "10",
"level3": "TRUE",
"moto": true,
"network-transaction-reference": "text",
"original-processing-party-reference": "text",
"partial-approved": false,
"partial-authorization": false,
"processing-party-reference": "text",
"secure3d-eci": "text",
"secure3d-result-code": "text",
"serverId": "text",
"shipping": {
"city": "St Louis",
"company": "Test Company",
"country": "United States",
"first-name": "John",
"from-zip": "85284",
"last-name": "Doe",
"phone": "3148889999",
"state": "MO",
"street": "123 Example Street",
"street2": "Suite 700",
"zip": "85284"
},
"token-id": "text",
"amount": "text",
"authorization-code": "AE12368",
"avs-result-code": "X",
"avs-result-code-description": "All digits match (9-digit Zip Code)",
"avs-street": "Example Street",
"avs-zip": "85284",
"base-amount": "text",
"batch-string-id": "000101",
"billing-is-shipping": "true",
"card-type": "VISA",
"check-field-duplicate": false,
"client-ip": "127.0.0.1",
"comments": "These are my comments",
"contactless": "false",
"contactless-device": "false",
"created": "8/10/2017 12:12:12:00 UTC",
"csc": "999",
"csc-result-code": "X",
"csc-result-code-description": "Service provider did not respond",
"currency": "text",
"customer-first-name": "John",
"customer-id": "1234Customer",
"customer-last-name": "Doe",
"cvm": "NON",
"description": "transaction description",
"display-message": "Transaction Approved",
"email-address": "[email protected]",
"emv-data": "0099daje93993903",
"emv-data-response": "text",
"emv-entry-method": "EMV_DIP",
"entry-method": "EMV_DIP",
"exp-date": "1232",
"first-recurring-transaction": "false",
"id": "123456",
"invoice": "Test56",
"key-serial-number": "0099daje93993903",
"last-four": "text",
"merchant-id": "text",
"order-id": "order99",
"original-amount": "12.00",
"pending": "false",
"plan-name": "Plan 56",
"platform-fees": [
{
"fee-name": "DealManager"
}
],
"purchase-order": "purcahseOrder88",
"ref-id": "568972",
"result": "APPROVED",
"result-code": "000",
"sales-tax-amount": "6.00",
"sales-tax-type": "text",
"service-fee": "text",
"settled": "false",
"signature-base-64-image": "text",
"software-type": "MySoftware_Version1.3",
"status": "approved",
"surcharge-applied": false,
"terminal-id": "text",
"tip-adjusted": "false",
"tip-adjusted-amount": "1.00",
"tip-amount": "0.20",
"total-amount": "text",
"type": "SALE",
"voided": "false",
"voided-auth": "false",
"token-description": "text"
}
}Void transactions can reverse transactions that have been previously authorized or approved by the card issuer and are pending settlement. Merchants can void both authorizations as well as sales. Voiding auths causes reversal. Voiding a Sale or Capture will remove the transaction from the batch and sen reversal to issuer. Transactions in close batches cannot be voided. . Inside the clearentRequest field, set the required fields, and hit try me. Required Fields for Void: {"type": "void", "id":"id of transaction to void"}
apiKeyValue
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 or credit card token. When merchant-legacy-token flag is true, this is merchant token id, used for identifying the 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 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, 3- or 4- digit number
999Customer Identifier of the transaction
Customer 1234Description of the transaction
Transaction descemail address to associate to the transaction
[email protected]pass 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 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 field to indicate Google or Apple pay
GOOGLEOptional field to identify transaction from Google or Apple pay
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). The service-fee amount will be added to the transaction amount, under certain conditions, with the total used for auth/capture.
2.90Not Required, but will help with troubleshooting if you have issues or problems
MySoftware_Version1.3optional on a SALE/Capture. Requires 2 decimal places. The tip-amount will be added to the transaction amount provided; the total will be used for auth/capture.
0.90Clear Text track data can be passed instead of card
Type of transaction you would like to run
SALEPossible values: 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)
Successful Transaction
Something is wrong with your request
Unauthorized
Business Exception (decline, etc.)
Internal server error
POST //rest/v2/transactions/void HTTP/1.1
Host: gateway-sb.clearent.net
Content-Type: application/json
Accept: */*
Content-Length: 1716
{
"add-tax-to-amount": false,
"authorization-code": "AC789U",
"billing": {
"city": "St Louis",
"company": "Test Company",
"country": "United States",
"first-name": "John",
"from-zip": "85284",
"last-name": "Doe",
"phone": "3148889999",
"state": "MO",
"street": "123 Example Street",
"street2": "Suite 700",
"zip": "85284"
},
"billing-is-shipping": "false",
"card": "4111111111111111",
"card-inquiry": true,
"check-field-mid": true,
"client-ip": "127.0.0.1",
"comments": "Bad tipper .90 on 80.00 transaction",
"contactless": "false",
"contactless-device": "false",
"csc": "999",
"customer-id": "Customer 1234",
"description": "Transaction desc",
"email-address": "[email protected]",
"email-receipt": "false",
"encrypted-track-data": "text",
"invoice": "invoice123",
"is-amex": false,
"is-sp30": false,
"level3": "TRUE",
"order-id": "99988d",
"partial-authorization": false,
"pin-data": "text",
"platform-fees": [
{
"fee-name": "DealManager"
}
],
"purchase-order": "PO789",
"sales-tax-amount": "90.00",
"sales-tax-type": "LOCAL_SALES_TAX",
"secure3d": "text",
"secure3d-eci": "text",
"secure3d-platform": "GOOGLE",
"secure3d-xid": "text",
"service-fee": "2.90",
"shipping": {
"city": "St Louis",
"company": "Test Company",
"country": "United States",
"first-name": "John",
"from-zip": "85284",
"last-name": "Doe",
"phone": "3148889999",
"state": "MO",
"street": "123 Example Street",
"street2": "Suite 700",
"zip": "85284"
},
"software-type": "MySoftware_Version1.3",
"tip-amount": "0.90",
"track2-data": "text",
"type": "SALE",
"amount": "80.00",
"exp-date": "0932",
"id": "text",
"software-type-version": "text",
"card-type": "VISA",
"create-token": "false",
"merchant-legacy-token": "false",
"token-description": "text",
"track-format": "MAGTEK",
"check-field": "invoice",
"cvm": "NON (None)",
"emv-data": "text",
"emv-entry-method": "EMV_DIP",
"key-serial-number": "text"
}{
"payloadType": "text",
"transaction": {
"action": {
"client-key": "text",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"environment": "text",
"locale": "text",
"method": "text",
"payment-method-type": "text",
"qr-code-data": "text",
"sub-type": "text",
"type": "text",
"url": "text"
},
"add-tax-to-amount": false,
"additional-amounts": [
{
"account-type": "text",
"amount": "text",
"amount-type": "text"
}
],
"billing": {
"city": "St Louis",
"company": "Test Company",
"country": "United States",
"first-name": "John",
"from-zip": "85284",
"last-name": "Doe",
"phone": "3148889999",
"state": "MO",
"street": "123 Example Street",
"street2": "Suite 700",
"zip": "85284"
},
"card": "text",
"create-token": true,
"digital-wallet-type": "GOOGLE",
"emv": {
"application-id": "A0000000041010",
"application-name": "Visa Debit",
"application-transaction-counter": "text",
"iad": "text",
"terminal-verification-results": "0400088000",
"transaction-certificate": "text",
"transaction-status-information": "E800"
},
"external-transaction-reference": "text",
"funding-reference": "text",
"issuer_id": "10",
"level3": "TRUE",
"moto": true,
"network-transaction-reference": "text",
"original-processing-party-reference": "text",
"partial-approved": false,
"partial-authorization": false,
"processing-party-reference": "text",
"secure3d-eci": "text",
"secure3d-result-code": "text",
"serverId": "text",
"shipping": {
"city": "St Louis",
"company": "Test Company",
"country": "United States",
"first-name": "John",
"from-zip": "85284",
"last-name": "Doe",
"phone": "3148889999",
"state": "MO",
"street": "123 Example Street",
"street2": "Suite 700",
"zip": "85284"
},
"token-id": "text",
"amount": "text",
"authorization-code": "AE12368",
"avs-result-code": "X",
"avs-result-code-description": "All digits match (9-digit Zip Code)",
"avs-street": "Example Street",
"avs-zip": "85284",
"base-amount": "text",
"batch-string-id": "000101",
"billing-is-shipping": "true",
"card-type": "VISA",
"check-field-duplicate": false,
"client-ip": "127.0.0.1",
"comments": "These are my comments",
"contactless": "false",
"contactless-device": "false",
"created": "8/10/2017 12:12:12:00 UTC",
"csc": "999",
"csc-result-code": "X",
"csc-result-code-description": "Service provider did not respond",
"currency": "text",
"customer-first-name": "John",
"customer-id": "1234Customer",
"customer-last-name": "Doe",
"cvm": "NON",
"description": "transaction description",
"display-message": "Transaction Approved",
"email-address": "[email protected]",
"emv-data": "0099daje93993903",
"emv-data-response": "text",
"emv-entry-method": "EMV_DIP",
"entry-method": "EMV_DIP",
"exp-date": "1232",
"first-recurring-transaction": "false",
"id": "123456",
"invoice": "Test56",
"key-serial-number": "0099daje93993903",
"last-four": "text",
"merchant-id": "text",
"order-id": "order99",
"original-amount": "12.00",
"pending": "false",
"plan-name": "Plan 56",
"platform-fees": [
{
"fee-name": "DealManager"
}
],
"purchase-order": "purcahseOrder88",
"ref-id": "568972",
"result": "APPROVED",
"result-code": "000",
"sales-tax-amount": "6.00",
"sales-tax-type": "text",
"service-fee": "text",
"settled": "false",
"signature-base-64-image": "text",
"software-type": "MySoftware_Version1.3",
"status": "approved",
"surcharge-applied": false,
"terminal-id": "text",
"tip-adjusted": "false",
"tip-adjusted-amount": "1.00",
"tip-amount": "0.20",
"total-amount": "text",
"type": "SALE",
"voided": "false",
"voided-auth": "false",
"token-description": "text"
}
}id returned by capture
apiKeyValue
amount of new tip
0.08Successful Transaction
Something is wrong with your request
Unauthorized
Business Exception (decline, etc.)
Internal server error
PUT //rest/v2/transactions/{id} HTTP/1.1
Host: gateway-sb.clearent.net
Content-Type: application/json
Accept: */*
Content-Length: 21
{
"tip-amount": "0.08"
}{
"payloadType": "text",
"transaction": {
"action": {
"client-key": "text",
"data": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"environment": "text",
"locale": "text",
"method": "text",
"payment-method-type": "text",
"qr-code-data": "text",
"sub-type": "text",
"type": "text",
"url": "text"
},
"add-tax-to-amount": false,
"additional-amounts": [
{
"account-type": "text",
"amount": "text",
"amount-type": "text"
}
],
"billing": {
"city": "St Louis",
"company": "Test Company",
"country": "United States",
"first-name": "John",
"from-zip": "85284",
"last-name": "Doe",
"phone": "3148889999",
"state": "MO",
"street": "123 Example Street",
"street2": "Suite 700",
"zip": "85284"
},
"card": "text",
"create-token": true,
"digital-wallet-type": "GOOGLE",
"emv": {
"application-id": "A0000000041010",
"application-name": "Visa Debit",
"application-transaction-counter": "text",
"iad": "text",
"terminal-verification-results": "0400088000",
"transaction-certificate": "text",
"transaction-status-information": "E800"
},
"external-transaction-reference": "text",
"funding-reference": "text",
"issuer_id": "10",
"level3": "TRUE",
"moto": true,
"network-transaction-reference": "text",
"original-processing-party-reference": "text",
"partial-approved": false,
"partial-authorization": false,
"processing-party-reference": "text",
"secure3d-eci": "text",
"secure3d-result-code": "text",
"serverId": "text",
"shipping": {
"city": "St Louis",
"company": "Test Company",
"country": "United States",
"first-name": "John",
"from-zip": "85284",
"last-name": "Doe",
"phone": "3148889999",
"state": "MO",
"street": "123 Example Street",
"street2": "Suite 700",
"zip": "85284"
},
"token-id": "text",
"amount": "text",
"authorization-code": "AE12368",
"avs-result-code": "X",
"avs-result-code-description": "All digits match (9-digit Zip Code)",
"avs-street": "Example Street",
"avs-zip": "85284",
"base-amount": "text",
"batch-string-id": "000101",
"billing-is-shipping": "true",
"card-type": "VISA",
"check-field-duplicate": false,
"client-ip": "127.0.0.1",
"comments": "These are my comments",
"contactless": "false",
"contactless-device": "false",
"created": "8/10/2017 12:12:12:00 UTC",
"csc": "999",
"csc-result-code": "X",
"csc-result-code-description": "Service provider did not respond",
"currency": "text",
"customer-first-name": "John",
"customer-id": "1234Customer",
"customer-last-name": "Doe",
"cvm": "NON",
"description": "transaction description",
"display-message": "Transaction Approved",
"email-address": "[email protected]",
"emv-data": "0099daje93993903",
"emv-data-response": "text",
"emv-entry-method": "EMV_DIP",
"entry-method": "EMV_DIP",
"exp-date": "1232",
"first-recurring-transaction": "false",
"id": "123456",
"invoice": "Test56",
"key-serial-number": "0099daje93993903",
"last-four": "text",
"merchant-id": "text",
"order-id": "order99",
"original-amount": "12.00",
"pending": "false",
"plan-name": "Plan 56",
"platform-fees": [
{
"fee-name": "DealManager"
}
],
"purchase-order": "purcahseOrder88",
"ref-id": "568972",
"result": "APPROVED",
"result-code": "000",
"sales-tax-amount": "6.00",
"sales-tax-type": "text",
"service-fee": "text",
"settled": "false",
"signature-base-64-image": "text",
"software-type": "MySoftware_Version1.3",
"status": "approved",
"surcharge-applied": false,
"terminal-id": "text",
"tip-adjusted": "false",
"tip-adjusted-amount": "1.00",
"tip-amount": "0.20",
"total-amount": "text",
"type": "SALE",
"voided": "false",
"voided-auth": "false",
"token-description": "text"
}
}Was this helpful?