Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
The Sola API enables developers to process payments using the Sola gateway. Systems integrating with the Sola API can submit API calls using various commands. The API supports many payment methods, including credit cards, ACH, EBT, and gift cards.
To begin building your API integration, create an account for a Sola sandbox — our secure testing environment that mimics the production environment. After signing up, you’ll be able to create user credentials for the Sola Merchant Portal. Once you log in to the Portal, you’ll be able to generate an API key from the Settings menu. Watch our Key Management video or follow the instructions below to obtain a key.
Sign in to the Sola Merchant Portal.
Select "Account Settings" from the navigation bar.
Select "Keys" from the sub-menu.
Click "Create a Key" in the top-right corner.
It is critical to copy your key and save it in a secure location, as you won’t be able to obtain the key again.
We recommend using iFields in conjunction with the Transaction API for added security. Sola iFields is an iFrames solution that keeps sensitive card data away from merchant servers while granting you complete control over form layout and design. to learn more about iFields.
The Sola iFields solution utilizes iFrames in which the user enters their credit card and/or ACH information and then uses JavaScript to generate SUTs (single-use tokens) for processing. These features allow the website to remain secure and out-of-scope for PCI compliance while allowing the developer to customize the page layout and design fully.
This API has Cross-Origin Resource Sharing (CORS) restrictions in place to enhance security. Requests made directly from a web browser client (e.g., JavaScript running in the browser) will be blocked.
Allowed Origins This API only accepts requests from server-side origins. Ensure that your requests originate from a server to successfully interact with the API.
The endpoint section defines the details for accessing and interacting with the Sola transaction API.
Method: Always use GET for health checks.
Protocol: Secure communication is enforced using https://
Environment: Specifies the targeted environment for the check, such as x1, x2, or b1. The primary environment is x1, with x2 and b1 available as backups.
Domain: The base URL is always cardknox.com
Paths: The endpoint path for health checks is /status
Method: Always use POST for transaction requests.
Protocol: Secure communication is enforced using https://
Environment: The primary environment is x1, with x2 and b1 available as backups.
Domain: The base URL is always cardknox.com
Paths/Formats: Various paths are supported based on data format requirements:
/gatewayform for form data
/gatewayjson for JSON data
/gatewayxml for XML data
The endpoints can be found in the following child pages by navigating to the appropriate page:
Transactions
Can't find what you're looking for? Please contact .
Choose the desired key type (API or iFields), description (software, etc.), and permissions.
Click "Create and View" and copy your key.
cc:adjust
cc:save
cc:avsonly
cc:postauth
cc:credit
cc:refund
cc:voidrefund
cc:voidrelease
cc:void
check:sale
check:credit
check:save
check:void
check:refund
check:voidrefund
ebtfs:sale
ebtfs:credit
ebtfs:balance
ebtfs:voucher
ebtcb:sale
ebtcb:cash
ebtcb:balance
ebtw:sale
ebtw:balance
ebtw:void
gift:issue
gift:redeem
gift:balance
gift:activate
gift:deactivate
fraud:submit
Method
Protocol
Environment
Domain
Path
Example URL
GET
https
x1 (primary) x2 (backup) b1 (backup)
cardknox.com
status
https://x1.cardknox.com/status
Method
Protocol
Environment
Domain
Path
Example URL
POST
https
x1 (primary) x2 (backup) b1 (backup)
cardknox.com
gatewayform gatewayjson gatewayxml
https://x1.cardknox.com/gatewayjson
cc:sale
cc:authonly
cc:capture
Sola’s payment gateway supports Donor-Advised Fund (DAF) cards, enabling secure and compliant charitable transactions through various DAF programs, including DonorsFund, OJC, Pledger, and others. Donors can use their DAF-linked cards to initiate charitable contributions, while organizations integrating with Sola can benefit from automated routing and handling based on card type. This streamlines the donation process while ensuring alignment with each DAF provider’s policies.
xCommand = grant:Recommendation
The Grant:Recommendation API call is used to initiate a grant request from a donor’s DAF account to a specific charitable organization. Once submitted, Sola automatically determines the appropriate DAF provider based on the card used and forwards the grant recommendation accordingly.
xCommand = grant:Void
The Grant:Void API call is used to cancel a previously submitted grant recommendation. This function is essential for handling donor corrections, duplicate submissions, or other administrative scenarios. Upon invocation, the request is routed to the appropriate DAF program to halt the grant in accordance with that provider's cancellation policies.
xSoftwareVersion
Yes
Version number of your software
[xversioncredentials]
x3dsActionCode
Yes
This is retrieved from the 3ds Verify Handler
SUCCESS
xCavv
Yes
This is retrieved from the 3ds Verify Handler
AAIBBYNoEwAAACcKhAJkdQAAAAA=
xEci
Yes
This is retrieved from the 3ds Verify Handler
05
xRefNum
Yes
This is retrieved from the 3ds Verify Handler
10583643601
x3dsAuthenticationStatus
Yes
This is retrieved from the 3ds Verify Handler
Y
x3dsSignatureVerificationStatus
Yes
This is retrieved from the 3ds Verify Handler
Y
Variable
Required
Description
Sample Data
xKey
Yes
Your Cardknox API key
[xkeycredentials]
xVersion
Yes
Gateway API Version. The current version is 5.0.0.
5.0.0
xSoftwareName
Yes
Name of your software
[xsoftwarecredentials]
{
"xResult": "A",
"xStatus": "Approved",
"xError": "",
"xErrorCode": "00000",
"xRefNum": "10583643601",
"xRefNumCurrent": "10583264625",
"xExp": "1234",
"xAuthCode": "75294A",
"xBatch": "5128394",
"xAvsResultCode": "NNN",
"xAvsResult": "Address: No Match & 5 Digit Zip: No Match",
"xCvvResultCode": "M",
"xCvvResult": "Match",
"xAuthAmount": "7.00",
"xMaskedCardNumber": "4xxxxxxxxxxx2503",
"xCardType": "Visa",
"xName": "John Doe",
"xToken": "q712m7h271g035n799pn1605q16757m8",
"xMID": "xxxxxxxxxx9999",
"xTID": "xxxxx6789",
"xCurrency": "USD",
"xDate": "7/11/2025 9:59:11 AM",
"xEntryMethod": "Keyed",
"xEnrolled": "Y",
"xCAVV": "AAIBBYNoEwAAACcKhAJkdQAAAAA=",
"xEciFlag": "05",
"x3DSID": "8ebb5b87-4d74-4b56-a0d0-075c6a37ab85",
"xReviewed": "Y"
}This page contains the API documentation for Fraud Submit transactions, in conjunction with FraudWatch. For more information regarding account access, navigate to the Transaction API parent page.
POST fraud:submit
xCommand = fraud:submit
The Submit command is used in conjunction with a valid FraudWatch account to submit e-commerce transactions for a fraud verification check.
xSoftwareVersion*
String
Version number of your software
xCommand*
String
Sola transaction type
xAmount*
String
The total amount of the transaction, inclusive of tax and tip if applicable. This the total amount of the transaction
xCustom01
String
20 custom fields are available for custom data such as customer comments, etc. Use xCustom01 through xCustom20
xInvoice*
String
The merchant’s invoice number for the transaction. xInvoice is recommended when available for improved duplicate handling
xIP*
String
The customer’s IP address. Typically used for fraud detection
xEmail*
String
The customer’s email address
xBillFirstName*
String
The customer’s first name for their billing profile
xBillLastName*
String
The customer’s last name for their billing profile
xBillStreet*
String
The customer’s street address for their billing profile
xBillCity*
String
The customer’s city for their billing profile
xBillState*
String
The customer’s state for their billing profile
xBillZip*
String
The customer’s zip code for their billing profile
xBillPhone*
String
The customer’s phone number for their billing profile
xShipFirstName*
String
The customer’s first name for their shipping profile
xShipLastName*
String
The customer’s last/family name for their shipping profile
xShipStreet*
String
The customer’s street address for their shipping profile
xShipCity*
String
The customer’s city for their shipping profile
xShipState*
String
The customer’s state for their shipping profile
xShipZip*
String
The customer’s zip code for their shipping profile
xShipPhone*
String
The customer’s phone number for their shipping profile
xGatewayRefNum*
String
Transaction RefNum received from gateway for FraudWatch verification
xGatewayResult*
String
Transaction status received from gateway for FraudWatch verification (Approved/Declined/Error)
xGatewayCVV*
String
CVV for FraudWatch verification
xGatewayAVS*
String
Street address for FraudWatch verification
xOrderType*
String
Specifies if the order origin is internet OR phone for FraudWatch verification
xExistingCustomer*
String
Yes/No value indicating if the customer is a repeat customer
xShipEmail*
String
The ShipTo email address
xOrderID
String
Unique order number for FraudWatch verification
xExistingCustomer
String
Yes/No value indicating if customer is a repeat customer
xAllowDuplicate
String
By default, Sola rejects duplicate transactions within 10 minutes of the original transaction. This command overrides that safeguard. True/False allowed.
xName
String
The cardholder’s name
xTax
String
The tax portion that is included in the total transaction amount (xAmount)
xTip
String
The tip portion that is included in the total transaction amount (xAmount)
xPONum
String
The merchant’s purchase order number for the transaction
xDescription
String
Additional data that is optionally passed along for reporting
xShipMiddleName
String
The customer’s middle name for their shipping profile
xBillMiddleName
String
The customer’s middle name for their billing profile
xBillStreet2
String
The customer’s second line street address for their billing profile
xShipStreet2
String
The customer’s second line street address for their shipping profile
xShipCountry
String
The customer's country code for their shipping profile
xBillCountry
String
The custom's country code for their billing profile
xBillMobile
String
The customer’s mobile phone number for their billing profile
xGatewayError
String
Transaction RefNum received from gateway for FraudWatch verification
xComments
String
Additional data that is optionally passed along to the receipt
xFax
String
The customer’s fax number.
xOrderItems
String
Summary of products ordered
xCustomerComments
String
Comments submitted by customer along with order
xShipMethod
String
The shipping carrier/service used
xShipAmount
String
The total cost of shipping charges
xCardNum*
String
Masked Card number with BIN and last 4 digits exposed
xKey*
String
Your Sola API key.
xVersion*
String
Gateway API version. The current version is 5.0.0.
xSoftwareName*
String
Name of your software
{
"xCardNum": "4444333322221111",
"xKey": "[xkeycredentials]",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "fraud:submit",
"xToken": "61h72mmh68phn9q233634ph3g54p1499m69qhp4816pn528h84",
"xCustom01": "Register01",
"xExp": "12/25",
"xCVV": "945",
"xStreet": "123 Any Street Apt 4b Anytown, NY",
"xZip": "12345",
"xMagstripe": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;4444333322221111=4912101123456789?",
"xName": "John Doe",
"xAuthCode": "T4321A",
"xDUKPT": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;444433",
"xTax": "2.00",
"xTip": "2.00",
"xRefNum": "81234568",
"xInvoice": "123456A",
"xPONum": "123456B",
"xComments": "This is a comment",
"xDescription": "This is a description",
"xIP": "1.2.3.4",
"xEmail": "[email protected]",
"xFax": "1234567890",
"xBillFirstName": "John",
"xBillMiddleName": "Max",
"xBillLastName": "Doe",
"xBillCompany": "Acme",
"xBillStreet": "123 Any Street",
"xBillStreet2": "Apt 4b",
"xBillCity": "Anytown",
"xBillState": "NY",
"xBillZip": "12345",
"xBillCountry": "USA",
"xBillPhone": "8005551212",
"xBillMobile": "8005551111",
"xShipFirstName": "John",
"xShipMiddleName": "Max",
"xShipLastName": "Doe",
"xShipCompany": "Acme",
"xShipStreet": "123 Any Street",
"xShipStreet2": "Apt 4b",
"xShipCity": "Anytown",
"xShipState": "NY",
"xShipZip": "12345",
"xShipCountry": "USA",
"xShipPhone": "8005551212",
"xShipMobile": "8005551111",
"xMICR": "t021000021t 123456789o _2542",
"xRouting": "021202337",
"xGatewayRefNum": "852585258",
"xGatewayResult": "Approved",
"xGatewayError": "845455484",
"xGatewayCVV": "M",
"xGatewayAVS": "YYY",
"xOrderType": "Internet",
"xOrderID": "12356",
"xExistingCustomer": "TRUE",
"xOrderItems": "Sony Digital Camera",
"xCustomerComments": "Please ship as soon as possible",
"xShipMethod": "UPS Ground",
"xShipAmount": "29.99",
"xShipEmail": "[email protected]",
"xAllowDuplicate": "TRUE"
}POST cc:sale
xCommand = cc:Sale
The Sale command is a combination of the authorization and capture transactions. it is intended for use when fulfilling an order right away. For transactions that are not fulfilled right away, use the authonly command initially and then use the capture command to complete the sale.
The card to be charged can be communicated with 4 different approaches: xCardNum + xExp OR xMagstripe OR xToken OR SUT. Only one of these combinations can be used. Depending on the software or website’s security settings, cc:sale may also require xCVV, xStreet, or xZip and their related values.
xExp*
String
The card expiration number. Format: MMYY. For sandbox test transactions, use any date in the future. *xExp is required when sending in xCardnum and cannot be used with xMagstripe.
xKey*
String
Your Sola API key.
xVersion*
String
Gateway API Version. The current version is 5.0.0.
xSoftwareName*
String
Name of your software
For a full list of response codes, see the table in the Introduction page.
POST cc:authonly
xCommand = cc:AuthOnly
The AuthOnly command authorizes an amount on a cardholder’s account and places a hold on the available credit for that amount, but does not submit the charge for settlement. AuthOnly is used to reserve funds from a cardholder’s credit limit for a sale that is not ready to be processed. AuthOnly is commonly used when an order is placed on a website prior to the order being shipped, or when a customer makes a hotel or car rental reservation. If the authorization amount exceeds the cardholder’s available credit, a rejected response will be returned. When successful, the authorization number is returned as RefNum and can be used to reference the authorization for a follow-up transaction. The funds will remain held until the authorization is either captured, voided, or expires. To settle an AuthOnly transaction and complete the sale, use the capture command. If an AuthOnly transaction is captured after 24 hours, it may be subject to a higher processing rate by the acquiring bank.
An AuthOnly hold only reduces the cardholder’s credit limit; it will not appear as a charge on their account. If the authorization will not be converted to a charge, Void Release can be used to release the hold prior to the expiration. The expiration timeframe varies by the issuer, but is typically 7-30 days for credit cards and 3-5 days for debit cards.
xCardNum*
String
The customer card number. *Alternatively, xToken xMagStripe or SUT can be used.
xExp*
String
The card expiration number. Format: MMYY. For sandbox test transactions, use any date in the future. *xExp is required when sending in xCardnum and cannot be used with xMagstripe.
xKey*
String
Your Sola API key.
xVersion*
String
Gateway API version. The current version is 5.0.0
For a full list of response codes, see the table in the Introduction page.
POST cc:capture
xCommand = cc:Capture
The Capture command is used to settle funds from a previous authorization and withdraw the funds from the cardholder’s account. The RefNumber from the associated authorization is required when submitting a Capture request. To perform an authorization and capture in the same command, use the Sale command.
xKey*
String
Your Sola API key.
xVersion*
String
Gateway API Version. The current version is 5.0.0
xSoftwareName*
String
Name of your software
xSoftwareVersion*
String
Version number of your software
For a full list of response codes, see the table in the Introduction page.
POST cc:splitcapture
xCommand = cc:splitcapture
The SplitCapture command is used to capture funds in multiple stages from a single authorization. This is useful for scenarios where the total transaction amount is not settled all at once, such as partial shipments or staged payments. Each SplitCapture request requires the xRefNum of the authorization and allows capturing different amounts up until the authorized amount. See split capture documentation for more information.
xKey*
String
Your Sola API key
xVersion*
String
Gateway API Version. The current version is 5.0.0.
xCommand*
String
Sola transaction type
xSoftwareName*
String
Name of your software
xSoftwareVersion*
String
Version number of your software
POST cc:adjust
xCommand = cc:Adjust
You can use the Adjust command to update certain fields on a transaction, such as xOrderID. This action will not reprocess the transaction; it will only update the information. However, you can only update the xAmount, xTax, and xTip fields on an authorization before it is captured; you cannot change these fields on a transaction that was already processed.
xKey*
String
Your Sola API key
xVersion*
String
Gateway API Version. The current version is 5.0.0
xSoftwareName*
String
Name of your software
xSoftwareVersion*
String
Version number of your software
POST cc:save
xCommand = cc:Save
The Save command is used to send account information and to request a token from Sola. It does not submit the transaction for processing. The response returns a token that references the account information. A token at minimum references the credit card number, but if other data is sent—such as a billing address—it will be associated with the token as well.
AvsOnly
When AvsOnly is enabled for cc:Save, in addition to just generating a token, the transaction will be submitted to the bank for AVS and CVV verification. This setting can be turned on in the Sola backend settings.
xCardNum*
String
The customer card number. *Alternatively, xToken xMagStripe or SUT can be used.
xExp*
String
The card expiration number. Format: MMYY. For sandbox test transactions, use any date in the future. *xExp is required when sending in xCardnum and cannot be used with xMagstripe
xKey*
String
Your Sola API key.
xVersion*
String
Gateway API version. The current version is 5.0.0.
POST cc:avsonly
xCommand = cc:AvsOnly
An AVS Only transaction allows you to verify the accuracy of a customer's billing address without processing the payment. This type of transaction is useful for validating the authenticity of the billing address before completing a purchase. It can also be use to verify the card CVV
To perform an AVS Only transaction, you need to send the customer's billing address details along with the request. The bank will then compare the provided address against the billing address on file with the card issuer and return a response indicating whether the address matches or not.
xKey*
String
Your Sola API key.
xVersion*
String
Gateway API version. The current version is 5.0.0
xSoftwareName*
String
Name of your software
xSoftwareVersion*
String
Version number of your software
POST cc:credit
xCommand = cc:Credit
To issue a credit (refund) through our API without referring to a previous sale, you can use the following command: cc:credit
Please note that our system blocks credits on cards that do not have a prior sale by default. To allow such credits to go through, you must send a request to [email protected].
xCardNum*
String
The customer card number. *Alternatively, xToken xMagStripe or SUT can be used.
xExp*
String
The card expiration number. Format: MMYY. For sandbox test transactions, use any date in the future. *xExp is required when sending in xCardnum and cannot be used with xMagstripe.
xKey*
String
Your Sola API key.
xVersion*
String
Gateway API version. The current version is 5.0.0.
POST cc:refund
xCommand = cc:Refund
The Refund command is used to refund a full or partial amount of a previous transaction using xRefNum. Partial check refunds are only supported for ACHQ.
xKey*
String
Your Sola API key.
xVersion*
String
Gateway API version. The current version is 5.0.0.
xSoftwareName*
String
Name of your software
xSoftwareVersion*
String
Version number of your software
POST cc:voidrefund
xCommand = cc:voidrefund
The VoidRefund command will either void the pending transaction if it has not settled yet, or it will fully refund the transaction if it has already settled.
xKey*
String
Your Sola API key.
xVersion*
String
Gateway API version. The current version is 5.0.0
xSoftwareName*
String
Name of your software
xSoftwareVersion*
String
Version number of your software
POST cc:voidrelease
xCommand = cc:voidrelease
The VoidRelease command releases a pending authorization amount back to the cardholder’s credit limit without waiting for the standard authorization time frame to expire.
xKey*
String
Your Sola API key.
xVersion*
String
Gateway API version. The current version is 5.0.0
xSoftwareName*
String
Name of your software
xSoftwareVersion*
String
Version number of your software
POST cc:void
xCommand = cc:Void
The Void command voids a transaction that has not yet settled using xRefNum.
xKey*
String
Your Sola API key.
xVersion*
String
Gateway API version. The current version is 5.0.0
xSoftwareName*
String
Name of your software
xSoftwareVersion*
String
Version number of your software
{
"xResult":"A",
"xStatus":"Approved",
"xError":"",
"xErrorCode":"00000",
"xRefNum":"601518451",
"xInvoice":"123456",
"xExp":"1030",
"xAuthCode":"11295A",
"xBatch":"11948741",
"xAvsResultCode":"NNN",
"xAvsResult":"Address: No Match & 5 Digit Zip: No Match",
"xCvvResultCode":"M",
"xCvvResult":"Match",
"xAuthAmount":"35.00",
"xMaskedCardNumber":"4xxxxxxxxxxx1111",
"xCardType":"Visa",
"xToken":"8n21126mq0hn253p9m7964p5qn60000g",
"xMID":"xxxxxxxxxx9999",
"xTID":"xxxxx6789",
"xCurrency":"USD",
"xDate":"3/3/2022 7:36:34 AM",
"xEntryMethod":"Keyed",
"xReviewed":"N"
}{
"xResult":"A",
"xStatus":"Approved",
"xError":"",
"xErrorCode":"00000",
"xRefNum":"601519890",
"xInvoice":"123456",
"xExp":"1030",
"xAuthCode":"47436A",
"xAvsResultCode":"NNN",
"xAvsResult":"Address: No Match & 5 Digit Zip: No Match",
"xCvvResultCode":"M",
"xCvvResult":"Match",
"xAuthAmount":"35.00",
"xMaskedCardNumber":"4xxxxxxxxxxx1111",
"xCardType":"Visa",
"xName":"John Doe",
"xToken":"q3nq31h6n8n24623n9qg695hhgh24g61",
"xMID":"xxxxxxxxxx9999",
"xTID":"xxxxx6789",
"xCurrency":"USD",
"xDate":"3/3/2022 7:43:21 AM",
"xIsSplitCapturable":"1",
"xEntryMethod":"Keyed",
"xReviewed":"N"
}{
"xResult":"E",
"xStatus":"Error",
"xError":"Invalid xRefNum",
"xErrorCode":"01463",
"xRefNum":"601523283",
"xInvoice":"123456",
"xDate":"3/3/2022 7:57:59 AM"
}{
"xResult": "A",
"xStatus": "Approved",
"xError": "",
"xErrorCode": "00000",
"xRefNum": "10000016879",
"xInvoice": "1234567",
"xRefNumCurrent": "10000016886",
"xDate": "7/11/2022 4:06:11 PM"
}{
"xResult": "A",
"xStatus": "Approved",
"xError": "",
"xErrorCode": "00000",
"xRefNum": "10000016898",
"xExp": "1030",
"xDate": "7/11/2022 4:15:15 PM",
"xToken": "38gn292893h0nq72m0qn69892q9mg56g",
"xMaskedCardNumber": "4xxxxxxxxxxx1111",
"xCardType": "Visa"
}{
"xResult": "A",
"xStatus": "Approved",
"xError": "",
"xErrorCode": "00000",
"xRefNum": "10000016908",
"xInvoice": "123456",
"xExp": "1030",
"xAuthCode": "78685A",
"xBatch": "14594556",
"xAvsResultCode": "NNN",
"xAvsResult": "Address: No Match & 5 Digit Zip: No Match",
"xCvvResultCode": "M",
"xCvvResult": "Match",
"xAuthAmount": "35.00",
"xMaskedCardNumber": "4xxxxxxxxxxx1111",
"xCardType": "Visa",
"xToken": "n701mmg5qm3969673q92hm0p652h2n9g",
"xMID": "xxxxxxxxxx9999",
"xTID": "xxxxx6789",
"xCurrency": "USD",
"xDate": "7/11/2022 4:21:17 PM",
"xEntryMethod": "Keyed"
}{
"xResult": "A",
"xStatus": "Approved",
"xError": "",
"xErrorCode": "00000",
"xRefNum": "10000016913",
"xInvoice": "123456",
"xExp": "1030",
"xAuthCode": "41174A",
"xBatch": "14594556",
"xAvsResultCode": "NNN",
"xAvsResult": "Address: No Match & 5 Digit Zip: No Match",
"xCvvResultCode": "N",
"xCvvResult": "No Match",
"xAuthAmount": "35.00",
"xMaskedCardNumber": "4xxxxxxxxxxx1111",
"xCardType": "Visa",
"xMID": "xxxxxxxxxx9999",
"xTID": "xxxxx6789",
"xCurrency": "USD",
"xDate": "7/11/2022 4:27:32 PM",
"xEntryMethod": "Unknown"
}
{
"xResult": "A",
"xStatus": "Approved",
"xError": "",
"xErrorCode": "00000",
"xRefNum": "10000016915",
"xInvoice": "123456",
"xRefNumCurrent": "10000016916",
"xExp": "1030",
"xAvsResultCode": "NNN",
"xAvsResult": "Address: No Match & 5 Digit Zip: No Match",
"xCvvResultCode": "N",
"xCvvResult": "No Match",
"xAuthAmount": "35.00",
"xMaskedCardNumber": "4xxxxxxxxxxx1111",
"xCardType": "Visa",
"xToken": "h9n16qg990p99157640h6m823942934p",
"xMID": "xxxxxxxxxx9999",
"xTID": "xxxxx6789",
"xCurrency": "USD",
"xDate": "7/11/2022 4:30:38 PM",
"xEntryMethod": "Unknown"
}{
"xResult": "A",
"xStatus": "Approved",
"xError": "",
"xErrorCode": "00000",
"xRefNum": "10000016917",
"xInvoice": "123456",
"xRefNumCurrent": "10000016919",
"xExp": "1030",
"xAvsResultCode": "NNN",
"xAvsResult": "Address: No Match & 5 Digit Zip: No Match",
"xCvvResultCode": "N",
"xCvvResult": "No Match",
"xAuthAmount": "35.00",
"xMaskedCardNumber": "4xxxxxxxxxxx1111",
"xCardType": "Visa",
"xMID": "xxxxxxxxxx9999",
"xTID": "xxxxx6789",
"xCurrency": "USD",
"xDate": "7/11/2022 4:33:02 PM",
"xEntryMethod": "Unknown"
}
{
"xResult": "A",
"xStatus": "Approved",
"xError": "",
"xErrorCode": "00000",
"xRefNum": "10000016875",
"xInvoice": "123456",
"xRefNumCurrent": "10000016882",
"xExp": "1030",
"xAvsResultCode": "NNN",
"xAvsResult": "Address: No Match & 5 Digit Zip: No Match",
"xCvvResultCode": "N",
"xCvvResult": "No Match",
"xAuthAmount": "35.00",
"xMaskedCardNumber": "4xxxxxxxxxxx1111",
"xCardType": "Visa",
"xMID": "xxxxxxxxxx9999",
"xTID": "xxxxx6789",
"xCurrency": "USD",
"xDate": "7/11/2022 4:03:04 PM",
"xEntryMethod": "Unknown"
}{
"xCardNum": "4444333322221111",
"xExp": "1030",
"xKey": "[xkeycredentials]",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "cc:sale",
"xAmount": "35.00",
"xToken": "61h72mmh68phn9q233634ph3g54p1499m69qhp4816pn528h84",
"xCustom01": "Register01",
"xCVV": "123",
"xStreet": "123 Main Street",
"xZip": "12345",
"xMagstripe": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;4444333322221111=4912101123456789?",
"xName": "John Doe",
"xDUPKT": "Example",
"xDigitalWalletType": "Google Pay",
"xTax": "2.00",
"xTip": "2.00",
"xInvoice": "123456A",
"xPONum": "123456B",
"xComments": "This is a comment",
"xDescription": "This is a description",
"xIP": "1.2.3.4",
"xEmail": "[email protected]",
"xFax": "1234567890",
"xBillFirstName": "John",
"xBillMiddleName": "Max",
"xBillLastName": "Doe",
"xBillCompany": "Acme",
"xBillStreet": "123 Any Street",
"xBillStreet2": "Apt 4b",
"xBillCity": "Anytown",
"xBillState": "NY",
"xBillZip": "12345",
"xBillCountry": "USA",
"xBillPhone": "8005551212",
"xBillMobile": "8005551111",
"xShipFirstName": "John",
"xShipMiddleName": "Max",
"xShipLastName": "Doe",
"xShipCompany": "Acme",
"xShipStreet": "123 Any Street",
"xShipStreet2": "Apt 4b",
"xShipCity": "Anytown",
"xShipState": "NY",
"xShipZip": "11111",
"xShipCountry": "USA",
"xShipPhone": "8005551212",
"xShipMobile": "8005551111",
"x1Description": "Wireless Bluetooth Speaker",
"x1Sku": "12345",
"x1Qty": "5",
"x1UnitPrice": "49.99",
"xHotelCheckInDate": "7/1/2024",
"xHotelCheckOutDate": "7/10/2024",
"xHotelChargeType": "Direct",
"xHotelRoomRate": "159.99",
"xHotelNoShow": "TRUE",
"xAllowPartialAuth": "TRUE",
"xAllowNonAuthenticated": "FALSE",
"xRxAmount": "1.50",
"xDentalAmount": "1.50",
"xVisionAmount": "1.50",
"xTransitAmount": "1.50",
"xCopayAmount": "1.50",
"xClinicalAmount": "1.50",
"xOrderID": "12356",
"xExistingCustomer": "TRUE",
"xAllowDuplicate": "TRUE",
"xCustReceipt": "TRUE",
"xCurrency": "USD",
"xTimeoutSeconds": "10",
"xVendorId": "12345",
"xInstallments": "5"
}{
"xCardNum": "4444333322221111",
"xExp": "1030",
"xKey": "[xkeycredentials]",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "cc:authonly",
"xAmount": "35.00",
"token": "61h72mmh68phn9q233634ph3g54p1499m69qhp4816pn528h84",
"xCustom01": "Register01",
"xCVV": "123",
"xStreet": "123 Main Street",
"xZip": "12345",
"xMagstripe": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;4444333322221111=4912101123456789?",
"xName": "John Doe",
"xDUPKT":
"xTax": "2.00",
"xTip": "2.00",
"xRequireSplitCapturable": "TRUE",
"xInvoice": "123456A",
"xPONum": "123456B",
"xComments": "This is a comment",
"xDescription": "This is a description",
"xIP": "1.2.3.4",
"xEmail": "[email protected]",
"xFax": "1234567890",
"xBillFirstName": "John",
"xBillMiddleName": "Max",
"xBillLastName": "Doe",
"xBillCompany": "Acme",
"xBillStreet": "123 Any Street",
"xBillStreet2": "Apt 4b",
"xBillCity": "Anytown",
"xBillState": "NY",
"xBillZip": "12345",
"xBillCountry": "USA",
"xBillPhone": "8005551212",
"xBillMobile": "8005551111",
"xShipFirstName": "John",
"xShipMiddleName": "Max",
"xShipLastName": "Doe",
"xShipCompany": "Acme",
"xShipStreet": "123 Any Street",
"xShipStreet2": "Apt 4b",
"xShipCity": "Anytown",
"xShipState": "NY",
"xShipZip": "11111",
"xShipCountry": "USA",
"xShipPhone": "8005551212",
"xShipMobile": "8005551111",
"xHotelCheckInDate": "7/1/2024",
"xHotelCheckOutDate": "7/10/2024",
"xAllowPartialAuth": "TRUE",
"xAutoRentalPickupDate": "2020-08-21",
"xAutoRentalPickupTime": "11:15:00",
"xAutoRentalReturnDate": "2020-08-21",
"xAutoRentalReturnTime": "11:15:00",
"xRxAmount": "1.50",
"xDentalAmount": "1.50",
"xVisionAmount": "1.50",
"xTransitAmount": "1.50",
"xCopayAmount": "1.50",
"xClinicalAmount": "1.50",
"xOrderID": "12356",
"xAllowDuplicate": "TRUE",
"xCustReceipt": "TRUE",
"xCurrency": "USD",
"xTimeoutSeconds": "10",
"xIncremental": "TRUE"
}{
"xKey": "[xkeycredentials]",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "cc:capture",
"xAmount": "35.00",
"xCustom01": "Register01",
"xCVV": "123",
"xStreet": "123 Main Street",
"xZip": "12345",
"xRefNum": "81234568",
"xName": "John Doe",
"xTax": "2.00",
"xTip": "2.00",
"xInvoice": "123456A",
"xPONum": "123456B",
"xComments": "This is a comment",
"xDescription": "This is a description",
"xIP": "1.2.3.4",
"xEmail": "[email protected]",
"xFax": "1234567890",
"xBillFirstName": "John",
"xBillMiddleName": "Max",
"xBillLastName": "Doe",
"xBillCompany": "Acme",
"xBillStreet": "123 Any Street",
"xBillStreet2": "Apt 4b",
"xBillCity": "Anytown",
"xBillState": "NY",
"xBillZip": "12345",
"xBillCountry": "USA",
"xBillPhone": "8005551212",
"xBillMobile": "8005551111",
"xShipFirstName": "John",
"xShipMiddleName": "Max",
"xShipLastName": "Doe",
"xShipCompany": "Acme",
"xShipStreet": "123 Any Street",
"xShipStreet2": "Apt 4b",
"xShipCity": "Anytown",
"xShipState": "NY",
"xShipZip": "11111",
"xShipCountry": "USA",
"xShipPhone": "8005551212",
"xShipMobile": "8005551111",
"xAllowDuplicate": "TRUE",
"xCustReceipt": "TRUE"
}{
"xKey": "[xkeycredentials]",
"xVersion": "5.0.0",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "cc:splitcapture",
"xRefNum": "81234568",
"xAmount": "9.99",
"xCustom01": "Register01",
"xStreet": "123 Main Street",
"xZip": "12345",
"xName": "John Doe",
"xTax": ".05",
"xTip": ".05",
"xInvoice": "123456A",
"xPONum": "123456B",
"xComments": "This is a comment",
"xDescription": "This is a description",
"xIP": "1.2.3.4",
"xEmail": "[email protected]",
"xFax": "1234567890",
"xBillFirstName": "John",
"xBillMiddleName": "Max",
"xBillLastName": "Doe",
"xBillCompany": "Acme",
"xBillStreet": "123 Any Street",
"xBillStreet2": "Apt 4b",
"xBillCity": "Anytown",
"xBillState": "NY",
"xBillZip": "12345",
"xBillCountry": "USA",
"xBillPhone": "8005551212",
"xBillMobile": "8005551111",
"xShipFirstName": "John",
"xShipMiddleName": "Max",
"xShipLastName": "Doe",
"xShipCompany": "Acme",
"xShipStreet": "123 Any Street",
"xShipStreet2": "Apt 4b",
"xShipCity": "Anytown",
"xShipState": "NY",
"xShipZip": "11111",
"xShipCountry": "USA",
"xShipPhone": "8005551212",
"xShipMobile": "8005551111",
"xAllowDuplicate": "TRUE",
"xCustReceipt": "TRUE"
}{
"xResult":"A",
"xStatus":"Approved",
"xError":"",
"xErrorCode":"00000",
"xRefNum":"10230508134",
"xInvoice":"123456",
"xExp":"1030",
"xAuthCode":"74119A",
"xBatch":"5128394",
"xAvsResultCode":"NNN",
"xAvsResult":"Address:No Match & 5 Digit Zip: No Match",
"xCvvResultCode":"",
"xCvvResult":"No CVV data available",
"xAuthAmount":"10.00",
"xMaskedCardNumber":"4xxxxxxxxxxx1111",
"xCardType":"Visa",
"xToken":"h0n6m0gn70m99598hp282802h60q2911",
"xMID":"xxxxxxxxxx9999",
"xTID":"xxxxx6789",
"xCurrency":"USD",
"xDate":"1/29/2025 10:58:54 AM",
"xEntryMethod":"Unknown"
}{
"xKey": "[xkeycredentials]",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "cc:adjust",
"xAmount": "35.00",
"xCustom01": "Register01",
"xCustom02": "Register01",
"xCustom03": "Register01",
"xStreet": "123 Main Street",
"xZip": "12345",
"xRefNum": "81234568",
"xName": "John Doe",
"xDescription": "This is a description",
"OrderID": "123456",
"xTip": "1.05",
"xTax": "1.05",
"xSignature": "aGVsbG8gaG93IGFyZSB5b3UK",
"xInvoice": "123456A",
"xIncremental": "TRUE"
}{
"xCardNum": "4444333322221111",
"xExp": "1249",
"xKey": "[xkeycredentials]",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "cc:save",
"xCustom01": "Register01",
"xStreet": "123 Main Street",
"xZip": "12345",
"xMagstripe": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;4444333322221111=4912101123456789?",
"xName": "John Doe",
"xIP": "1.1.1.1"
}{
"xCardNum": "4444333322221111",
"xExp": "1030",
"xKey": "[xkeycredentials]",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "cc:credit",
"xAmount": "35.00",
"token": "61h72mmh68phn9q233634ph3g54p1499m69qhp4816pn528h84",
"xCustom01": "Register01",
"xCVV": "123",
"xStreet": "123 Main Street",
"xZip": "12345",
"xMagstripe": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;4444333322221111=4912101123456789?",
"xName": "John Doe",
"xDUPKT":
"xTax": "2.00",
"xTip": "2.00",
"xInvoice": "123456A",
"xPONum": "123456B",
"xComments": "This is a comment",
"xDescription": "This is a description",
"xIP": "1.2.3.4",
"xEmail": "[email protected]",
"xFax": "1234567890",
"xBillFirstName": "John",
"xBillMiddleName": "Max",
"xBillLastName": "Doe",
"xBillCompany": "Acme",
"xBillStreet": "123 Any Street",
"xBillStreet2": "Apt 4b",
"xBillCity": "Anytown",
"xBillState": "NY",
"xBillZip": "12345",
"xBillCountry": "USA",
"xBillPhone": "8005551212",
"xBillMobile": "8005551111",
"xShipFirstName": "John",
"xShipMiddleName": "Max",
"xShipLastName": "Doe",
"xShipCompany": "Acme",
"xShipStreet": "123 Any Street",
"xShipStreet2": "Apt 4b",
"xShipCity": "Anytown",
"xShipState": "NY",
"xShipZip": "11111",
"xShipCountry": "USA",
"xShipPhone": "8005551212",
"xShipMobile": "8005551111",
"xAllowPartialAuth": "TRUE",
"xRxAmount": "1.50",
"xDentalAmount": "1.50",
"xVisionAmount": "1.50",
"xTransitAmount": "1.50",
"xCopayAmount": "1.50",
"xClinicalAmount": "1.50",
"xOrderID": "12356",
"xExistingCustomer": "TRUE",
"xAllowDuplicate": "TRUE",
"xCustReceipt": "TRUE",
"xCurrency": "USD",
"xTimeoutSeconds": "10"
}{
"xKey": "[xkeycredentials]",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "cc:refund",
"xAmount": "35.00",
"xRefNum": "93827163",
"xDescription": "This is a description",
"xAllowDuplicate": "TRUE",
"xCustReceipt": "FALSE",
"xCurrency": "USD",
"xTimeoutSeconds": "10"
}{
"xKey": "[xkeycredentials]",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "cc:voidrefund",
"xCustom01": "Register01",
"xRefNum": "93827163"
}{
"xKey": "[xkeycredentials]",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "cc:voidrelease",
"xCustom01": "Register01",
"xRefNum": "93827163"
}{
"xKey": "[xkeycredentials]",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "cc:void",
"xCustom01": "Register01",
"xRefNum": "93827163"
}xSoftwareVersion*
String
Version number of your software
xCommand*
String
Sola transaction type
xAmount*
String
The total amount of the transaction, inclusive of tax and tip if applicable.
xCardNum*
String
The customer card number. *Alternatively, xToken xMagStripe or SUT can be used.
xToken
String
The Sola token that references a previously used payment method. When using a token, xCardNum xExp and xMagstripe should not be used.
xCustom01
String
20 custom fields are available for custom data such as customer comments, etc. Use xCustom01 through xCustom20
xCVV
String
3-digit code from the back of the card (for Amex, 4-digit code from the front of the card)
xStreet
String
The billing street address of the cardholder
xZip
String
The billing zip code of the cardholder
xMagstripe
String
The magstripe data of a credit card. Magstripe data includes the card number and expiration date. When using this command, xCardNum xExp and xToken should not be used. Encrypted card data can also be sent using xMagstripe.
xName
String
The cardholder’s name.
xDUKPT
String
The DUK/PT key for PIN debit and EBT transactions.The first 16 characters are the encrypted PIN block, followed by the 6 character long Key Set Identifier (KSID). The remaining characters are the PIN pad serial number and transaction counter.
xTax
String
The tax portion that is included in the total transaction amount (xAmount)
xTip
String
The tip portion that is included in the total transaction amount (xAmount).
xInvoice
String
The merchant’s invoice number for the transaction. xInvoice is recommended when available for improved duplicate handling.
xPONum
String
The merchant’s purchase order number for the transaction
xComments
String
Additional data that is optionally passed along to the receipt.
xDescription
String
Additional data that is optionally passed along for reporting
xIP
String
The customer’s IP address. Typically used for fraud detection.
xEmail*
String
The customer’s email address *Required when 3ds is enabled
xFax
String
The customer’s fax number
xBillFirstName*
String
The customer’s first name for their billing profile *Required when 3ds is enabled
xBillMiddleName
String
The customer’s middle name or initial for their billing profile
xBillLastName*
String
The customer’s last/family name for their billing profile *Required when 3ds is enabled
xBillCompany
String
The customer’s company name for their billing profile
xBillStreet*
String
The customer’s street address for their billing profile *Required when 3ds is enabled
xBillStreet2
String
The customer’s street address 2nd line for their billing profile
xBillCity*
String
The customer’s city for their billing profile. *Required when 3ds is enabled
xBillState*
String
The customer’s state for their billing profile *Required when 3ds is enabled
xBillZip*
String
The customer’s zip code for their billing profile *Required when 3ds is enabled
xBillCountry
String
The customer’s country for their billing profile
xBillPhone
String
The customer’s phone number for their billing profile
xBillMobile*
String
The customer’s mobile number for their billing profile *Required when 3ds is enabled
xShipFirstName
String
The customer’s first name for their shipping profile
xShipMiddleName
String
The customer’s middle name or initial for their shipping profile
xShipLastName
String
The customer’s last/family name for their shipping profile
xShipCompany
String
The customer’s company name for their shipping profile
xShipStreet
String
The customer’s street address for their shipping profile
xShipStreet2
String
The customer’s street address 2nd line for their shipping profile
xShipCity
String
The customer’s city for their shipping profile
xShipState
String
The customer’s state for their shipping profile
xShipZip
String
The customer’s zip code for their shipping profile
xShipCountry
String
The customer’s country for their shipping profile
xShipPhone
String
The customer’s phone number for their shipping profile
xShipMobile
String
The customer’s mobile number for their shipping profile
x1Description
String
Line Item product description. Increment the “1“ for additional items.
x1Sku
String
Line Item product sku. Increment the “1“ for additional items.
x1Qty
String
Line Item product quantity. Increment the “1“ for additional items.
x1UnitPrice
String
Line Item product price. Increment the “1“ for additional items.
xHotelCheckInDate
String
The customer’s date of hotel check-in
xHotelCheckOutDate
String
The customer's date of hotel check-out
xAllowPartialAuth
String
True/false value indicating if an authorization amount is less than the initial request when full initial amount is unavailable. This variable is platform-dependent. Default is false.
xAllowNonAuthenticated
String
True/False value, enabling a customer to complete a purchase without needing to verify their identity through a separate authentication step. Defaults to false.
xRxAmount
String
Specifies qualifying prescription amount for FSA transactions. xAllowPartialAuth must be set to True.
xDentalAmount
String
Specifies qualifying dental amount for FSA transactions. xAllowPartialAuth must be set to True.
xVisionAmount
String
Specifies qualifying vision amount for FSA transactions. xAllowPartialAuth must be set to True.
xTransitAmount
String
Specifies qualifying transit amount for commuter card transactions. xAllowPartialAuth must be set to True.
xCopayAmount
String
Specifies Co-pay amount for FSA transactions. xAllowPartialAuth must be set to True.
xClinicalAmount
String
Specifies qualifying clinical amount for FSA transactions. xAllowPartialAuth must be set to True.
xOrderId
String
Unique order number for FraudWatch verification
xExistingCustomer
String
Yes/No value indicating if customer is a repeat customer
xAllowDuplicate
String
By default, Sola rejects duplicate transactions within 10 minutes of the original transaction. This command overrides that safeguard. True/False allowed.
xCustReceipt
String
True/False value indicating if the email address specified in xemail should receive a receipt containing the transaction details.
xCurrency
String
Used to specify an alternate currency. Only applicable for accounts that are using Multi-Currency Conversion (MCC). For accounts that are natively in a foreign currency, the currency does not need to be specified (see list of all supported currencies).
xReturnPaymentID
Boolean
True/False value indicating if the user would like to receive xPaymentId in the transaction response. Unless specified, the value is “False”. Unlike an xToken which will return a new value on transactions of the same card, xPaymentId will return the same value for transactions using the same card.
xSplitFee
String
The amount that should be sent to the Split Fee account Example: xAmount = 100 xSplitFee = 10 90 Will go to the xKey account and 10 will go to the Split Fee account (Split Fee account is set in the Sola gateway backend) Note: To use this feature, the account needs to be setup to support it. Otherwise, an error will be returned.
xTimeoutSeconds
String
Configurable amount of seconds in which the request will wait for a response.
xVendorId
String
The parameter that tells the gateway which developer is performing the transaction. If the value matches the account of the iFields key, the gateway will allow the transaction to work even though the API and iFields keys are from different accounts. See more here
xDigitalWalletType
String
This field should indicate the wallet type in a case where the card number is a digital wallet token (Ex: "Google Pay")
xRecurringIndicator*
String
Indicates the type of transaction based on its recurrence. This field helps classify whether a transaction is part of a recurring series, an installment plan, a one-time charge, or a deferred payment. *When set, xInstallments is required.
Note: Use of this flag on a transaction does NOT set up a recurring schedule for the transaction. Recurring schedules must be set up separately.
Allowed Values:
Recurring- a transaction that is part of a regularly scheduled series (e.g., subscriptions). Usually initiated by the merchant after the first payment.
Installment- one in a series of transactions where the total amount is divided into multiple payments with a fixed schedule (e.g., 3 monthly payments).
Single- a one-time transaction, not part of a recurring or installment plan.
Deferred- indicates that the transaction authorization was delayed and submitted later due to temporary issues like connectivity problems or offline environments.
*Required for Merchant-initiated transactions
xInstallments
Only when xRecurringIndicator=Installment
Specifies the number of payment installments
xSoftwareName*
String
Name of your software
xSoftwareVersion*
String
Version number of your software
xCommand*
String
Sola transaction type
xAmount*
String
The total amount of the transaction, inclusive of tax and tip if applicable. This the total amount of the transaction.
xToken
String
The Sola token that references a previously used payment method. When using a token, xCardNum xExp and xMagstripe should not be used.
xCustom01
String
20 custom fields are available for custom data such as customer comments, etc. Use xCustom01 through xCustom20.
xCVV
String
3-digit code from the back of the card (4-digit code from the front of the card for Amex)
xStreet
String
The billing street address of the cardholder
xZip
String
The billing zip code of the cardholder
xMagstripe
String
The magstripe data of a credit card. Magstripe data includes the card number and expiration date. When using this command, xCardNum xExp and xToken should not be used. Encrypted card data can also be sent using xMagstripe.
xName
String
The cardholder’s name
xDUKPT
String
The DUK/PT key for PIN debit and EBT transactions.The first 16 characters are the encrypted PIN block, followed by the 6 character long Key Set Identifier (KSID). The remaining characters are the PIN pad serial number and transaction counter.
xTax
String
The tax portion that is included in the total transaction amount (xAmount)
xTip
String
The tip portion that is included in the total transaction amount (xAmount)
xRequireSplitCapturable
String
Indicate if you want to ensure that the authorization will allow split capture. When this is set to true and split capture is not supported, an error will be returned “Split capture not supported“.
xInvoice
String
The merchant’s invoice number for the transaction. xInvoice is recommended when available for improved duplicate handling.
xPONum
String
The merchant’s purchase order number for the transaction
xComments
String
Additional data optionally passed along to the receipt
xDescription
String
Additional data optionally passed along for reporting
xIP
String
The customer’s IP address. Typically used for fraud detection.
xEmail
String
The customer’s email address
xBillLastName
String
The customer’s last/family name for their billing profile
xBillMiddleName
String
The customer’s middle name or initial for their billing profile
xBillFirstName
String
The customer’s first name for their billing profile
xFax
String
The customer’s fax number
xBillCompany
String
The customer’s company name for their billing profile.
xBillStreet
String
The customer’s street address for their billing profile.
xBillStreet2
String
The customer’s street address 2nd line for their billing profile
xBillCity
String
The customer’s city for their billing profile
xBillState
String
The customer’s state for their billing profile
xBillZip
String
The customer’s zip code for their billing profile
xBillCountry
String
The customer’s country for their billing profile
xBillPhone
String
The customer’s phone number for their billing profile
xBillMobile
String
The customer’s mobile number for their billing profile
xShipFirstName
String
The customer’s first name for their shipping profile
xShipMiddleName
String
The customer’s middle name or initial for their shipping profile
xShipLastName
String
The customer’s last/family name for their shipping profile
xShipCountry
String
The customer’s company name for their shipping profile
xShipStreet
String
The customer’s street address for their shipping profile
xShipStreet2
String
The customer’s street address 2nd line for their shipping profile
xShipCity
String
The customer’s city for their shipping profile
xShipState
String
The customer’s state for their shipping profile
xShipZip
String
The customer’s zip code for their shipping profile
xShipCountry
String
The customer’s country for their shipping profile.
xShipPhone
String
The customer’s phone number for their shipping profile
xShipMobile
String
The customer’s mobile number for their shipping profile
xHotelCheckInDate
String
The customer’s date of hotel check-in.
xHotelCheckOutDate
String
The customer’s date of hotel check-out.
xHotelChargeType
String
The charge type for the transaction.
xHotelRoomRate
String
The nightly room rate for the hotel.
xHotelNoShow
String
True/False indicating whether customer was a no-show.
xAllowPartialAuth
String
True/False value indicating if an authorization amount is less than the initial request when the full initial amount is unavailable. This variable is platform-dependent. Default is false.
xAutoRentalPickupDate
String
Specific date for customer to pick up vehicle.
*Note: This field is required only for the auto rental industry.
xAutoRentalPickupTime
String
Specific time for customer to pick up vehicle.
*Note: This field is required only for the auto rental industry.
xAutoRentalReturnDate
String
Specific date for customer to return vehicle.
*Note: This field is required only for the auto rental industry.
xAutoRentalReturnTime
String
Specific time for customer to return vehicle.
*Note: This field is required only for the auto rental industry.
xRxAmount
String
Specifies qualifying prescription amount for FSA transactions. xAllowPartialAuth must be set to True.
xDentalAmount
String
Specifies qualifying dental amount for FSA transactions. xAllowPartialAuth must be set to True.
xVisionAmount
String
Specifies qualifying vision amount for FSA transactions. xAllowPartialAuth must be set to True.
xTransitAmount
String
Specifies qualifying transit amount for commuter card transactions. xAllowPartialAuth must be set to True.
xCopayAmount
String
Specifies Co-pay amount for FSA transactions. xAllowPartialAuth must be set to True.
xClinicalAmount
String
Specifies qualifying clinical amount for FSA transactions. xAllowPartialAuth must be set to True.
xOrderID
String
Unique order number for FraudWatch verification.
xAllowDuplicate
String
By default, Sola rejects duplicate transactions within 10 minutes of the original transaction. This command overrides that safeguard. True/False allowed.
xCustReceipt
String
True/False value indicating if the email address specificied in xemail should receive a receipt containing the transaction details.
xCurrency
String
Used to specify an alternate currency. Only applicable for accounts that are using Multi-Currency Conversion (MCC). For accounts that are natively in a foreign currency, the currency does not need to be specified. (see list of all supported currencies).
xTimeoutSeconds
String
Configurable amount of seconds in which the request will wait for a response.
xRecurringIndicator*
String
Recurring- a transaction that is part of a regularly scheduled series (e.g., subscriptions). Usually initiated by the merchant after the first payment.
Installment- one in a series of transactions where the total amount is divided into multiple payments with a fixed schedule (e.g., 3 monthly payments).
Single- a one-time transaction, not part of a recurring or installment plan.
Deferred- indicates that the transaction authorization was delayed and submitted later due to temporary issues like connectivity problems or offline environments.
*Required for Merchant-initiated transactions
xCommand*
String
Sola transaction type
xRefNum*
String
Used to reference a previous transaction when doing a follow-up transaction, typically a refund, void, or capture. (Note: xRefnum can be a 64-bit number and should be stored as BIGINT, Long, Int64 or String).
xAmount
String
The total amount of the transaction, inclusive of tax and tip if applicable. This the total amount of the transaction.
xCustom01
String
20 custom fields are available for custom data such as customer comments, etc. Use xCustom01 through xCustom20.
xStreet
String
The billing street address of the cardholder.
xZip
String
The billing zip code of the cardholder.
xName
String
The cardholder’s name
xTax
String
The tax portion that is included in the total transaction amount (xAmount)
xTip
String
The tip portion that is included in the total transaction amount (xAmount)
xInvoice
String
The merchant’s invoice number for the transaction. xInvoice is recommended when available for improved duplicate handling.
xPONum
String
The merchant’s purchase order number for the transaction
xComments
String
Additional data optionally passed along to the receipt
xDescription
String
Additional data optionally passed along for reporting
xIP
String
The customer’s IP address. Typically used for fraud detection.
xEmail
String
The customer’s email address
xFax
String
The customer’s fax number
xBillFirstName
String
The customer’s first name for their billing profile
xBillMiddleName
String
The customer’s middle name for their billing profile
xBillLastName
String
The customer’s last name for their billing profile
xBillCompany
String
The customer’s company name for their billing profile
xBillStreet
String
The customer’s street address for their billing profile
xBillStreet2
String
The customer’s street address 2nd line for their billing profile
xBillCity
String
The customer’s city for their billing profile
xBillState
String
The customer’s state for their billing profile
xBillZip
String
The customer’s zip code for their billing profile
xBillCountry
String
The customer’s country for their billing profile
xBillPhone
String
The customer’s phone number for their billing profile
xBillMobile
String
The customer’s mobile number for their billing profile
xShipFirstName
String
The customer’s first name for their shipping profile
xShipMiddleName
String
The customer’s middle name for their shipping profile
xShipLastName
String
The customer’s last name for their shipping profile
xShipCompany
String
The customer’s company name for their shipping profile
xShipStreet
String
The customer’s street address for their shipping profile
xShipStreet2
String
The customer’s street address 2nd line for their shipping profile
xShipCity
String
The customer’s city for their shipping profile
xShipState
String
The customer’s state for their shipping profile
xShipZip
String
The customer’s zip code for their shipping profile
xShipCountry
String
The customer’s country for their shipping profile
xShipPhone
String
The customer’s phone number for their shipping profile
xShipMobile
String
The customer’s mobile number for their shipping profile
xAllowDuplicate
String
By default, Sola rejects duplicate transactions within 10 minutes of the original transaction. This command overrides that safeguard. True/False allowed.
xCustReceipt
String
True/False value indicating if the email address specified in xemail should receive a receipt containing the transaction details.
xRefNum*
String
Used to reference a previous transaction when doing a follow-up transaction, typically a refund, void, or capture. (Note: xRefnum can be a 64-bit number and should be stored as BIGINT, Long, Int64 or String).
xAmount*
String
The portion of the authorized funds to capture in the current SplitCapture request.
xCustom01
String
20 custom fields are available for custom data such as customer comments, etc. Use xCustom01 through xCustom20.
xStreet
String
The billing street address of the cardholder.
xZip
String
The billing zip code of the cardholder.
xName
String
The cardholder’s name
xTax
String
The tax portion that is included in the total transaction amount (xAmount)
xTip
String
The tip portion that is included in the total transaction amount (xAmount)
xInvoice
String
The merchant’s invoice number for the transaction. xInvoice is recommended when available for improved duplicate handling.
xPONum
String
The merchant’s purchase order number for the transaction
xComments
String
Additional data optionally passed along to the receipt
xDescription
String
Additional data optionally passed along for reporting
xIP
String
The customer’s IP address. Typically used for fraud detection.
xEmail
String
The customer’s email address
xFax
String
The customer’s fax number
xBillFirstName
String
The customer’s first name for their billing profile
xBillMiddleName
String
The customer’s middle name or initial for their billing profile
xBillLastName
String
The customer’s last/family name for their billing profile
xBillCompany
String
The customer’s company name for their billing profile
xBillStreet
String
The customer’s street address for their billing profile
xBillStreet2
String
The customer’s street address 2nd line for their billing profile
xBillCity
String
The customer’s city for their billing profile
xBillState
String
The customer’s state for their billing profile
xBillZip
String
The customer’s zip code for their billing profile
xBillCountry
String
The customer’s country for their billing profile
xBillPhone
String
The customer’s phone number for their billing profile
xBillMobile
String
The customer’s mobile number for their billing profile
xShipFirstName
String
The customer’s first name for their shipping profile
xShipMiddleName
String
The customer’s middle name or initial for their shipping profile
xShipLastName
String
The customer’s last/family name for their shipping profile
xShipCompany
String
The customer’s company name for their shipping profile
xShipStreet
String
The customer’s street address for their shipping profile
xShipStreet2
String
The customer’s street address 2nd line for their shipping profile
xShipCity
String
The customer’s city for their shipping profile
xShipState
String
The customer’s state for their shipping profile
xShipZip
String
The customer’s zip code for their shipping profile
xShipCountry
String
The customer’s country for their shipping profile
xShipPhone
String
The customer’s phone number for their shipping profile
xShipMobile
String
The customer’s mobile number for their shipping profile
xAllowDuplicate
String
By default, Sola rejects duplicate transactions within 10 minutes of the original transaction. This command overrides that safeguard. True/False allowed.
xCustReceipt
String
True/False value indicating if the email address specified in xemail should receive a receipt containing the transaction details.
xCommand*
String
Sola transaction type
xAmount*
String
The total amount of the transaction, inclusive of tax and tip if applicable. This the total amount of the transaction.
If xIncremental field is not set to True in cc:AuthOnly, use of xAmount in will result in forced cc:Adjust transaction.
xRefNum*
String
Used to reference a previous transaction when doing a follow-up transaction; typically a refund, void, or capture. (Note: xRefnum can be a 64-bit number and should be stored as BIGINT, Long, Int64 or String).
Custom01
String
Custom fields available for custom data such as customer comments, etc.
Custom02
String
Custom fields available for custom data such as customer comments, etc.
Custom03
String
Custom fields available for custom data such as customer comments, etc.
xStreet
String
The billing street address of the cardholder
xZip
String
The billing zip code of the cardholder
xName
String
The cardholder’s name
xDescription
String
Additional data optionally passed along for reporting
xOrderID
String
Unique Order Number for FraudWatch verification
xTip
String
The tip portion that is included in the total transaction amount (xAmount)
xTax
String
The tax portion that is included in the total transaction amount (xAmount)
xSignature
String
The Base 64 encoded customer signature
xInvoice
String
The merchant’s invoice number for the transaction. xInvoice is recommended when available for improved duplicate handling
xIncremental
String
Incremental authorizations enable increase the authorized amount on a captured transaction.
True/False value. Must be set to True in order for xAmount to be used in cc:Adjust, otherwise cc:Adjust will be a forced transaction.
xSoftwareName*
String
Name of your software
xCommand*
String
Sola transaction type
xSoftwareVersion*
String
Version number of your software
xCustom01
String
20 custom fields are available for custom data, such as customer comments, etc. Use xCustom01 through xCustom20.
xStreet
String
The billing street address of the cardholder
xZip
String
The billing zip code of the cardholder
xMagstripe
String
The magstripe data of a credit card. Magstripe data includes the card number and expiration date. When using this command, xCardNum xExp and xToken should not be used. Encrypted card data can also be sent using xMagstripe.
xName
String
The cardholder’s name.
xIP
String
The customer’s IP address. Typically used for fraud detection.
xCVV
String
3-digit code from the back of the card (for Amex, 4-digit code from the front of the card)
xCommand*
String
Sola transaction type
xCardNum*
String
The customer card number. *Alternatively, xToken xMagStripe or SUT can be used.
xExp*
String
The card expiration number. Format: MMYY. For sandbox test transactions, use any date in the future. *xExp is required when sending in xCardnum and cannot be used with xMagstripe
xCustom01
String
20 custom fields are available for custom data, such as customer comments, etc. Use xCustom01 through xCustom20.
xCVV
String
3-digit code from the back of the card (for Amex, 4-digit code from the front of the card).
xStreet
String
The billing street address of the cardholder
xZip
String
The billing zip code of the cardholder
xMagstripe
String
The magstripe data of a credit card. Magstripe data includes the card number and expiration date. When using this command, xCardNum xExp and xToken should not be used. Encrypted card data can also be sent using xMagstripe.
xName
String
The cardholder’s name
xIP
String
The customer’s IP address. Typically used for fraud detection.
xCVV
String
3-digit code from the back of the card (for Amex, 4-digit code from the front of the card)
xSoftwareName*
String
Name of your software
xSoftwareVersion*
String
Version number of your software
xCommand*
String
Sola transaction type
xAmount*
String
The total amount of the transaction, inclusive of tax and tip if applicable. This the total amount of the transaction.
xCustom01*
String
20 custom fields are available for custom data, such as customer comments, etc. Use xCustom01 through xCustom20.
xToken
String
The Sola token that references a previously used payment method. When using a token, xCardNum xExp and xMagstripe should not be used.
xCVV
String
3-digit code from the back of the card (for Amex, 4-digit code from the front of the card)
xStreet
String
The billing street address of the cardholder
xZip
String
The billing zip code of the cardholder
xMagstripe
String
The magstripe data of a credit card. Magstripe data includes the card number and expiration date. When using this command, xCardNum xExp and xToken should not be used. Encrypted card data can also be sent using xMagstripe
xName
String
The cardholder’s name
xDUKPT
String
The DUK/PT key for PIN debit and EBT transactions.The first 16 characters are the encrypted PIN block, followed by the 6 character long Key Set Identifier (KSID). The remaining characters are the PIN pad serial number and transaction counter.
xTax
String
The tax portion that is included in the total transaction amount (xAmount)
xTip
String
The tip portion that is included in the total transaction amount (xAmount)
xInvoice
String
The merchant’s invoice number for the transaction. xInvoice is recommended when available for improved duplicate handling.
xPONum
String
The merchant’s purchase order number for the transaction
xComments
String
Additional data optionally passed along to the receipt
xDescription
String
Additional data that is optionally passed along for reporting
xIP
String
The customer’s IP address. Typically used for fraud detection.
xEmail
String
The customer’s email address
xFax
String
The customer’s fax number
xBillFirstName
String
The customer’s first name for their billing profile
xBillMiddleName
String
The customer’s middle name or initial for their billing profile
xBillLastName
String
The customer’s last/family name for their billing profile
xBillCompany
String
The customer’s company name for their billing profile
xBillStreet
String
The customer’s street address for their billing profile
xBillStreet2
String
The customer’s street address 2nd line for their billing profile
xBillCity
String
The customer’s city for their billing profile
xBillState
String
The customer’s state for their billing profile
xBillZip
String
The customer’s zip code for their billing profile
xBillCountry
String
The customer’s country for their billing profile
xBillPhone
String
The customer’s phone number for their billing profile
xBillMobile
String
The customer’s mobile number for their billing profile
xShipFirstName
String
The customer’s first name for their shipping profile
xShipMiddleName
String
The customer’s middle name or initial for their shipping profile
xShipLastName
String
The customer’s last/family name for their shipping profile
xShipCompany
String
The customer’s company name for their shipping profile
xShipStreet
String
The customer’s street address for their shipping profile
xShipStreet2
String
The customer’s street address 2nd line for their shipping profile
xShipCity
String
The customer’s city for their shipping profile
xShipState
String
The customer’s state for their shipping profile
xShipZip
String
The customer’s zip code for their shipping profile
xShipCountry
String
The customer’s country for their shipping profile
xShipPhone
String
The customer’s phone number for their shipping profile
xShipMobile
String
The customer’s mobile number for their shipping profile
xOrderId
String
Unique order number for FraudWatch verification
xExistingCustomer
String
Yes/No value indicating if the customer is a repeat customer
xAllowDuplicate
String
By default, Sola rejects duplicate transactions within 10 minutes of the original transaction. This command overrides that safeguard. True/False allowed.
xCustReceipt
String
True/False value indicating if the email address specified in xemail should receive a receipt containing the transaction details.
xCurrency
String
Used to specify an alternate currency. Only applicable for accounts that are using Multi-Currency Conversion (MCC). For accounts that are natively in a foreign currency, the currency does not need to be specified. (see list of all supported currencies).
xTimeoutSeconds
String
Configurable amount of seconds in which the request will wait for a response.
xCommand*
String
Sola transaction type
xRefNum*
String
Used to reference a previous transaction when processing a follow-up transaction; typically a refund, void, or capture. (Note: xRefnum can be a 64-bit number and should be stored as BIGINT, Long, Int64 or String).
xAmount
String
Refund amount. Can be equal or less than the original transaction.
xAllowDuplicate
String
By default, Sola rejects duplicate transactions within 10 minutes of the original transaction. This command overrides that safeguard. True/False allowed.
xDescription
String
Additional data optionally passed along for reporting
xCustReceipt
String
True/False value indicating if the email address specified in xemail should receive a receipt containing the transaction details
xTimeoutSeconds
String
Configurable amount of seconds in which the request will wait for a response.
xCommand*
String
Sola transaction type
xRefNum*
String
Used to reference a previous transaction when processing a follow-up transaction; typically a refund, void, or capture. (Note: xRefnum can be a 64-bit number and should be stored as BIGINT, Long, Int64 or String).
xCustom01
String
20 custom fields are available for custom data, such as customer comments, etc. Use xCustom01 through xCustom20.
xCommand*
String
Sola transaction type
xRefNum*
String
Used to reference a previous transaction when processing a follow-up transaction, typically a refund, void, or capture. (Note: xRefnum can be a 64-bit number and should be stored as BIGINT, Long, Int64 or String).
xCustom01
String
20 custom fields are available for custom data, such as customer comments, etc. Use xCustom01 through xCustom20.
xCommand*
String
Sola transaction type
xRefNum*
String
Used to reference a previous transaction when processing a follow-up transaction; typically a refund, void, or capture. (Note: xRefnum can be a 64-bit number and should be stored as BIGINT, Long, Int64 or String).
xCustom01
String
20 custom fields are available for custom data, such as customer comments, etc. Use xCustom01 through xCustom20.
This page contains all API documentation for Check (ACH), and ACH-Q transactions. For more information regarding account access, navigate to the Transaction API parent page.
Sola provides ACH and ACHQ processing for the transactions listed below (with exception of VoidRefund, which there is only ACHQ processing for). For more information regarding ACHQ, refer to the ACHQ or contact Sola support.
Note: The use of check/ACH transactions requires compliance with Nacha regulations, including the requirement to capture a physical or electronic signature from the customer. Please ensure your integration meets these compliance standards.
POST check:sale
xCommand = check:Sale
The Check Sale command debits funds from a customer’s checking or savings account using one of the following options:
The merchant must have a supported Check/ACH processing account to use either of these options.
POST check:save
xCommand = check:Save
The Save command is used to send account information and request a token from Sola but does not submit the transaction for processing. The response returns a token that references the account information. A token at minimum references the account and routing number, but if other data is sent—such as billing address—that will be associated with the token as well.
POST check:adjust
You can use the Adjust command to update certain fields on a transaction, such as xOrderID. This action will not reprocess the transaction; it will only update the information. Any non-required field can be adjusted.
POST check:void
xCommand = check:Void
The Void command voids a check transaction that is pending being sent to the bank, typically at the end of each day.
POST check:refund
xCommand = check:Refund
The Refund command is used to refund the full amount of a previously settled check transaction, using xRefNum. Partial check refund isn’t supported.
POST check:VoidRefund
xCommand = check:VoidRefund
The VoidRefund within the ACHQ tooling is used void a check transaction that is pending being sent to the bank, typically at the end of each day. It also issues a refund. Partial refunds are also supported.
A: It typically takes 2-3 days.
A: There are a few ways to get the status. Via email, webhook, the Sola Portal, or by pulling a report using our reporting API.
A: You should get back the following status codes (xStatus) from Sola:
0 (Pending)
20 (Rejected)
5 (Cancelled)
6 (Awaiting Response)
The daily emails may contain more information.
A: Sola only returns tokens on check transactions that contain the routing and account number. In the event only check images and MICR were submitted, the token is not returned since it can’t be reused on subsequent transactions.
xCommand*
String
Sola transaction type
xAmount*
String
The total amount of the transaction, inclusive of tax and tip if applicable.
xRouting*
String
The check ABA routing number
xAccount*
String
The check account number
xName*
String
Name on account
xToken
String
The Sola token that references a previously used payment method. When using a token, xCardNum xExp and xMagstripe should not be used.
xCustom01
String
20 custom fields are available for custom data, such as customer comments, etc. Use xCustom01 through xCustom20.
xTax
String
The tax portion that is included in the total transaction amount (xAmount)
xTip
String
The tip portion that is included in the total transaction amount (xAmount)
xInvoice
String
The merchant’s invoice number for the transaction. xInvoice is recommended when available for improved duplicate handling.
xPONum
String
The merchant’s purchase order number for the transaction
xComments
String
Additional data optionally passed along to the receipt
xDescription
String
Additional data optionally passed along for reporting
xIP
String
The customer’s IP address. Typically used for fraud detection
xEmail
String
The customer’s email address
xFax
String
The customer’s fax number
xBillFirstName
String
The customer’s first name for their billing profile
xBillMiddleName
String
The customer’s middle name or initial for their billing profile
xBillLastName
String
The customer’s last/family name for their billing profile
xBillCompany
String
The customer’s company name for their billing profile
xBillStreet
String
The customer’s street address for their billing profile
xBillStreet2
String
The customer’s street address 2nd line for their billing profile
xBillCity
String
The customer’s city for their billing profile
xBillState
String
The customer’s state for their billing profile
xBillZip
String
The customer’s zip code for their billing profile
xBillCountry
String
The customer’s country for their billing profile
xBillPhone
String
The customer’s phone number for their billing profile
xShipFirstName
String
The customer’s first name for their shipping profile
xShipMiddleName
String
The customer’s middle name or initial for their shipping profile
xShipLastName
String
The customer’s last/family name for their shipping profile
xShipCompany
String
The customer’s company name for their shipping profile
xShipStreet
String
The customer’s street address for their shipping profile
xShipStreet2
String
The customer’s street address 2nd line for their shipping profile
xShipCity
String
The customer’s city for their shipping profile
xShipState
String
The customer’s state for their shipping profile
xShipZip
String
The customer’s zip code for their shipping profile
xShipCountry
String
The customer’s country for their shipping profile
xShipPhone
String
The customer’s phone number for their shipping profile
xShipMobile
String
The customer’s mobile number for their shipping profile
xMICR
String
The routing, account and check number data from the bottom of a check in MICR (Magnetic Ink Character Recognition) format, typically generated by a check scanner
xCheckNum
String
The check number
xCheckImageFront
String
The front image of the check, in Base 64 encoded image format.
xCheckImageRear
String
The back image of the check, in Base 64 encoded image format.
xOrderID
String
Unique order number for FraudWatch verification
xExistingCustomer
String
Yes/No value indicating if the customer is a repeat customer
xAllowDuplicate
String
By default, Sola rejects duplicate transactions within 10 minutes of the original transaction. This command overrides that safeguard. True/False allowed.
xCustReceipt
String
True/False value indicating if the email address specified in xemail should receive a receipt containing the transaction details
xCurrency
String
Used to specify an alternate currency. Only applicable for accounts that are using Multi-Currency Conversion (MCC). For accounts that are natively in a foreign currency, the currency does not need to be specified. ().
xBillMobile
String
The customer’s mobile number for their billing profile
xAccountType
String
Type of account: Checking or Savings
xTimeoutSeconds
String
Configurable amount of seconds in which the request will wait for a response.
xPaymentOrigin
String
Origin of payment.
Possible values:
"Internet" (denoting web transactions)
"SignatureOriginal" (denoting transactions with physical signature)
xSoftwareVersion*
String
Version number of your software
xAccount*
String
The check account number
xVersion*
String
Gateway API version. The current version is 5.0.0
xKey*
String
Your Sola API key.
xCustom01
String
20 custom fields are available for custom data, such as customer comments, etc. Use xCustom01 through xCustom20.
xIP
String
The customer’s IP address. Typically used for fraud detection.
xMICR
String
The routing, account, and check number data from the bottom of a check in MICR (Magnetic Ink Character Recognition) format, typically generated by a check scanner
xAllowDuplicate
String
By default, Sola rejects duplicate transactions within 10 minutes of the original transaction. This command overrides that safeguard. True/False allowed.
String
The total amount of the transaction, inclusive of tax and tip if applicable. This the total amount of the transaction.
xRefNum*
String
Used to reference a previous transaction when doing a follow-up transaction; typically a refund, void, or capture. (Note: xRefnum can be a 64-bit number and should be stored as BIGINT, Long, Int64 or String). *The xRefNum from the related authorization is required when submitting an Adjust transaction.
xCustom01 – xCustom03
String
Custom fields available for custom data, such as customer comments, etc.
xStreet
String
The billing street address of the cardholder
xZip
String
The billing zip code of the cardholder
xName
String
The cardholder’s name
xDescription
String
Additional data optionally passed along for reporting
xOrderID
String
Unique Order Number for FraudWatch verification
xTip
String
The tip portion that is included in the total transaction amount (xAmount)
xTax
String
The tax portion that is included in the total transaction amount (xAmount)
xSignature
String
The Base 64 encoded customer signature
xInvoice
String
The merchant’s invoice number for the transaction. xInvoice is recommended when available for improved duplicate handling
xCommand*
String
Sola transaction type
xRefNum*
String
Used to reference a previous transaction when processing a follow-up transaction; typically a refund, void, or capture. (Note: xRefnum can be a 64-bit number and should be stored as BIGINT, Long, Int64 or String).
xCustom01
String
20 custom fields are available for custom data, such as customer comments, etc. Use xCustom01 through xCustom20.
xIP
String
The customer’s IP address. Typically used for fraud detection.
xCommand*
String
Sola transaction type
xRefNum*
String
Used to reference a previous transaction when processing a follow-up transaction; typically a refund, void, or capture. (Note: xRefnum can be a 64-bit number and should be stored as BIGINT, Long, Int64 or String)
xAmount*
String
The total amount of the transaction, inclusive of tax and tip if applicable. This the total amount of the transaction.
xCustom01
String
20 custom fields are available for custom data, such as customer comments, etc. Use xCustom01 through xCustom20.
xIP
String
The customer’s IP address. Typically used for fraud detection.
xAllowDuplicate
String
By default, Sola rejects duplicate transactions within 10 minutes of the original transaction. This command overrides that safeguard. True/False allowed.
xCustReceipt
String
True/False value indicating if the email address specified in xemail should receive a receipt containing the transaction details.
xTimeoutSeconds
String
Configurable amount of seconds in which the request will wait for a response.
xAccount*
String
The check account number
xVersion*
String
Gateway API version. The current version is 5.0.0
xKey*
String
Your Sola API key.
xBillState*
String
Company Billing State
xBillCity*
String
Company Billing City
xBillStreet*
String
Company Street Address
xBillCompany*
String
Required if xCheckType = Business
xBillZip*
String
Company Billing Zip
xBillPhone*
String
Company Phone Number
xEmail*
String
Company Email
xCheckType*
String
Check Type (Business, Personal)
xName
String
The cardholder’s name. One of xName, xBillFirstName, or xBillLastName are required.
xCustom01
String
20 custom fields are available for custom data, such as customer comments, etc. Use xCustom01 through xCustom20.
xIP
String
The customer’s IP address. Typically used for fraud detection.
xMICR
String
The routing, account, and check number data from the bottom of a check in MICR (Magnetic Ink Character Recognition) format, typically generated by a check scanner
xAllowDuplicate
String
By default, Sola rejects duplicate transactions within 10 minutes of the original transaction. This command overrides that safeguard. True/False allowed.
16 (Settled)
18 (Returned)
19 (Hold)
xKey*
String
Your Sola API key.
xVersion*
String
Gateway API version. The current version is 5.0.0
xSoftwareName*
String
Name of your software
xSoftwareVersion*
String
Version number of your software
xCommand*
String
Sola transaction type
xRouting*
String
The check ABA routing number
xName*
String
The cardholder’s name
xSoftwareName*
String
Name of your software
xKey*
String
Your Sola API key
xVersion*
String
Gateway API Version. The current version is 5.0.0.
xCommand*
String
Sola transaction type
xSoftwareName*
String
Name of your software
xSoftwareVersion*
String
Version number of your software
xKey*
String
Your Sola API key.
xVersion*
String
Gateway API version. The current version is 5.0.0
xSoftwareName*
String
Name of your software
xSoftwareVersion*
String
Version number of your software
xKey*
String
Your Sola API key.
xVersion*
String
Gateway API version. The current version is 5.0.0
xSoftwareName*
String
Name of your software
xSoftwareVersion*
String
Version number of your software
xCommand*
String
Sola transaction type
xRouting*
String
The check ABA routing number
xSoftwareName*
String
Name of your software
xSoftwareVersion*
String
Version number of your software
xAmount*
{
"xKey": "[xkeycredentials]",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "check:sale",
"xAmount": "35.00",
"xToken": "61h72mmh68phn9q233634ph3g54p1499m69qhp4816pn528h84",
"xCustom01": "Register01",
"xRouting": "123456789",
"xAccount": "123456789",
"xAccountType": "Checking",
"xName": "John Doe",
"xTax": "2.00",
"xTip": "2.00",
"xInvoice": "123456A",
"xPONum": "123456B",
"xComments": "This is a comment",
"xDescription": "This is a description",
"xIP": "1.2.3.4",
"xEmail": "[email protected]",
"xFax": "1234567890",
"xBillFirstName": "John",
"xBillMiddleName": "Max",
"xBillLastName": "Doe",
"xBillCompany": "Acme",
"xBillStreet": "123 Any Street",
"xBillStreet2": "Apt 4b",
"xBillCity": "Anytown",
"xBillState": "NY",
"xBillZip": "12345",
"xBillCountry": "USA",
"xBillPhone": "8005551212",
"xBillMobile": "8005551111",
"xShipFirstName": "John",
"xShipMiddleName": "Max",
"xShipLastName": "Doe",
"xShipCompany": "Acme",
"xShipStreet": "123 Any Street",
"xShipStreet2": "Apt 4b",
"xShipCity": "Anytown",
"xShipState": "NY",
"xShipZip": "11111",
"xShipCountry": "USA",
"xShipPhone": "8005551212",
"xShipMobile": "8005551111",
"xMICR": "t021000021t 123456789o _2542",
"xCheckNum": "999",
"xCheckImageFront": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAYEBAQFBAYFBQYJBgUGCQsIBgYICwwKCgsKCgwQDAwMDAwMEAwODxAPDgwTExQUExMcGxsbHCAgICAgICAgICD/2wBDAQcHBw0MDRgQEBgaFREVGiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICD/w",
"xCheckImageRear": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAYEBAQFBAYFBQYJBgUGCQsIBgYICwwKCgsKCgwQDAwMDAwMEAwODxAPDgwTExQUExMcGxsbHCAgICAgICAgICD/2wBDAQcHBw0MDRgQEBgaFREVGiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICD/w",
"xOrderID": "12356",
"xExistingCustomer": "TRUE",
"xAllowDuplicate": "TRUE",
"xCustReceipt": "TRUE",
"xCurrency": "USD",
"xTimeoutSeconds": "10",
"xPaymentOrigin": "Internet"
}{
"xKey": "[xkeycredentials]",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "check.save",
"xCustom01": "Register01",
"xRouting": "123456789",
"xAccount": "123456789",
"xName": "John Doe",
"xIP": "1.2.3.4",
"xMICR": "t021000021t 123456789o _2542",
"xAllowDuplicate": "TRUE"
}{
"xKey": "[xkeycredentials]",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "cc:adjust",
"xAmount": "35.00",
"xCustom01": "Register01",
"xCustom02": "Register01",
"xCustom03": "Register01",
"xStreet": "123 Main Street",
"xZip": "12345",
"xRefNum": "81234568",
"xName": "John Doe",
"xDescription": "This is a description",
"OrderID": "123456",
"xTip": "1.05",
"xTax": "1.05",
"xSignature": "aGVsbG8gaG93IGFyZSB5b3UK",
"xInvoice": "123456A"
}{
"xResult": "A",
"xStatus": "Approved",
"xError": "",
"xErrorCode": "00000",
"xRefNum": "10000016879",
"xInvoice": "1234567",
"xRefNumCurrent": "10000016886",
"xDate": "7/11/2022 4:06:11 PM"
}{
"xKey": "[xkeycredentials]",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "check.void",
"xCustom01": "Register01",
"xRefNum": "81726356",
"xIP": "1.1.1.1"
}{
"xKey": "[xkeycredentials]",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "check.refund",
"xAmount": "9.99",
"xCustom01": "Register01",
"xRefNum": "81726356",
"xIP": "1.1.1.1",
"xAllowDuplicate": "TRUE",
"xCustReceipt": "FALSE",
"xTimeoutSeconds": "10"
}POST gift:issue
xCommand = gift:issue
The Issue command is used to issue funds to a Sola gift card.
xCardNum*
String
The customer card number. *Alternatively, xToken xMagStripe or SUT can be used.
xKey*
String
Your Sola API key.
xVersion*
String
Gateway API version. The current version is 5.0.0.
xSoftwareName*
String
Name of your software
POST gift:redeem
xCommand = gift:redeem
The Redeem command is used to debit funds from a Sola gift card.
xCardNum*
String
The customer card number. *Alternatively, xToken xMagStripe or SUT can be used.
xKey*
String
Your Sola API key.
xVersion*
String
Gateway API version. The current version is 5.0.0.
xSoftwareName*
String
Name of your software
POST gift:balance
xCommand = gift:balance
The Balance command is used to check the available balance on a Sola gift card.
xCardNum*
String
The customer card number. *Alternatively, xToken xMagStripe or SUT can be used.
xKey*
String
Your Sola API key.
xVersion*
String
Gateway API version. The current version is 5.0.0.
xSoftwareName*
String
Name of your software
POST gift:activate
xCommand = gift:activate
The Activate command is used to activate a Sola gift card.
xCardNum*
String
The customer card number. *Alternatively, xToken, xMagStripe or SUT can be used.
xKey*
String
Your Sola API key.
xVersion*
String
Gateway API version. The current version is 5.0.0.
xSoftwareName*
String
Name of your software
POST gift:deactivate
xCommand = gift:deactivate
The Deactivate command is used to deactivate a Sola gift card.(note: you can still check the balance of the gift card even after it has been deactivated).
xCardNum*
String
The customer card number. *Alternatively, xToken, xMagStripe or SUT can be used.
xKey*
String
Your Sola API key.
xVersion*
String
Gateway API version. The current version is 5.0.0.
xSoftwareName*
String
Name of your software
{
"xCardNum": "4444333322221111",
"xKey": "[xkeycredentials]",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "gift:issue",
"xAmount": "35.00",
"xToken": "61h72mmh68phn9q233634ph3g54p1499m69qhp4816pn528h84",
"xCustom01": "Register01",
"xExp": "12/25",
"xCVV": "945",
"xStreet": "123 Any Street Apt 4b Anytown, NY",
"xZip": "12345",
"xMagstripe": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;4444333322221111=4912101123456789?",
"xName": "John Doe",
"xDUKPT": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;444433",
"xTax": "2.00",
"xTip": "2.00",
"xInvoice": "123456A",
"xPONum": "123456B",
"xComments": "This is a comment",
"xDescription": "This is a description",
"xIP": "1.2.3.4",
"xEmail": "[email protected]",
"xFax": "1234567890",
"xBillFirstName": "John",
"xBillMiddleName": "Max",
"xBillLastName": "Doe",
"xBillCompany": "Acme",
"xBillStreet": "123 Any Street",
"xBillStreet2": "Apt 4b",
"xBillCity": "Anytown",
"xBillState": "NY",
"xBillZip": "12345",
"xBillCountry": "USA",
"xBillPhone": "8005551212",
"xBillMobile": "8005551111",
"xShipFirstName": "John",
"xShipMiddleName": "Max",
"xShipLastName": "Doe",
"xShipCompany": "Acme",
"xShipStreet": "123 Any Street",
"xShipStreet2": "Apt 4b",
"xShipCity": "Anytown",
"xShipState": "NY",
"xShipZip": "12345",
"xShipCountry": "USA",
"xShipPhone": "8005551212",
"xShipMobile": "8005551111",
"xOrderID": "12356",
"xExistingCustomer": "TRUE",
"xAllowDuplicate": "TRUE",
"xTimeoutSeconds": "10"
}{
"xCardNum": "4444333322221111",
"xKey": "[xkeycredentials]",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "gift:redeem",
"xAmount": "35.00",
"xToken": "61h72mmh68phn9q233634ph3g54p1499m69qhp4816pn528h84",
"xCustom01": "Register01",
"xExp": "12/25",
"xCVV": "945",
"xStreet": "123 Any Street Apt 4b Anytown, NY",
"xZip": "12345",
"xMagstripe": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;4444333322221111=4912101123456789?",
"xName": "John Doe",
"xDUKPT": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;444433",
"xTax": "2.00",
"xTip": "2.00",
"xInvoice": "123456A",
"xPONum": "123456B",
"xComments": "This is a comment",
"xDescription": "This is a description",
"xIP": "1.2.3.4",
"xEmail": "[email protected]",
"xFax": "1234567890",
"xBillFirstName": "John",
"xBillMiddleName": "Max",
"xBillLastName": "Doe",
"xBillCompany": "Acme",
"xBillStreet": "123 Any Street",
"xBillStreet2": "Apt 4b",
"xBillCity": "Anytown",
"xBillState": "NY",
"xBillZip": "12345",
"xBillCountry": "USA",
"xBillPhone": "8005551212",
"xBillMobile": "8005551111",
"xShipFirstName": "John",
"xShipMiddleName": "Max",
"xShipLastName": "Doe",
"xShipCompany": "Acme",
"xShipStreet": "123 Any Street",
"xShipStreet2": "Apt 4b",
"xShipCity": "Anytown",
"xShipState": "NY",
"xShipZip": "12345",
"xShipCountry": "USA",
"xShipPhone": "8005551212",
"xShipMobile": "8005551111",
"xOrderID": "12356",
"xExistingCustomer": "TRUE",
"xAllowDuplicate": "TRUE",
"xTimeoutSeconds": "10"
}{
"xCardNum": "4444333322221111",
"xKey": "[xkeycredentials]",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "gift:balance",
"xToken": "61h72mmh68phn9q233634ph3g54p1499m69qhp4816pn528h84",
"xCustom01": "Register01",
"xExp": "12/25",
"xCVV": "945",
"xStreet": "123 Any Street Apt 4b Anytown, NY",
"xZip": "12345",
"xMagstripe": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;4444333322221111=4912101123456789?",
"xName": "John Doe",
"xAuthCode": "T4321A",
"xDUKPT": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;444433",
"xTax": "2.00",
"xTip": "2.00",
"xRefNum": "81234568",
"xInvoice": "123456A",
"xPONum": "123456B",
"xComments": "This is a comment",
"xDescription": "This is a description",
"xIP": "1.2.3.4",
"xEmail": "[email protected]",
"xFax": "1234567890",
"xBillFirstName": "John",
"xBillMiddleName": "Max",
"xBillLastName": "Doe",
"xBillCompany": "Acme",
"xBillStreet": "123 Any Street",
"xBillStreet2": "Apt 4b",
"xBillCity": "Anytown",
"xBillState": "NY",
"xBillZip": "12345",
"xBillCountry": "USA",
"xBillPhone": "8005551212",
"xBillMobile": "8005551111",
"xShipFirstName": "John",
"xShipMiddleName": "Max",
"xShipLastName": "Doe",
"xShipCompany": "Acme",
"xShipStreet": "123 Any Street",
"xShipStreet2": "Apt 4b",
"xShipCity": "Anytown",
"xShipState": "NY",
"xShipZip": "12345",
"xShipCountry": "USA",
"xShipPhone": "8005551212",
"xShipMobile": "8005551111",
"xMICR": "t021000021t 123456789o _2542",
"xRouting": "021202337",
"xGatewayRefNum": "852585258",
"xGatewayResult": "Approved",
"xGatewayError": "845455484",
"xGatewayCVV": "M",
"xGatewayAVS": "YYY",
"xOrderType": "Internet",
"xOrderID": "12356",
"xExistingCustomer": "TRUE",
"xOrderItems": "Sony Digital Camera",
"xCustomerComments": "Please ship as soon as possible",
"xShipMethod": "UPS Ground",
"xShipAmount": "29.99",
"xShipEmail": "[email protected]",
"xAllowDuplicate": "TRUE"
}{
"xCardNum": "4444333322221111",
"xKey": "[xkeycredentials]",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "gift:activate"
}{
"xCardNum": "4444333322221111",
"xKey": "[xkeycredentials]",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "gift:deactivate"
}xSoftwareVersion*
String
Version number of your software
xCommand*
String
Sola transaction type
xCustom01*
String
20 custom fields are available for custom data, such as customer comments, etc. Use xCustom01 through xCustom20.
xAmount*
String
The total amount of the transaction, inclusive of tax and tip if applicable. This the total amount of the transaction.
xToken
String
The Sola token that references a previously used payment card. When using this variable, xCardNumand xMagstripe should not be used maximum 50 alphanumeric characters).
xMagstripe
String
The magstripe data of a credit card. Magstripe data includes the card number and expiration date. When using this command, xCardNum xExp and xToken should not be used. Encryptedcard data can also be sent using xMagstripe
xName
String
The cardholder’s name
xTax
String
The tax portion that is included in the total transaction amount (xAmount)
xTip
String
The tip portion that is included in the total transaction amount (xAmount)
xInvoice
String
The merchant’s invoice number for the transaction. xInvoice is recommended when available for improved duplicate handling.
xPONum
String
The merchant’s purchase order number for the transaction
xComments
String
Additional data that is optionally passed along to the receipt
xDescription
String
Additional data that is optionally passed along for reporting
xIP
String
The customer’s IP address. Typically used for fraud detection.
xEmail
String
The customer’s email address
xFax
String
The customer’s fax number
xBillFirstName
String
The customer’s first name for their billing profile
xBillMiddleName
String
The customer’s middle name or initial for their billing profile
xBillLastName
String
The customer’s last/family name for their billing profile
xBillCompany
String
The customer’s company name for their billing profile
xBillStreet
String
The customer’s street address for their billing profile
xBillStreet2
String
The customer’s street address 2nd line for their billing profile
xBillCity
String
The customer’s city for their billing profile
xBillState
String
The customer’s state for their billing profile
xBillZip
String
The customer’s zip code for their billing profile
xBillCountry
String
The customer’s country for their billing profile
xBillPhone
String
The customer’s phone number for their billing profile
xBillMobile
String
The customer’s mobile number for their billing profile
xShipFirstName
String
The customer’s first name for their shipping profile
xShipMiddleName
String
The customer’s middle name or initial for their shipping profile
xShipLastName
String
The customer’s last/family name for their shipping profile
xShipCompany
String
The customer’s company name for their shipping profile
xShipStreet
String
The customer’s street address for their shipping profile
xShipStreet2
String
The customer’s street address 2nd line for their shipping profile
xShipCity
String
The customer’s city for their shipping profile
xShipState
String
The customer’s state for their shipping profile
xShipZip
String
The customer’s zip code for their shipping profile
xShipCountry
String
The customer’s country for their shipping profile
xShipPhone
String
The customer’s phone number for their shipping profile
xShipMobile
String
The customer’s mobile number for their shipping profile
xAllowDuplicate
String
By default, Sola rejects duplicate transactions within 10 minutes of the original transaction. This command overrides that safeguard. True/False allowed.
xOrderID
String
Unique order number for FraudWatch verification
xExistingCustomer
String
Yes/No value indicating if the customer is a repeat customer
xExp
String
Gift card expiration number. Format: MMYY. For sandbox accounts, use any date in the future. *Required and available only when xCardNum is used.
xCVV
String
3-digit code from the back of the card (for Amex, 4-digit code from the front of the card)
xStreet
String
The billing street address of the cardholder
xZip
String
The billing zip code of the cardholder
xDUKPT
String
The DUK/PT key for PIN debit and EBT transactions.The first 16 characters are the encrypted PIN block, followed by the 6 character long Key Set Identifier (KSID). The remaining characters are the PIN pad serial number and transaction counter.
xTimeoutSeconds
String
Configurable amount of seconds in which the request will wait for a response.
xSoftwareVersion*
String
Version number of your software
xCommand*
String
Sola transaction type
xAmount*
String
The total amount of the transaction, inclusive of tax and tip if applicable. This the total amount of the transaction.
xCustom01*
String
20 custom fields are available for custom data, such as customer comments, etc. Use xCustom01 through xCustom20.
xToken
String
The Sola token that references a previously used card. When using a variable, xCardNumand xMagstripe should no be used (maximum 50 alphanumeric characters).
xMagstripe
String
The magstripe data of a credit card. Magstripe data includes the card number and expiration date. When using this command, xCardNum xExp and xToken should not be used. Encrypted Card data can also be sent using xMagstripe.
xName
String
The cardholder’s name
xTax
String
The tax portion that is included in the total transaction amount (xAmount)
xTip
String
The tip portion that is included in the total transaction amount (xAmount)
xInvoice
String
The merchant’s invoice number for the transaction. xInvoice is recommended when available for improved duplicate handling.
xPONum
String
The merchant’s purchase order number for the transaction
xComments
String
Additional data that is optionally passed along to the receipt
xDescription
String
Additional data that is optionally passed along for reporting
xIP
String
The customer’s IP address. Typically used for fraud detection.
xEmail
String
The customer’s email address
xFax
String
The customer’s fax number
xBillFirstName
String
The customer’s first name for their billing profile
xBillMiddleName
String
The customer’s middle name or initial for their billing profile
xBillLastName
String
The customer’s last/family name for their billing profile
xBillCompany
String
The customer’s company name for their billing profile
xBillStreet
String
The customer’s street address for their billing profile
xBillStreet2
String
The customer’s street address 2nd line for their billing profile
xBillCity
String
The customer’s city for their billing profile
xBillState
String
The customer’s state for their billing profile
xBillZip
String
The customer’s zip code for their billing profile
xBillCountry
String
The customer’s country for their billing profile
xBillPhone
String
The customer’s phone number for their billing profile
xBillMobile
String
The customer’s mobile number for their billing profile
xShipFirstName
String
The customer’s first name for their shipping profile
xShipMiddleName
String
The customer’s middle name or initial for their shipping profile
xShipLastName
String
The customer’s last/family name for their shipping profile
xShipCompany
String
The customer’s company name for their shipping profile
xShipStreet
String
The customer’s street address for their shipping profile
xShipStreet2
String
The customer’s street address 2nd line for their shipping profile
xShipCity
String
The customer’s city for their shipping profile
xShipState
String
The customer’s state for their shipping profile
xShipZip
String
The customer’s zip code for their shipping profile
xShipCountry
String
The customer’s country for their shipping profile
xShipPhone
String
The customer’s phone number for their shipping profile
xShipMobile
String
The customer’s mobile number for their shipping profile
xAllowDuplicate
String
By default, Sola rejects duplicate transactions within 10 minutes of the original transaction. This command overrides that safeguard. True/False allowed.
xOrderID
String
Unique order number for FraudWatch verification
xExistingCustomer
String
Yes/No value indicating if the customer is a repeat customer
xExp
String
Gift card expiration number. Format: MMYY. For sandbox accounts, use any date in the future. *Required and available only when xCardNum is used.
xCVV
String
3-digit code from the back of the card (for Amex, 4-digit code from the front of the card).
xStreet
String
The billing street address of the cardholder
xZip
String
The billing zip code of the cardholder
xDUKPT
String
The DUK/PT key for PIN debit and EBT transactions.The first 16 characters are the encrypted PIN block, followed by the 6 character long Key Set Identifier (KSID). The remaining characters are the PIN pad serial number and transaction counter.
xTimeoutSeconds
String
Configurable amount of seconds in which the request will wait for a response.
xSoftwareVersion*
String
Version number of your software
xCommand*
String
Sola transaction type
xToken
String
The Sola token that references a previously used payment method. When using a token, xCardNum xExp and xMagstripe should not be used.
xMagstripe
String
The magstripe data of a credit card. Magstripe data includes the card number and expiration date. When using this command, xCardNum xExp and xToken should not be used. Encrypted card data can also be sent using xMagstripe.
xName
String
The cardholder’s name
xTax
String
The tax portion that is included in the total transaction amount (xAmount)
xTip
String
The tip portion that is included in the total transaction amount (xAmount)
xInvoice
String
The merchant’s invoice number for the transaction. xInvoice is recommended when available for improved duplicate handling.
xPONum
String
The merchant’s purchase order number for the transaction
xComments
String
Additional data that is optionally passed along to the receipt
xDescription
String
Additional data that is optionally passed along for reporting
xIP
String
The customer’s IP address. Typically used for fraud detection
xEmail
String
The customer’s email address
xFax
String
The customer’s fax number
xBillFirstName
String
The customer’s first name for their billing profile
xBillMiddleName
String
The customer’s middle name or initial for their billing profile
xBillLastName
String
The customer’s last/family name for their billing profile
xBillCompany
String
The customer’s company name for their billing profile
xBillStreet
String
The customer’s street address for their billing profile
xBillStreet2
String
The customer’s street address 2nd line for their billing profile
xBillCity
String
The customer’s city for their billing profile
xBillState
String
The customer’s state for their billing profile
xBillZip
String
The customer’s zip code for their billing profile
xBillCountry
String
The customer’s country for their billing profile
xBillPhone
String
The customer’s phone number for their billing profile
xBillMobile
String
The customer’s mobile number for their billing profile
xShipFirstName
String
The customer’s first name for their shipping profile
xShipMiddleName
String
The customer’s middle name or initial for their shipping profile
xShipLastName
String
The customer’s last/family name for their shipping profile
xShipCompany
String
The customer’s company name for their shipping profile
xShipStreet
String
The customer’s street address for their shipping profile
xShipStreet2
String
The customer’s street address 2nd line for their shipping profile
xShipCity
String
The customer’s city for their shipping profile
xShipState
String
The customer’s state for their shipping profile
xShipZip
String
The customer’s zip code for their shipping profile
xShipCountry
String
The customer’s country for their shipping profile
xShipPhone
String
The customer’s phone number for their shipping profile
xShipMobile
String
The customer’s mobile number for their shipping profile
xAllowDuplicate
String
By default, Sola rejects duplicate transactions within 10 minutes of the original transaction. This command overrides that safeguard. True/False allowed.
xOrderID
String
Unique order number for FraudWatch verification
xExistingCustomer
String
Yes/No value indicating if the customer is a repeat customer
xExp
String
The card expiration number. Format: MMYY. For sandbox test transactions, use any date in the future. *xExp is required when sending in xCardnum and cannot be used with xMagstripe.
xCVV
String
3-digit code from the back of the card (for Amex, 4-digit code from the front of the card).
xStreet
String
The billing street address of the cardholder
xZip
String
The billing zip code of the cardholder
xDUKPT
String
The DUK/PT key for PIN debit and EBT transactions.The first 16 characters are the encrypted PIN block, followed by the 6 character long Key Set Identifier (KSID). The remaining characters are the PIN pad serial number and transaction counter.
Custom01
String
20 custom fields are available for custom data, such as customer comments, etc. Use xCustom01 through xCustom20.
xAuthCode
String
xAuthCode is a verification number provided by the issuing bank to be used with the cc:postauth command
xRefNum
String
Used to reference a previous transaction when processing a follow-up transaction, typically a refund, void, or capture. (Note: xRefnum can be a 64-bit number and should be stored as BIGINT, Long, Int64 or String).
xMICR
String
The routing, account, and check number data from the bottom of a check in MICR (Magnetic Ink Character Recognition) format, typically generated by a check scanner
xRouting
String
The check ABA routing number
xGatewayRefNum
String
Transaction RefNum received from gateway for FraudWatch verification
xGatewayResult
String
Transaction status received from gateway for FraudWatch verification (Approved/Declined/Error)
xGatewayError
String
Transaction RefNum received from gateway for FraudWatch verification.
xGatewayCVV
String
CVV for for FraudWatch verification.
xOrderType
String
Specifies if the order origin is internet OR phone for FraudWatch verification
xGatewayAVS
String
Street address for FraudWatch verification
xOrderItems
String
Summary of products ordered
xCustomerComments
String
Comments submitted by thecustomer along with the order
xShipMethod
String
The shipping carrier/service used
xShipAmount
String
The total cost of shipping charges
xShipEmail
String
The ShipTo email address
xSoftwareVersion*
String
Version number of your software
xCommand*
String
Sola transaction type
xSoftwareVersion*
String
Version number of your software
xCommand*
String
Sola transaction type
This page contains all API documentation for Electronic Benefit Transfer (EBT) transactions. For more information regarding account access, navigate to the Transaction API parent page.
POST ebtfs:sale
xCommand = ebtfs:sale
The Sale command is used to make a purchase on an EBT cardholder’s food stamp account.
POST ebtfs:credit
xCommand = ebtfs:credit
The Credit command is used to credit an EBT cardholder’s food stamp account.
POST ebtfs:balance
xCommand = ebtfs:Balance
The Balance command is used to check the balance on an EBT cash benefit account.
POST ebtfs:voucher
xCommand = ebtfs:voucher
The Voucher command is used to process a manual EBT food stamp voucher.
POST ebtcb:sale
xCommand = ebtcb:sale
The Sale command is used to make a purchase on an EBT cardholder’s cash benefit account.
POST ebtcb:cash
xCommand = ebtcb:Cash
The Cash command enables a cash withdrawal from an EBT cardholder’s cash benefit account.
POST ebtcb:balance
xCommand = ebtcb:Balance
The Balance command is used to check the balance on an EBT cash benefit account.
POST ebtw:sale
xCommand = ebtw:sale
The Sale command is used to make a purchase on an EBTW cardholder’s cash benefit account.
POST ebtw:balance
xCommand = ebtw:Balance
The Balance command is used to check the balance on an EBTW cash benefit account.
POST ebtw:void
xCommand = ebtw:Void
The Void command voids a purchase made with an EBTW cardholder’s cash benefit account.
xSoftwareVersion*
String
Version number of your software
xCommand*
String
Sola transaction type
xAmount*
String
The total amount of the transaction, inclusive of tax and tip if applicable.
xDUKPT*
String
The DUK/PT key for PIN debit and EBT transactions.The first 16 characters are the encrypted PIN block, followed by the 6 character long Key Set Identifier (KSID). The remaining characters are the PIN pad serial number and transaction counter.
xToken
String
The Sola token that references a previously used payment method. When using a token, xCardNum xExp and xMagstripe should not be used.
xCustom01
String
20 custom fields are available for custom data, such as customer comments, etc. Use xCustom01 through xCustom20.
xMagstripe
String
The magstripe data of a credit card. Magstripe data includes the card number and expiration date. When using this command, xCardNum xExp and xToken should not be used. Encrypted card data can also be sent using xMagstripe
xName
String
The cardholder’s name
xTax
String
The tax portion that is included in the total transaction amount (xAmount)
xTip
String
The tip portion that is included in the total transaction amount (xAmount)
xInvoice
String
The merchant’s invoice number for the transaction. xInvoice is recommended when available for improved duplicate handling
xPONum
String
The merchant’s purchase order number for the transaction
xComments
String
Additional data optionally passed along to the receipt
xDescription
String
Additional data optionally passed along for reporting
xIP
String
The customer’s IP address. Typically used for fraud detection
xEmail
String
The customer’s email address
xFax
String
The customer’s fax number
xBillFirstName
String
The customer’s first name for their billing profile
xBillMiddleName
String
The customer’s middle name or initial for their billing profile
xBillLastName
String
The customer’s last/family name for their billing profile
xBillCompany
String
The customer’s company name for their billing profile
xBillStreet
String
The customer’s street address for their billing profile
xBillStreet2
String
The customer’s street address 2nd line for their billing profile
xBillCity
String
The customer’s city for their billing profile
xBillState
String
The customer’s state for their billing profile
xBillZip
String
The customer’s zip code for their billing profile
xBillCountry
String
The customer’s country for their billing profile
xBillPhone
String
The customer’s phone number for their billing profile
xBillMobile
String
The customer’s mobile number for their billing profile
xShipFirstName
String
The customer’s first name for their shipping profile
xShipMiddleName
String
The customer’s middle name or initial for their shipping profile
xShipLastName
String
The customer’s last/family name for their shipping profile
xShipCompany
String
The customer’s company name for their shipping profile
xShipStreet
String
The customer’s street address for their shipping profile
xShipStreet2
String
The customer’s street address 2nd line for their shipping profile
xShipCity
String
The customer’s city for their shipping profile
xShipState
String
The customer’s state for their shipping profile
xShipZip
String
The customer’s zip code for their shipping profile
xShipCountry
String
The customer’s country for their shipping profile
xShipPhone
String
The customer’s phone number for their shipping profile
xShipMobile
String
The customer’s mobile number for their shipping profile
xAllowDuplicate
String
By default, Sola rejects duplicate transactions within 10 minutes of the original transaction. This command overrides that safeguard. True/False allowed.
xCustReceipt
String
True/False value indicating if the email address specified in xemail should receive a receipt containing the transaction details
xOrderID
String
Unique order number for FraudWatch verification
xExistingCustomer
String
Yes/No value indicating if the customer is a repeat customer
xSoftwareVersion*
String
Version number of your software
xCommand*
String
Sola transaction type
xAmount*
String
The total amount of the transaction, inclusive of tax and tip if applicable. This the total amount of the transaction.
xDUKPT*
String
The DUK/PT key for PIN debit and EBT transactions.The first 16 characters are the encrypted PIN block, followed by the 6 character long Key Set Identifier (KSID). The remaining characters are the PIN pad serial number and transaction counter.
xToken
String
The Sola token that references a previously used payment method. When using a token, xCardNum xExp and xMagstripe should not be used.
xCustom01
String
20 custom fields are available for custom data, such as customer comments, etc. Use xCustom01 through xCustom20.
xMagstripe
String
The magstripe data of a credit card. Magstripe data includes the card number and expiration date. When using this command, xCardNum xExp and xToken should not be used. Encrypted Card data can also be sent using xMagstripe.
xName
String
The cardholder’s name
xTax
String
The tax portion that is included in the total transaction amount (xAmount)
xTip
String
The tip portion that is included in the total transaction amount (xAmount)
xInvoice
String
The merchant’s invoice number for the transaction. xInvoice is recommended when available for improved duplicate handling.
xPONum
String
The merchant’s purchase order number for the transaction
xComments
String
Additional data optionally passed along to the receipt
xDescription
String
Additional data optionally passed along for reporting
xIP
String
The customer’s IP address. Typically used for fraud detection
xEmail
String
The customer’s email address
xFax
String
The customer’s fax number
xBillFirstName
String
The customer’s first name for their billing profile
xBillMiddleName
String
The customer’s middle name or initial for their billing profile
xBillLastName
String
The customer’s last/family name for their billing profile
xBillCompany
String
The customer’s company name for their billing profile
xBillStreet
String
The customer’s street address for their billing profile
xBillStreet2
String
The customer’s street address 2nd line for their billing profile
xBillCity
String
The customer’s city for their billing profile
xBillState
String
The customer’s state for their billing profile
xBillZip
String
The customer’s zip code for their billing profile
xBillCountry
String
The customer’s country for their billing profile
xBillPhone
String
The customer’s phone number for their billing profile
xBillMobile
String
The customer’s mobile number for their billing profile
xShipFirstName
String
The customer’s first name for their shipping profile
xShipMiddleName
String
The customer’s middle name or initial for their shipping profile
xShipLastName
String
The customer’s last/family name for their shipping profile
xShipCompany
String
The customer’s company name for their shipping profile
xShipStreet
String
The customer’s street address for their shipping profile
xShipStreet2
String
The customer’s street address 2nd line for their shipping profile
xShipCity
String
The customer’s city for their shipping profile
xShipState
String
The customer’s state for their shipping profile
xShipZip
String
The customer’s zip code for their shipping profile
xShipCountry
String
The customer’s country for their shipping profile
xShipPhone
String
The customer’s phone number for their shipping profile
xShipMobile
String
The customer’s mobile number for their shipping profile
xAllowDuplicate
String
By default, Sola rejects duplicate transactions within 10 minutes of the original transaction. This command overrides that safeguard. True/False allowed.
xOrderID
String
Unique order number for FraudWatch verification
xExistingCustomer
String
Yes/No value indicating if the customer is a repeat customer
xSoftwareVersion*
String
Version number of your software
xCommand*
String
Sola transaction type
xDUKPT*
String
The DUK/PT key for PIN debit and EBT transactions.The first 16 characters are the encrypted PIN block, followed by the 6 character long Key Set Identifier (KSID). The remaining characters are the PIN pad serial number and transaction counter.
xMagstripe
String
The magstripe data of a credit card. Magstripe data includes the card number and expiration date. When using this command, xCardNum xExp and xToken should not be used. Encrypted card data can also be sent using xMagstripe.
xIP
String
The customer’s IP address. Typically used for fraud detection.
xSoftwareVersion*
String
Version number of your software
xCommand*
String
Sola transaction type
xAmount*
String
The total amount of the transaction, inclusive of tax and tip if applicable. This the total amount of the transaction.
xDUKPT*
String
The DUK/PT key for PIN debit and EBT transactions.The first 16 characters are the encrypted PIN block, followed by the 6 character long Key Set Identifier (KSID). The remaining characters are the PIN Pad serial number and transaction counter.
xVoucherApproval*
String
The EBT voucher approval code
xVoucherSerial*
String
The EBT voucher serial number
xToken
String
The Sola token that references a previously used payment method. When using a token, xCardNum xExp and xMagstripe should not be used.
xCustom01
String
20 custom fields are available for custom data, such as customer comments, etc. Use xCustom01 through xCustom20.
xMagstripe
String
The magstripe data of a credit card. Magstripe data includes the card number and expiration date. When using this command, xCardNum xExp and xToken should not be used. Encrypted Card data can also be sent using xMagstripe.
xName
String
The cardholder’s name
xTax
String
The tax portion that is included in the total transaction amount (xAmount)
xTip
String
The tip portion that is included in the total transaction amount (xAmount)
xInvoice
String
The merchant’s invoice number for the transaction. xInvoice is recommended when available for improved duplicate handling.
xPONum
String
The merchant’s purchase order number for the transaction
xComments
String
Additional data that is optionally passed along to the receipt
xDescription
String
Additional data that is optionally passed along for reporting
xIP
String
The customer’s IP address. Typically used for fraud detection.
xEmail
String
The customer’s email address
xFax
String
The customer’s fax number
xBillFirstName
String
The customer’s first name for their billing profile
xBillMiddleName
String
The customer’s middle name or initial for their billing profile
xBillLastName
String
The customer’s last/family name for their billing profile
xBillCompany
String
The customer’s company name for their billing profile
xBillStreet
String
The customer’s street address for their billing profile
xBillStreet2
String
The customer’s street address 2nd line for their billing profile
xBillCity
String
The customer’s city for their billing profile
xBillState
String
The customer’s state for their billing profile
xBillZip
String
The customer’s zip code for their billing profile
xBillCountry
String
The customer’s country for their billing profile
xBillPhone
String
The customer’s phone number for their billing profile
xBillMobile
String
The customer’s mobile number for their billing profile
xShipFirstName
String
The customer’s first name for their shipping profile
xShipMiddleName
String
The customer’s middle name or initial for their shipping profile
xShipLastName
String
The customer’s last/family name for their shipping profile
xShipCompany
String
The customer’s company name for their shipping profile
xShipStreet
String
The customer’s street address for their shipping profile
xShipStreet2
String
The customer’s street address 2nd line for their shipping profile
xShipCity
String
The customer’s city for their shipping profile
xShipState
String
The customer’s state for their shipping profile
xShipZip
String
The customer’s zip code for their shipping profile
xShipCountry
String
The customer’s country for their shipping profile
xShipPhone
String
The customer’s phone number for their shipping profile
xShipMobile
String
The customer’s mobile number for their shipping profile
xAllowDuplicate
String
By default, Sola rejects duplicate transactions within 10 minutes of the original transaction. This command overrides that safeguard. True/False allowed.
xOrderID
String
Unique order number for FraudWatch verification
xExistingCustomer
String
Yes/No value indicating if the customer is a repeat customer
xSoftwareVersion*
String
Version number of your software
xCommand*
String
Sola transaction type
xAmount*
String
The total amount of the transaction, inclusive of tax and tip if applicable. This the total amount of the transaction.
xDUKPT*
String
The DUK/PT key for PIN debit and EBT transactions.The first 16 characters are the encrypted PIN block, followed by the 6 character long Key Set Identifier (KSID). The remaining characters are the PIN pad serial number and transaction counter.
xToken
String
The Sola token that references a previously used payment method. When using a token, xCardNum xExp and xMagstripe should not be used.
xCustom01
String
20 custom fields are available for custom data, such as customer comments, etc. Use xCustom01 through xCustom20.
xMagstripe
String
The magstripe data of a credit card. Magstripe data includes the card number and expiration date. When using this command, xCardNum xExp and xToken should not be used. Encrypted Card data can also be sent using xMagstripe.
xName
String
The cardholder’s name
xTax
String
The tax portion that is included in the total transaction amount (xAmount).
xTip
String
The tip portion that is included in the total transaction amount (xAmount)
xInvoice
String
The merchant’s invoice number for the transaction. xInvoice is recommended when available for improved duplicate handling
xPONum
String
The merchant’s purchase order number for the transaction
xComments
String
Additional data that is optionally passed along to the receipt
xDescription
String
Additional data that is optionally passed along for reporting
xIP
String
The customer’s IP address. Typically used for fraud detection.
xEmail
String
The customer’s email address
xFax
String
The customer’s fax number
xBillFirstName
String
The customer’s first name for their billing profile
xBillMiddleName
String
The customer’s middle name or initial for their billing profile
xBillLastName
String
The customer’s last/family name for their billing profile
xBillCompany
String
The customer’s company name for their billing profile
xBillStreet
String
The customer’s street address for their billing profile
xBillStreet2
String
The customer’s street address 2nd line for their billing profile
xBillCity
String
The customer’s city for their billing profile
xBillState
String
The customer’s state for their billing profile
xBillZip
String
The customer’s zip code for their billing profile
xBillCountry
String
The customer’s Country for their billing profile
xBillPhone
String
The customer’s phone number for their billing profile
xBillMobile
String
The customer’s mobile number for their billing profile
xShipFirstName
String
The customer’s first name for their shipping profile
xShipMiddleName
String
The customer’s middle name or initial for their shipping profile
xShipLastName
String
The customer’s last/family name for their shipping profile
xShipCompany
String
The customer’s company name for their shipping profile
xShipStreet
String
The customer’s street address for their shipping profile
xShipStreet2
String
The customer’s street address 2nd line for their shipping profile
xShipCity
String
The customer’s city for their shipping profile
xShipState
String
The customer’s state for their shipping profile
xShipZip
String
The customer’s zip code for their shipping profile
xShipCountry
String
The customer’s country for their shipping profile
xShipPhone
String
The customer’s phone number for their shipping profile
xShipMobile
String
The customer’s mobile number for their shipping profile
xAllowDuplicate
String
By default, Sola rejects duplicate transactions within 10 minutes of the original transaction. This command overrides that safeguard. True/False allowed.
xOrderID
String
Unique order number for FraudWatch verification
xExistingCustomer
String
Yes/No value indicating if the customer is a repeat customer
xSoftwareVersion*
String
Version number of your software
xAmount*
String
The total amount of the transaction, inclusive of tax and tip if applicable. This the total amount of the transaction.
xCommand
String
Sola transaction type
xDUKPT
String
The DUK/PT key for PIN debit and EBT transactions.The first 16 characters are the encrypted PIN block, followed by the 6 character long Key Set Identifier (KSID). The remaining characters are the PIN pad serial number and transaction counter.
xMagstripe
String
The magstripe data of a credit card. Magstripe data includes the card number and expiration date. When using this command, xCardNum xExp and xToken should not be used. Encrypted Card data can also be sent using xMagstripe.
xIP
String
The customer’s IP address. Typically used for fraud detection.
xToken
String
The Sola token that references a previously used payment method. When using a token, xCardNum xExp and xMagstripe should not be used.
xCustom01
String
20 custom fields are available for custom data, such as customer comments, etc. Use xCustom01 through xCustom20.
xName
String
The cardholder’s name
xInvoice
String
The merchant’s invoice number for the transaction. xInvoice is recommended when available for improved duplicate handling.
xAllowDuplicate
String
By default, Sola rejects duplicate transactions within 10 minutes of the original transaction. This command overrides that safeguard. True/False allowed.
xSoftwareVersion*
String
Version number of your software
xCommand*
String
Sola transaction type
xDUKPT*
String
The DUK/PT key for PIN debit and EBT transactions.The first 16 characters are the encrypted PIN block, followed by the 6 character long Key Set Identifier (KSID). The remaining characters are the PIN pad serial number and transaction counter.
xMagstripe
String
The magstripe data of a credit card. Magstripe data includes the card number and expiration date. When using this command, xCardNum xExp and xToken should not be used. Encrypted card data can also be sent using xMagstripe.
xIP
String
The customer’s IP address. Typically used for fraud detection.
xSoftwareVersion*
String
Version number of your software
xCommand*
String
Sola transaction type
xAmount*
String
The total amount of the transaction, inclusive of tax and tip if applicable. This the total amount of the transaction.
x1UnitPrice*
String
Unit price for item specified in xUPC. Additional items can be specified by incrementing (i.e., x2UnitPrice, x3UnitPrice, etc.).
x1Qty*
String
Quantity of item specified in xUPC. Additional items can be specified by incrementing (i.e., x2Qty, x3Qty, etc.).
x1Upc*
String
Universal Product Code. Additional items can be specified by incrementing (i.e., x2Upc, x3Upc, etc.).
xDUKPT*
String
The DUK/PT key for PIN debit and EBT transactions.The first 16 characters are the encrypted PIN block, followed by the 6 character long Key Set Identifier (KSID). The remaining characters are the PIN pad serial number and transaction counter.
xAllowPartialAuth*
String
Allows for partial authorization. Must be set to "TRUE".
xToken
String
The Sola token that references a previously used payment method. When using a token, xCardNum and xMagstripe should not be used.
xCustom01
String
20 custom fields are available for custom data, such as customer comments, etc. Use xCustom01 through xCustom20.
xMagstripe
String
The magstripe data of an eWIC card. When using xMagstripe, xCardNum and xToken should not be used. Encrypted card data can also be sent using xMagstripe.
xName
String
The cardholder’s name
xTax
String
The tax portion that is included in the total transaction amount (xAmount)
xTip
String
The tip portion that is included in the total transaction amount (xAmount)
xInvoice
String
The merchant’s invoice number for the transaction. xInvoice is recommended when available for improved duplicate handling.
xPONum
String
The merchant’s purchase order number for the transaction
xComments
String
Additional data that is optionally passed along to the receipt
xDescription
String
Additional data that is optionally passed along for reporting
xIP
String
The customer’s IP address. Typically used for fraud detection.
xEmail
String
The customer’s email address
xFax
String
The customer’s fax number
xBillFirstName
String
The customer’s first name for their billing profile
xBillMiddleName
String
The customer’s middle name for their billing profile
xBillLastName
String
The customer’s last name for their billing profile
xBillCompany
String
The customer’s company name for their billing profile
xBillStreet
String
The customer’s street address for their billing profile
xBillStreet2
String
The customer’s street address 2nd line for their billing profile
xBillCity
String
The customer’s city for their billing profile
xBillState
String
The customer’s state for their billing profile
xBillZip
String
The customer’s zip code for their billing profile
xBillCountry
String
The customer’s country for their billing profile
xBillPhone
String
The customer’s phone number for their billing profile
xBillMobile
String
The customer’s mobile number for their billing profile
xShipFirstName
String
The customer’s first name for their shipping profile
xShipMiddleName
String
The customer’s middle name or initial for their shipping profile
xShipLastName
String
The customer’s last/family name for their shipping profile
xShipCompany
String
The customer’s company name for their shipping profile
xShipStreet
String
The customer’s street address for their shipping profile
xShipStreet2
String
The customer’s street address 2nd line for their shipping profile
xShipCity
String
The customer’s city for their shipping profile
xShipState
String
The customer’s state for their shipping profile
xShipZip
String
The customer’s zip code for their shipping profile
xShipCountry
String
The customer’s country for their shipping profile
xShipPhone
String
The customer’s phone number for their shipping profile
xShipMobile
String
The customer’s mobile number for their shipping profile
xOrderID
String
Unique order number for FraudWatch verification
xExistingCustomer
String
Yes/No value indicating if the customer is a repeat customer
xAllowDuplicate
String
By default, Sola rejects duplicate transactions within 10 minutes of the original transaction. This command overrides that safeguard. True/False allowed.
xSoftwareVersion*
String
Version number of your software
xCommand*
String
Sola transaction type
xDUKPT*
String
The DUK/PT key for PIN debit and EBT transactions.The first 16 characters are the encrypted PIN block, followed by the 6 character long Key Set Identifier (KSID). The remaining characters are the PIN pad serial number and transaction counter.
xMagstripe
String
The magstripe data of a credit card. Magstripe data includes the card number and expiration date. When using this command, xCardNum xExp and xToken should not be used. Encrypted card data can also be sent using xMagstripe
xIP
String
The customer’s IP address. Typically used for fraud detection.
xSoftwareVersion*
String
Version number of your software
xCommand*
String
Sola transaction type
xDUKPT*
String
The DUK/PT key for PIN debit and EBT transactions.The first 16 characters are the encrypted PIN block, followed by the 6 character long Key Set Identifier (KSID). The remaining characters are the PIN pad serial number and transaction counter.
xRefNum*
String
Used to reference a previous transaction when processing a follow-up transaction; typically a refund, void, or capture. (Note: xRefnum can be a 64-bit number and should be stored as BIGINT, Long, Int64 or String).
xMagstripe
String
The magstripe data of a credit card. Magstripe data includes the card number and expiration date. When using this command, xCardNum xExp and xToken should not be used. Encrypted card data can also be sent using xMagstripe
xIP
String
The customer’s IP address. Typically used for fraud detection.
xCardNum*
String
The customer card number. *Alternatively, xToken xMagStripe or SUT can be used.
xKey*
String
Your Sola API key.
xVersion*
String
Gateway API version. The current version is 5.0.0.
xSoftwareName*
String
Name of your software
xCardNum*
String
The customer card number. *Alternatively, xToken xMagStripe or SUT can be used.
xKey*
String
Your Sola API key.
xVersion*
String
Gateway API version. The current version is 5.0.0.
xSoftwareName*
String
Name of your software
xCardNum*
String
The customer card number. *Alternatively, xToken xMagStripe or SUT can be used.
xKey*
String
Your Sola API key.
xVersion*
String
Gateway API version. The current version is 5.0.0.
xSoftwareName*
String
Name of your software
xCardNum*
String
The customer card number. *Alternatively, xToken xMagStripe or SUT can be used.
xKey*
String
Your Sola API key.
xVersion*
String
Gateway API version. The current version is 5.0.0.
xSoftwareName*
String
Name of your software
xCardNum*
String
The customer card number. *Alternatively, xToken xMagStripe or SUT can be used.
xKey*
String
Your Sola API key.
xVersion*
String
Gateway API version. The current version is 5.0.0.
xSoftwareName*
String
Name of your software
xCardNum*
String
The customer card number. *Alternatively, xToken xMagStripe or SUT can be used.
xKey*
String
Your Sola API key.
xVersion*
String
Gateway API version. The current version is 5.0.0.
xSoftwareName*
String
Name of your software
xCardNum*
String
The customer card number. *Alternatively, xToken xMagStripe or SUT can be used.
xKey*
String
Your Sola API key.
xVersion*
String
Gateway API version. The current version is 5.0.0.
xSoftwareName*
String
Name of your software
xCardNum*
String
The customer card number. *Alternatively, xToken, xMagStripe or SUT can be used.
xKey*
String
Your Sola API key.
xVersion*
String
Gateway API version. The current version is 5.0.0.
xSoftwareName*
String
Name of your software
xCardNum*
String
The customer card number. *Alternatively, xToken xMagStripe or SUT can be used.
xKey*
String
Your Sola API key.
xVersion*
String
Gateway API version. The current version is 5.0.0.
xSoftwareName*
String
Name of your software
xCardNum*
String
The customer card number. *Alternatively, xToken xMagStripe or SUT can be used.
xKey*
String
Your Sola API key.
xVersion*
String
Gateway API version. The current version is 5.0.0.
xSoftwareName*
String
Name of your software
{
"xCardNum": "4444333322221111",
"xKey": "[xkeycredentials]",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "ebtfs:sale",
"xAmount": "35.00",
"xToken": "61h72mmh68phn9q233634ph3g54p1499m69qhp4816pn528h84",
"xCustom01": "Register01",
"xDUKPT": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;444433",
"xMagstripe": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;4444333322221111=4912101123456789?",
"xName": "John Doe",
"xTax": "2.00",
"xTip": "2.00",
"xInvoice": "123456A",
"xPONum": "123456B",
"xComments": "This is a comment",
"xDescription": "This is a description",
"xIP": "1.2.3.4",
"xEmail": "[email protected]",
"xFax": "1234567890",
"xBillFirstName": "John",
"xBillMiddleName": "Max",
"xBillLastName": "Doe",
"xBillCompany": "Acme",
"xBillStreet": "123 Any Street",
"xBillStreet2": "Apt 4b",
"xBillCity": "Anytown",
"xBillState": "NY",
"xBillZip": "12345",
"xBillCountry": "USA",
"xBillPhone": "8005551212",
"xBillMobile": "8005551111",
"xShipFirstName": "John",
"xShipMiddleName": "Max",
"xShipLastName": "Doe",
"xShipCompany": "Acme",
"xShipStreet": "123 Any Street",
"xShipStreet2": "Apt 4b",
"xShipCity": "Anytown",
"xShipState": "NY",
"xShipZip": "11111",
"xShipCountry": "USA",
"xShipPhone": "8005551212",
"xShipMobile": "8005551111",
"xOrderID": "12356",
"xExistingCustomer": "TRUE",
"xAllowDuplicate": "TRUE",
"xCustReceipt": "TRUE"
}{
"xCardNum": "4444333322221111",
"xKey": "[xkeycredentials]",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "ebtfs:credit",
"xAmount": "35.00",
"xToken": "61h72mmh68phn9q233634ph3g54p1499m69qhp4816pn528h84",
"xCustom01": "Register01",
"xDUKPT": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;444433",
"xMagstripe": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;4444333322221111=4912101123456789?",
"xName": "John Doe",
"xTax": "2.00",
"xTip": "2.00",
"xInvoice": "123456A",
"xPONum": "123456B",
"xComments": "This is a comment",
"xDescription": "This is a description",
"xIP": "1.2.3.4",
"xEmail": "[email protected]",
"xFax": "1234567890",
"xBillFirstName": "John",
"xBillMiddleName": "Max",
"xBillLastName": "Doe",
"xBillCompany": "Acme",
"xBillStreet": "123 Any Street",
"xBillStreet2": "Apt 4b",
"xBillCity": "Anytown",
"xBillState": "NY",
"xBillZip": "12345",
"xBillCountry": "USA",
"xBillPhone": "8005551212",
"xBillMobile": "8005551111",
"xShipFirstName": "John",
"xShipMiddleName": "Max",
"xShipLastName": "Doe",
"xShipCompany": "Acme",
"xShipStreet": "123 Any Street",
"xShipStreet2": "Apt 4b",
"xShipCity": "Anytown",
"xShipState": "NY",
"xShipZip": "11111",
"xShipCountry": "USA",
"xShipPhone": "8005551212",
"xShipMobile": "8005551111",
"xOrderID": "12356",
"xExistingCustomer": "TRUE",
"xAllowDuplicate": "TRUE"
}{
"xCardNum": "4444333322221111",
"xKey": "[xkeycredentials]",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "ebtfs:balance",
"xDUKPT": "3748276384717382:2dh2298h28dhf982f298g",
"xMagstripe": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;4444333322221111=4912101123456789?",
"xIP": "1.1.1.1"
}{
"xCardNum": "4444333322221111",
"xKey": "[xkeycredentials]",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "ebtfs:voucher",
"xAmount": "35.00",
"xToken": "61h72mmh68phn9q233634ph3g54p1499m69qhp4816pn528h84",
"xCustom01": "Register01",
"xDUKPT": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;444433",
"xVoucherApproval": "123df1248f",
"xVoucherSerial": "123",
"xMagstripe": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;4444333322221111=4912101123456789?",
"xName": "John Doe",
"xTax": "2.00",
"xTip": "2.00",
"xInvoice": "123456A",
"xPONum": "123456B",
"xComments": "This is a comment",
"xDescription": "This is a description",
"xIP": "1.2.3.4",
"xEmail": "[email protected]",
"xFax": "1234567890",
"xBillFirstName": "John",
"xBillMiddleName": "Max",
"xBillLastName": "Doe",
"xBillCompany": "Acme",
"xBillStreet": "123 Any Street",
"xBillStreet2": "Apt 4b",
"xBillCity": "Anytown",
"xBillState": "NY",
"xBillZip": "12345",
"xBillCountry": "USA",
"xBillPhone": "8005551212",
"xBillMobile": "8005551111",
"xShipFirstName": "John",
"xShipMiddleName": "Max",
"xShipLastName": "Doe",
"xShipCompany": "Acme",
"xShipStreet": "123 Any Street",
"xShipStreet2": "Apt 4b",
"xShipCity": "Anytown",
"xShipState": "NY",
"xShipZip": "11111",
"xShipCountry": "USA",
"xShipPhone": "8005551212",
"xShipMobile": "8005551111",
"xOrderID": "12356",
"xExistingCustomer": "TRUE",
"xAllowDuplicate": "TRUE"
}{
"xCardNum": "4444333322221111",
"xKey": "[xkeycredentials]",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "ebtcb:sale"
"xAmount": "35.00",
"xToken": "61h72mmh68phn9q233634ph3g54p1499m69qhp4816pn528h84",
"xCustom01": "Register01",
"xDUKPT": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;444433",
"xMagstripe": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;4444333322221111=4912101123456789?",
"xName": "John Doe",
"xTax": "2.00",
"xTip": "2.00",
"xInvoice": "123456A",
"xPONum": "123456B",
"xComments": "This is a comment",
"xDescription": "This is a description",
"xIP": "1.2.3.4",
"xEmail": "[email protected]",
"xFax": "1234567890",
"xBillFirstName": "John",
"xBillMiddleName": "Max",
"xBillLastName": "Doe",
"xBillCompany": "Acme",
"xBillStreet": "123 Any Street",
"xBillStreet2": "Apt 4b",
"xBillCity": "Anytown",
"xBillState": "NY",
"xBillZip": "12345",
"xBillCountry": "USA",
"xBillPhone": "8005551212",
"xBillMobile": "8005551111",
"xShipFirstName": "John",
"xShipMiddleName": "Max",
"xShipLastName": "Doe",
"xShipCompany": "Acme",
"xShipStreet": "123 Any Street",
"xShipStreet2": "Apt 4b",
"xShipCity": "Anytown",
"xShipState": "NY",
"xShipZip": "11111",
"xShipCountry": "USA",
"xShipPhone": "8005551212",
"xShipMobile": "8005551111",
"xOrderID": "12356",
"xExistingCustomer": "TRUE",
"xAllowDuplicate": "TRUE"
}{
"xCardNum": "4444333322221111",
"xKey": "[xkeycredentials]",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "ebtcb:cash",
"xAmount": "35.00",
"xToken": "61h72mmh68phn9q233634ph3g54p1499m69qhp4816pn528h84",
"xCustom01": "Register01",
"xDUKPT": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;444433",
"xMagstripe": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;4444333322221111=4912101123456789?",
"xName": "John Doe",
"xInvoice": "123456A",
"xIP": "1.2.3.4",
"xAllowDuplicate": "TRUE"
}{
"xCardNum": "4444333322221111",
"xKey": "[xkeycredentials]",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "ebtcb:balance",
"xDUKPT": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;444433",
"xMagstripe": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;4444333322221111=4912101123456789?",
"xIP": "1.2.3.4"
}{
"xCardNum": "4444333322221111",
"xKey": "[xkeycredentials]",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "ebtw:sale"
"xAmount": "35.00",
"x1UnitPrice": "3.50",
"x1Qty": "10",
"1Upc": "075457026002",
"xToken": "61h72mmh68phn9q233634ph3g54p1499m69qhp4816pn528h84",
"xCustom01": "Register01",
"xDUKPT": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;444433",
"xAllowPartialAuth": "TRUE",
"xMagstripe": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;4444333322221111=4912101123456789?",
"xName": "John Doe",
"xTax": "2.00",
"xTip": "2.00",
"xInvoice": "123456A",
"xPONum": "123456B",
"xComments": "This is a comment",
"xDescription": "This is a description",
"xIP": "1.2.3.4",
"xEmail": "[email protected]",
"xFax": "1234567890",
"xBillFirstName": "John",
"xBillMiddleName": "Max",
"xBillLastName": "Doe",
"xBillCompany": "Acme",
"xBillStreet": "123 Any Street",
"xBillStreet2": "Apt 4b",
"xBillCity": "Anytown",
"xBillState": "NY",
"xBillZip": "12345",
"xBillCountry": "USA",
"xBillPhone": "8005551212",
"xBillMobile": "8005551111",
"xShipFirstName": "John",
"xShipMiddleName": "Max",
"xShipLastName": "Doe",
"xShipCompany": "Acme",
"xShipStreet": "123 Any Street",
"xShipStreet2": "Apt 4b",
"xShipCity": "Anytown",
"xShipState": "NY",
"xShipZip": "11111",
"xShipCountry": "USA",
"xShipPhone": "8005551212",
"xShipMobile": "8005551111",
"xOrderID": "12356",
"xExistingCustomer": "TRUE",
"xAllowDuplicate": "TRUE"
}{
"xCardNum": "4444333322221111",
"xKey": "[xkeycredentials]",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "ebtw:balance",
"xDUKPT": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;444433",
"xMagstripe": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;4444333322221111=4912101123456789?",
"xIP": "1.2.3.4"
}{
"xCardNum": "4444333322221111",
"xKey": "[xkeycredentials]",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "ebtw.void",
"xDUKPT": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;444433",
"xRefNum": "81726356",
"xMagstripe": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;4444333322221111=4912101123456789?",
"xIP": "1.1.1.1"
}