# Nexio Documentation > The Nexio developer portal provides all the information you need to get your site up and running so you can start making money! ## Guides - [Getting started overview](https://docs.nexiopay.com/docs/overview.md) - [Developer portal introduction](https://docs.nexiopay.com/docs/developer-portal-introduction.md) - [Quick start](https://docs.nexiopay.com/docs/quick-start.md) - [Integrated login](https://docs.nexiopay.com/docs/integrated-login.md) - [Authentication](https://docs.nexiopay.com/docs/authentication.md) - [Your first request](https://docs.nexiopay.com/docs/your-first-request.md) - [Making a Hello (payment) World request](https://docs.nexiopay.com/docs/making-a-hello-payment-world-request.md) - [Next tasks](https://docs.nexiopay.com/docs/next-tasks.md) - [Features](https://docs.nexiopay.com/docs/products.md) - [Prevent](https://docs.nexiopay.com/docs/prevent.md) - [API diagrams](https://docs.nexiopay.com/docs/api-diagrams.md) - [Connections](https://docs.nexiopay.com/docs/connections.md) - [ACI integration guide](https://docs.nexiopay.com/docs/aci-integration-guide.md) - [Authorize.net integration guide](https://docs.nexiopay.com/docs/authorizenet-integration-guide.md) - [Checkout.com integration guide](https://docs.nexiopay.com/docs/checkoutcom-integration-guide.md) - [Cybersource integration guide](https://docs.nexiopay.com/docs/cybersource-integration-guide.md) - [Fortis (Zeamster) integration guide](https://docs.nexiopay.com/docs/fortis-zeamster-integration-guide.md) - [Nexio mock gateway integration guide](https://docs.nexiopay.com/docs/nexio-mock-gateway-integration-guide.md) - [NMI integration guide](https://docs.nexiopay.com/docs/nmi-integration-guide.md) - [Openpay integration guide](https://docs.nexiopay.com/docs/openpay-integration-guide.md) - [PayU Asia Pacific (via PaymentsOS) integration guide](https://docs.nexiopay.com/docs/payu-asia-pacific-via-paymentsos-integration-guide.md) - [PayU iyzico (via PaymentsOS) integration guide](https://docs.nexiopay.com/docs/payu-iyzico-via-paymentsos-integration-guide.md) - [ProPay integration guide](https://docs.nexiopay.com/docs/propay-integration-guide.md) - [Stripe integration guide](https://docs.nexiopay.com/docs/stripe-integration-guide.md) - [USAePay integration guide](https://docs.nexiopay.com/docs/usaepay-integration-guide.md) - [Payment methods](https://docs.nexiopay.com/docs/payment-methods.md) - [Afterpay through Citcon integration guide](https://docs.nexiopay.com/docs/citcon-through-afterpay-integration-guide.md) - [Apple Pay integration guide](https://docs.nexiopay.com/docs/apple-pay-integration-guide.md) - [Google Pay integration guide](https://docs.nexiopay.com/docs/google-pay-integration-guide.md) - [Klarna integration guide](https://docs.nexiopay.com/docs/klarna-integration-guide.md) - [Paynet integration guide](https://docs.nexiopay.com/docs/paynet-integration-guide.md) - [PayPal integration guide](https://docs.nexiopay.com/docs/paypal-integration-guide.md) - [PayPal (with Braintree) integration guide](https://docs.nexiopay.com/docs/paypal-with-braintree-integration-guide.md) - [Sofort integration guide](https://docs.nexiopay.com/docs/sofort-integration-guide.md) - [Getting started with ecommerce](https://docs.nexiopay.com/docs/getting-started-with-ecommerce.md) - [Product pages for ecommerce](https://docs.nexiopay.com/docs/product-pages-for-ecommerce.md) - [Creating a product page for local currency and prices](https://docs.nexiopay.com/docs/creating-a-product-page-for-local-currency-and-prices.md) - [Save payment information pages for ecommerce](https://docs.nexiopay.com/docs/save-payment-information-pages-for-ecommerce.md) - [Creating a save card page with the iframe](https://docs.nexiopay.com/docs/creating-a-save-card-page-with-the-iframe.md) - [Creating a save card page with your own form](https://docs.nexiopay.com/docs/creating-a-save-card-page-with-your-own-form.md) - [Saving a card token with the API](https://docs.nexiopay.com/docs/saving-a-card-token-with-the-api.md) - [Creating a save echeck page with the iframe](https://docs.nexiopay.com/docs/creating-a-save-echeck-page-with-the-iframe.md) - [Creating a save echeck page with your own form](https://docs.nexiopay.com/docs/creating-a-save-echeck-page-with-your-own-form.md) - [Saving an echeck token with the API](https://docs.nexiopay.com/docs/saving-an-echeck-token-with-the-api.md) - [Checkout and transaction pages for ecommerce](https://docs.nexiopay.com/docs/checkout-and-transaction-pages-for-ecommerce.md) - [Creating a card checkout page with the iframe](https://docs.nexiopay.com/docs/creating-a-card-checkout-page-with-the-iframe.md) - [Creating a card checkout page with your own form](https://docs.nexiopay.com/docs/creating-a-card-checkout-page-with-your-own-form.md) - [Running a card transaction using full card information](https://docs.nexiopay.com/docs/running-a-card-transaction-using-raw-card-information.md) - [Running a card transaction with the API](https://docs.nexiopay.com/docs/running-a-card-transaction-with-the-api.md) - [Creating an echeck checkout page with the iframe](https://docs.nexiopay.com/docs/creating-an-echeck-checkout-page-with-the-iframe.md) - [Creating an echeck checkout page with your own form](https://docs.nexiopay.com/docs/creating-an-echeck-checkout-page-with-your-own-form.md) - [Running an echeck transaction with the API](https://docs.nexiopay.com/docs/running-an-echeck-transaction-with-the-api.md) - [Getting started with retail](https://docs.nexiopay.com/docs/getting-started-with-retail.md) - [Customizing the retail iframe](https://docs.nexiopay.com/docs/customizing-the-retail-iframe.md) - [Using simple login for authentication](https://docs.nexiopay.com/docs/using-simple-login-for-authentication.md) - [Creating a save card page with the retail iframe](https://docs.nexiopay.com/docs/creating-a-retail-card-page-with-the-iframe.md) - [Running a keyed transaction with the iframe](https://docs.nexiopay.com/docs/running-a-keyed-transaction-with-the-iframe.md) - [Configuring your terminal for USAePay](https://docs.nexiopay.com/docs/configuring-your-terminal-for-usaepay.md) - [Configuring your terminal for NMI](https://docs.nexiopay.com/docs/configuring-your-terminal-for-nmi.md) - [Registering and deregistering terminals](https://docs.nexiopay.com/docs/registering-and-deregistering-terminals.md) - [Processing a transaction with a terminal](https://docs.nexiopay.com/docs/processing-a-transaction-with-a-terminal.md) - [Sending lodging data with the iframe](https://docs.nexiopay.com/docs/sending-lodging-data-with-the-iframe.md) - [Sending lodging data with your own form](https://docs.nexiopay.com/docs/sending-lodging-data-with-your-own-form.md) - [Sending lodging data with the API](https://docs.nexiopay.com/docs/sending-lodging-data-with-the-api.md) - [APM overview](https://docs.nexiopay.com/docs/apm-overview.md) - [Choosing an APM](https://docs.nexiopay.com/docs/choosing-an-apm.md) - [Configuring APMs](https://docs.nexiopay.com/docs/configuring-apms.md) - [Supported transaction types for APMs](https://docs.nexiopay.com/docs/supported-transaction-types-for-apms.md) - [Supported integration methods for APMs](https://docs.nexiopay.com/docs/supported-integration-methods-for-apms.md) - [Supported currencies for APMs](https://docs.nexiopay.com/docs/supported-currencies-for-apms.md) - [Common required parameters](https://docs.nexiopay.com/docs/common-required-parameters.md) - [Supported legacy webhooks for APM transactions](https://docs.nexiopay.com/docs/supported-webhooks-for-apm-transactions.md) - [Transaction types overview](https://docs.nexiopay.com/docs/transaction-types-overview.md) - [Run a sale transaction](https://docs.nexiopay.com/docs/run-a-sale-transaction.md) - [Multi Iframe (Express APM)](https://docs.nexiopay.com/docs/multi-iframe-express-apm.md) - [Individual Iframe (Button URLs)](https://docs.nexiopay.com/docs/individual-iframe-button-urls.md) - [Custom Redirect (Redirect URLs)](https://docs.nexiopay.com/docs/custom-redirect-redirect-urls.md) - [Custom DIV for Google Pay](https://docs.nexiopay.com/docs/custom-div-for-google-pay.md) - [Pay Later messaging](https://docs.nexiopay.com/docs/pay-later-messaging.md) - [Other APM transactions](https://docs.nexiopay.com/docs/other-apm-transactions.md) - [Run an auth only transaction](https://docs.nexiopay.com/docs/run-an-auth-only-transaction.md) - [Run a merchant-initiated recurring transaction](https://docs.nexiopay.com/docs/run-a-merchant-initiated-recurring-transaction.md) - [Capture an auth-only APM transaction](https://docs.nexiopay.com/docs/capture-an-auth-only-apm-transaction.md) - [Void an APM transaction](https://docs.nexiopay.com/docs/void-an-apm-transaction.md) - [Refund a transaction](https://docs.nexiopay.com/docs/refund-a-transaction.md) - [Spendback overview](https://docs.nexiopay.com/docs/spendback-overview.md) - [Setting up payment routing by target allocation](https://docs.nexiopay.com/docs/setting-up-payment-routing-by-target-allocation.md) - [Setting up payment routing by item](https://docs.nexiopay.com/docs/setting-up-payment-routing-by-item.md) - [How do I use both item routing and target allocation together?](https://docs.nexiopay.com/docs/how-do-i-use-both-item-routing-and-target-allocation-together.md) - [3D Secure overview](https://docs.nexiopay.com/docs/3d-secure-1.md) - [3DS requirements](https://docs.nexiopay.com/docs/3ds-requirements.md) - [Using 3DS to run transactions](https://docs.nexiopay.com/docs/using-3ds-to-run-transactions.md) - [Using a third-party 3DS provider to run transactions](https://docs.nexiopay.com/docs/using-a-third-party-3ds-provider-to-run-transactions.md) - [Troubleshooting asynchronous transactions](https://docs.nexiopay.com/docs/troubleshooting-asynchronous-transactions.md) - [Address Verification Service (AVS)](https://docs.nexiopay.com/docs/address-verification-service-avs.md) - [Enabling the Address Verification Service](https://docs.nexiopay.com/docs/enabling-the-address-verification-service.md) - [Understanding the AVS response](https://docs.nexiopay.com/docs/understanding-the-avs-response.md) - [Using device fingerprinting in the save card flow with an iframe](https://docs.nexiopay.com/docs/using-device-fingerprinting-in-the-save-card-flow-with-an-iframe.md) - [Using device fingerprinting in the save card flow with your own form](https://docs.nexiopay.com/docs/using-device-fingerprinting-in-the-save-card-flow-with-your-own-form.md) - [Using device fingerprinting in the run transaction flow with an iframe](https://docs.nexiopay.com/docs/using-device-fingerprinting-in-the-run-transaction-flow-with-an-iframe.md) - [Using device fingerprinting in the run transaction flow with your own form](https://docs.nexiopay.com/docs/using-device-fingerprinting-in-the-run-transaction-flow-with-your-own-form.md) - [Enabling Kount verification with the iframe](https://docs.nexiopay.com/docs/enabling-kount-verification-with-the-iframe.md) - [Enabling Kount verification with your own form](https://docs.nexiopay.com/docs/enabling-kount-verification-with-your-own-form.md) - [Enabling Kount verification with the API](https://docs.nexiopay.com/docs/enabling-kount-verification-with-the-api.md) - [Understanding the Kount response](https://docs.nexiopay.com/docs/understanding-the-kount-response.md) - [Security code verification](https://docs.nexiopay.com/docs/security-code-verification.md) - [Enabling security code verification with the iframe](https://docs.nexiopay.com/docs/enabling-security-code-verification-with-the-iframe.md) - [Enabling security code verification with your own form](https://docs.nexiopay.com/docs/enabling-security-code-verification-with-your-own-form.md) - [Enabling security code verification with the API](https://docs.nexiopay.com/docs/enabling-security-code-verification-with-the-api.md) - [Understanding the security code verification response](https://docs.nexiopay.com/docs/understanding-the-security-code-verification-response.md) - [Decline recovery overview](https://docs.nexiopay.com/docs/decline-recovery-overview.md) - [Running API card transactions with decline recovery](https://docs.nexiopay.com/docs/running-api-card-transactions-with-decline-recovery.md) - [Running subscription transactions with decline recovery](https://docs.nexiopay.com/docs/running-subscription-transactions-with-decline-recovery.md) - [Retrieving transaction list from decline recovery](https://docs.nexiopay.com/docs/retrieving-transaction-list-from-decline-recovery.md) - [Cancel retries when using the decline recovery feature](https://docs.nexiopay.com/docs/cancel-retries-when-using-the-decline-recovery-service.md) - [Tagging an existing card for sending to Account Updater provider](https://docs.nexiopay.com/docs/tagging-an-existing-card-for-registration.md) - [Tagging an existing card to remove from Account Updater provider](https://docs.nexiopay.com/docs/tagging-an-existing-card-for-de-registration.md) - [Tagging a new card for exclusion](https://docs.nexiopay.com/docs/tagging-a-new-card-for-exclusion.md) - [Recurring billing overview](https://docs.nexiopay.com/docs/recurring-billing-overview.md) - [Getting started with subscriptions](https://docs.nexiopay.com/docs/getting-started-with-subscriptions.md) - [Creating a Nexio-scheduled card subscription](https://docs.nexiopay.com/docs/creating-a-subscription.md) - [Using pay later option for subscription](https://docs.nexiopay.com/docs/using-pay-later-option-for-subscription.md) - [Running merchant-initiated transactions for a subscription](https://docs.nexiopay.com/docs/running-merchant-initiated-transactions-for-a-subscription.md) - [Setting up installments for a bank to handle the subscription](https://docs.nexiopay.com/docs/setting-up-installments-for-a-bank-to-handle-the-subscription.md) - [Getting started with payment plans](https://docs.nexiopay.com/docs/getting-started-with-pay-plans.md) - [Creating a Nexio-scheduled card payment plan](https://docs.nexiopay.com/docs/creating-a-pay-plan.md) - [Using pay later option for payment plan](https://docs.nexiopay.com/docs/using-pay-later-option-for-payment-plan.md) - [Running merchant-initiated transactions for a payment plan](https://docs.nexiopay.com/docs/running-merchant-initiated-transactions-for-a-payment-plan.md) - [Setting up installments for a bank to handle the payment plan](https://docs.nexiopay.com/docs/setting-up-installments-for-a-bank-to-handle-the-payment-plan.md) - [Developer tools overview](https://docs.nexiopay.com/docs/developer-tools.md) - [Displaying translated or customized labels](https://docs.nexiopay.com/docs/displaying-translated-or-customized-labels.md) - [Customizing iframe labels](https://docs.nexiopay.com/docs/customizing-iframe-labels.md) - [Specifying your own CSS file](https://docs.nexiopay.com/docs/specifying-your-own-css-file.md) - [Creating your own CSS file for an iframe](https://docs.nexiopay.com/docs/creating-your-own-css-file-for-an-iframe.md) - [Customizing iframe form elements](https://docs.nexiopay.com/docs/customizing-iframe-form-elements.md) - [Finding a transaction](https://docs.nexiopay.com/docs/finding-a-transaction.md) - [Filtering using query parameters](https://docs.nexiopay.com/docs/filtering-using-query-parameters.md) - [What data is saved with tokens?](https://docs.nexiopay.com/docs/what-data-is-saved-with-tokens.md) - [Common errors](https://docs.nexiopay.com/docs/common-errors.md) - [Registering webhooks](https://docs.nexiopay.com/docs/registering-webhooks.md) - [Receiving webhooks](https://docs.nexiopay.com/docs/receiving-webhooks.md) - [Webhook body examples](https://docs.nexiopay.com/docs/webhook-body-examples.md) - [Legacy webhooks and event types](https://docs.nexiopay.com/docs/legacy-webhooks-and-event-types.md) - [Configuring legacy webhooks](https://docs.nexiopay.com/docs/configuring-legacy-webhooks.md) - [Receiving legacy webhooks](https://docs.nexiopay.com/docs/receiving-legacy-webhooks.md) - [Deregistering legacy webhooks](https://docs.nexiopay.com/docs/deregistering-legacy-webhooks.md) - [Iframe events](https://docs.nexiopay.com/docs/iframe-events.md) - [Constant ACH transaction values](https://docs.nexiopay.com/docs/constant-ach-transaction-values.md) - [Constant transaction values](https://docs.nexiopay.com/docs/constant-transaction-values.md) - [Test cards](https://docs.nexiopay.com/docs/test-cards.md) - [Error codes](https://docs.nexiopay.com/docs/error-codes.md) - [Glossary](https://docs.nexiopay.com/docs/glossary.md) ## API Reference - [API Reference](https://docs.nexiopay.com/reference/api-reference.md) - [Create one-time-use token](https://docs.nexiopay.com/reference/createonetimeusetoken.md): Use this endpoint to generate a temporary token prior to loading an ecommerce iframe. The available and required parameters differ based on the iframe to be loaded. See the dropdown below to determinee which parameters are available and required for each iframe. All processing options and UI options for your iframes must be sent in the body of this request. If you want to have the system pre-fill an iframe form, you must include that data (for example, card or customer information) in the request for this endpoint. Any parameter included here will be overwritten if the same parameter is included in the iframeโ€™s event body. For more information about the parameters that continue from the one-time-use token to the saved card token and beyond, see [What data is saved with tokens?](doc:what-data-is-saved-with-tokens) in Guides. > ๐Ÿ“˜ Note > > Once a token has been used to submit an iframe it cannot be used to load another. You must request a new one-time-use token prior to submitting each iframe. > โš ๏ธ Try It > > To use the Try It feature for this endpoint, you can use the credentials for your [Sandbox API user](doc:sandbox-environments).

You can also use the following test account. Copy the value and paste it into the appropriate space in the Try It section to the right. > username: `docs@nexiopay.com` > password: `JZdzoXpdDeH6VA`

Include any other parameters that you need for the body of the request, depending on what you are using the one-time-use token for.
## Request parameters - bank - bank.accountHolderName - bank.routingNumber - card - card.businessNumber - card.cardHolderName - card.cardType - card.classification - card.expirationMonth - card.expirationYear - card.password - data - data.allowedCardTypes - data.amount - data.currency - data.customer - data.customer.customerRef - data.customer.orderNumber - data.customer.orderDate - data.customer.invoice - data.customer.firstName - data.customer.lastName - data.customer.birthDate - data.customer.nationalIdentificationNumber - data.customer.billToAddressOne - data.customer.billToAddressTwo - data.customer.billToCity - data.customer.billToCountry - data.customer.billToPhone - data.customer.billToPostal - data.customer.billToState - data.customer.birthDate - data.customer.createdAtDate - data.customer.email - data.customer.phone - data.customer.shipToAddressOne - data.customer.shipToAddressTwo - data.customer.shipToCity - data.customer.shipToCountry - data.customer.shipToPhone - data.customer.shipToPostal - data.customer.shipToState - data.customFields - data.customFields.exampleKey - data.description - data.descriptor - data.descriptor.name - data.descriptor.address - data.descriptor.city - data.descriptor.state - data.descriptor.postal - data.descriptor.country - data.descriptor.phone - data.descriptor.url - data.descriptor.merchantId - data.descriptor.mcc - data.lodging - data.lodging.advanceDeposit - data.lodging.checkInDate - data.lodging.checkOutDate - data.lodging.noShow - data.lodging.roomNumber - data.lodging.roomRate - data.surcharge - installment - installment.period - isAuthOnly - processingOptions - processingOptions.checkFraud - processingOptions.verboseResponse - processingOptions.verifyAvs - processingOptions.verifyCvc - processingOptions.customerRedirectUrl - processingOptions.merchantId - processingOptions.paymentOptionTag - processingOptions.saveCardToken - processingOptions.shouldUseFingerprint - shouldUpdateCard - uiOptions - uiOptions.css - uiOptions.customTextUrl - uiOptions.displaySubmitButton - uiOptions.hideBilling - uiOptions.hideBilling.hideAddressOne - uiOptions.hideBilling.hideAddressTwo - uiOptions.hideBilling.hideCity - uiOptions.hideBilling.hideCountry - uiOptions.hideBilling.hidePostal - uiOptions.hideBilling.hidePhone - uiOptions.hideBilling.hideState - uiOptions.hideCvc - uiOptions.limitCountriesTo - uiOptions.requireCvc - uiOptions.forceExpirationSelection ## Response parameters - expiration - fraudUrlc - token
- [Save card token with iframe](https://docs.nexiopay.com/reference/savecardtokeniframe.md): Returns an iframe that can be used to securely save a token for a credit or debit card. You can later use this card token to run a card transaction using the [Run card transaction with iframe](ref:runcardtransactioniframe) or [Run card transaction](ref:runcardtransaction) endpoint. Card tokens can be used to process transactions through any MID on your account. They are not restricted to a specific merchant account or currency. For instructions on how to implement this endpoint, see the recipes (listed below) or see [Creating a save card page with the iframe](doc:creating-a-save-card-page-with-the-iframe). For a tutorial about running a transaction with the saved card token, see the [Creating a card checkout page with the iframe](doc:creating-a-card-checkout-page-with-the-iframe), [Creating a card checkout page with your own form](doc:creating-a-card-checkout-page-with-your-own-form), or [Running a card transaction with the API](doc:running-a-card-transaction-with-the-api) topic. > โš ๏ธ Try It > > To use the Try It feature for this endpoint, you must first request a [one-time-use token](ref:createonetimeusetoken). The system uses the processing and UI options sent in that request for the display and functionality of the iframe.
## Request parameters - shouldReturnHtml - token ## Response parameters - HTML form
- [Save card token](https://docs.nexiopay.com/reference/savecardtoken.md): Allows you to securely save a card token [using your own form](doc:creating-a-save-card-page-with-your-own-form) or [using the API directly](doc:saving-a-card-token-with-the-api) (potentially without a web browser). You can use this endpoint to save a new card token or add pre-existing TokenEx tokens that you would like to start using through Nexio. You can use this saved card token to run a card transaction using the [Run card transaction with iframe](ref:runcardtransactioniframe) or [Run card transaction](ref:runcardtransaction) endpoint. Card tokens can be used to process transactions through any MID on your account. They are not restricted to a specific merchant account or currency. For instructions on how to implement this endpoint, see [Creating a save card page with your own form](doc:creating-a-save-card-page-with-your-own-form) or [Saving a card token with the API](doc:saving-a-card-token-with-the-api). For a tutorial about running a transaction with the saved card token, see the [Creating a card checkout page with the iframe](doc:creating-a-card-checkout-page-with-the-iframe), [Creating a card checkout page with your own form](doc:creating-a-card-checkout-page-with-your-own-form), or [Running a card transaction with the API](doc:running-a-card-transaction-with-the-api) topic. > ๐Ÿ“˜ Note > > Processing options must be sent in the request for a [one-time-use token](ref:createonetimeusetoken). For more information, see [What data is saved with tokens?](doc:what-data-is-saved-with-tokens) in Guides. > โš ๏ธ Try It > > To use the Try It feature for this endpoint, include at least the following in the body of the request: > - A [one-time-use token](ref:createonetimeusetoken) - this replaces the standard username/password and authentication header > - `card.cardHolderName` > - `card.expirationMonth` > - `card.expirationYear` > - Either `card.encryptedNumber` or `tokenex.token` (an existing TokenEx card token) > For information about test card numbers and values you can use, see the documentation for the specific [gateway/connection integration guide](doc:connections) or, if you are testing Account Updater, see the [Test cards for account updater](doc:checking-a-cards-enrollment-tag#test-cards-for-account-updater) section of the "Checking a card's enrollment tag" topic.
## Request parameters - card - card.cardHolderName - card.encryptedNumber - card.expirationMonth - card.expirationYear - card.cardType - card.securityCode - card.firstSix - card.lastFour - token - data - data.customer - data.customer.billToAddressOne - data.customer.billToAddressTwo - data.customer.billToCity - data.customer.billToCountry - data.customer.billToPhone - data.customer.billToPostal - data.customer.billToState - data.customer.birthDate - data.customer.createdAtDate - data.customer.email - data.customer.firstName - data.customer.invoice - data.customer.lastName - data.customer.phone - data.customer.shipToAddressOne - data.customer.shipToAddressTwo - data.customer.shipToCity - data.customer.shipToCountry - data.customer.shipToPhone - data.customer.shipToPostal - data.customer.shipToState - shouldUpdateCard - tokenex - tokenex.token - tokenex.firstSix - tokenex.lastFour - merchantId ## Response parameters - card - card.cardHolderName - card.expirationMonth - card.expirationYear - card.cardType - data - data.customer - data.customer.billToAddressOne - data.customer.billToAddressTwo - data.customer.billToCity - data.customer.billToCountry - data.customer.billToPhone - data.customer.billToPostal - data.customer.billToState - data.customer.birthDate - data.customer.email - data.customer.firstName - data.customer.lastName - data.customer.phone - data.customer.shipToAddressOne - data.customer.shipToAddressTwo - data.customer.shipToCity - data.customer.shipToCountry - data.customer.shipToPhone - data.customer.shipToPostal - data.customer.shipToState - kountResponse - kountResponse.status - kountResponse.rules - merchantId - shouldUpdateCard - token - token.token - token.firstSix - token.lastFour - token.cardType - cvcResults - cvcResults.matchCvv - cvcResults.error - cvcResults.gatewayMessage - cvcResults.gatewayMessage.cvvresponse - cvcResults.gatewayMessage.message - avsResults - avsResults.matchAddress - avsResults.matchPostal - avsResults.error - avsResults.gatewayMessage - avsResults.gatewayMessage.avsresponse - avsResults.gatewayMessage.message - cardType
- [View surcharge recommendation](https://docs.nexiopay.com/reference/viewsurchargerecommendation.md): Allows you to get a surcharge recommendation for a transaction based on the customer's billing state and information about the payment. The response provides information about whether surcharging is recommended or what restrictions apply for surcharging with the transaction. If the saved card token includes `data.customer.billToState`, you only need to include that token in the request. Otherwise, you must explicitly include `data.customer.billToState` and just one of the following parameters: - `card.firstSix` - `card.pan` - `tokenex.token` - `tokenex.firstSix` > ๐Ÿ“˜ Note > > In order to use this endpoint, the Surcharging feature must be enabled for the account and the new agreement must be accepted (which displays upon logging into the [Dashboard](https://dashboard.nexiopaysandbox.com/)). > โš ๏ธ Try It > > To use the Try It feature for this endpoint, you must use the credentials for your [Sandbox API user](doc:sandbox-environments). > > If the saved card token includes `data.customer.billToState`, you only need to include that token in the request. Otherwise, you must include `data.customer.billToState` plus just one of the following parameters: `card.firstSix`, `card.pan`, `tokenex.token`, or `tokenex.firstSix`.
## Request parameters - data - data.amount - data.surcharge - data.currency - data.allowedCardTypes - data.cart - data.cart.items - data.cart.items.item - data.cart.items.description - data.cart.items.quantity - data.cart.items.price - data.cart.items.type - data.customer - data.customer.customerRef - data.customer.orderNumber - data.customer.orderDate - data.customer.invoice - data.customer.firstName - data.customer.lastName - data.customer.birthDate - data.customer.nationalIdentificationNumber - data.customer.billToAddressOne - data.customer.billToAddressTwo - data.customer.billToCity - data.customer.billToCountry - data.customer.billToPhone - data.customer.billToPostal - data.customer.billToState - data.customer.createdAtDate - data.customer.email - data.customer.phone - data.customer.shipToAddressOne - data.customer.shipToAddressTwo - data.customer.shipToCity - data.customer.shipToCountry - data.customer.shipToPhone - data.customer.shipToPostal - data.customer.shipToState - data.customFields - data.customFields.exampleKey - data.description - data.descriptor - data.descriptor.name - data.descriptor.address - data.descriptor.city - data.descriptor.state - data.descriptor.postal - data.descriptor.country - data.descriptor.phone - data.descriptor.url - data.descriptor.merchantId - data.descriptor.mcc - data.lodging - data.lodging.advanceDeposit - data.lodging.checkInDate - data.lodging.checkOutDate - data.lodging.noShow - data.lodging.roomNumber - data.lodging.roomRate - paymentMethod - tokenex - tokenex.token - tokenex.firstSix - tokenex.lastFour - card - card.cardType - card.cardHolderName - card.encryptedNumber - card.expirationMonth - card.expirationYear - card.securityCode - card.firstSix - card.lastFour - card.classification - card.businessNumber - card.password - card.pan - card.expirationMonth - card.expirationYear - tokenex.token - tokenex.firstSix - recurringId - shouldUpdateCard - merchantId - processingOptions - processingOptions.merchantId - processingOptions.check3ds - processingOptions.paymentType - processingOptions.customerRedirectUrl - processingOptions.checkFraud - processingOptions.paymentOptionTag - processingOptions.retryOnSoftDecline - processingOptions.shouldUseFingerprint - processingOptions.verboseResponse - clientIp - isAuthOnly - installment - installment.period - external3ds - external3ds.eci - external3ds.cavv - external3ds.xid - external3ds.version ## Response parameters - surchargeAllowed - cardType - message
- [Run card transaction with iframe](https://docs.nexiopay.com/reference/runcardtransactioniframe.md): Returns an iframe that can be used to securely run a credit or debit card transaction. For instructions on how to implement this endpoint, see the [Creating a card checkout page with the iframe](doc:creating-a-card-checkout-page-with-the-iframe) topic. > โš ๏ธ Try It > > To use the Try It feature for this endpoint, you must first request a [one-time-use token](ref:createonetimeusetoken). The system uses the processing and UI options sent in the request for the creation of the one-time-use or saved card token in the display and functionality of the iframe.
## Request parameters - shouldReturnHtml - token ## Response parameters - HTML form
- [Run card transaction](https://docs.nexiopay.com/reference/runcardtransaction.md): Allows you to process a card transaction in any of the following situations: - An initial transaction that uses a saved card token. - An initial transaction that uses the full (raw) card information (where supported). - A subsequent transaction that uses a saved card token. - A subsequent transaction that uses the full (raw) card information (where supported). - A subsequent transaction that uses a saved terminal token. For more information about how to implement this endpoint, see the recipes (listed below) or the [Creating a card checkout page with your own form](doc:creating-a-card-checkout-page-with-your-own-form), [Running a card transaction using full card information](doc:running-a-card-transaction-using-raw-card-information), or [Running a card transaction with the API](doc:running-a-card-transaction-with-the-api) topic. Aside from the fields marked required here, the gateway you are using may require additional fields. For information on gateway-specific required fields, see the [Connections](doc:connections) documentation. For the 3DS workflow, the system returns a `redirectUrl` instead of the standard response, along with an `asyncTraceId` that you can use with the [View transaction async status](ref:viewtransactionasyncstatus) endpoint for tracking progress and status. For a tutorial, see [Using 3DS to run transactions](doc:using-3ds-to-run-transactions). > ๐Ÿ›‘ Important > > Parameters passed with a process request override any data points that are saved with the card token. > > For example, if the value for `data.customer.billToAddressOne` is saved with the card token as `729 Jay Road`, but the value for that field is passed with the process request as `2147 West Silverlake Drive`, the system uses the address at `Silverlake Drive`. > โš ๏ธ Try It > > To use the Try It feature for this endpoint, you can use the credentials for your [Sandbox API user](doc:sandbox-environments).

You can also use the following test account. Copy the value and paste it into the appropriate space in the Try It section to the right. > username: `docs@nexiopay.com` > password: `JZdzoXpdDeH6VA` > > Provide the following as body parameters, depending on which payment flow you are using: > - **For an initial or subsequent transaction with a saved card token:** Include at least the `data.amount`, `processingOptions.paymentType`, and `tokenex.token`. > - **For a subsequent transaction with a saved terminal token:** Include at least the `data.amount`, `processingOptions.paymentType`, and `terminal.token`. > - **With the full card information:** Include at least the `data.amount`, `processingOptions.paymentType`, `card.pan`, `card.expirationYear`, and `card.expirationMonth`.
**Note:** Sending full card information may increase your PCI scope. > - **For a subsequent transaction with the full card information:** Include at least the `data.amount`, `processingOptions.paymentType`, `card.pan`, `card.expirationYear`, `card.expirationMonth`, and `recurringId`. > > For information about test card numbers and values you can use, see the documentation for the specific [gateway/connection integration guide](doc:connections) you want to use or, if you are testing Account Updater, see the [Test cards for account updater](doc:checking-a-cards-enrollment-tag#test-cards-for-account-updater) section of the "Checking a card's enrollment tag" topic.
## Request parameters - data - data.amount - data.surcharge - data.currency - data.allowedCardTypes - data.cart - data.cart.items - data.cart.items.item - data.cart.items.description - data.cart.items.quantity - data.cart.items.price - data.cart.items.type - data.customer - data.customer.customerRef - data.customer.orderNumber - data.customer.orderDate - data.customer.invoice - data.customer.firstName - data.customer.lastName - data.customer.birthDate - data.customer.nationalIdentificationNumber - data.customer.billToAddressOne - data.customer.billToAddressTwo - data.customer.billToCity - data.customer.billToCountry - data.customer.billToPhone - data.customer.billToPostal - data.customer.billToState - data.customer.createdAtDate - data.customer.email - data.customer.phone - data.customer.shipToAddressOne - data.customer.shipToAddressTwo - data.customer.shipToCity - data.customer.shipToCountry - data.customer.shipToPhone - data.customer.shipToPostal - data.customer.shipToState - data.customFields - data.customFields.exampleKey - data.description - data.descriptor - data.descriptor.name - data.descriptor.address - data.descriptor.city - data.descriptor.state - data.descriptor.postal - data.descriptor.country - data.descriptor.phone - data.descriptor.url - data.descriptor.merchantId - data.descriptor.mcc - data.lodging - data.lodging.advanceDeposit - data.lodging.checkInDate - data.lodging.checkOutDate - data.lodging.noShow - data.lodging.roomNumber - data.lodging.roomRate - paymentMethod - tokenex - tokenex.token - tokenex.firstSix - tokenex.lastFour - card - card.cardType - card.cardHolderName - card.encryptedNumber - card.expirationMonth - card.expirationYear - card.securityCode - card.firstSix - card.lastFour - card.classification - card.businessNumber - card.password - card.pan - recurringId - merchantId - processingOptions - processingOptions.merchantId - processingOptions.check3ds - processingOptions.paymentType - processingOptions.customerRedirectUrl - processingOptions.checkFraud - processingOptions.paymentOptionTag - processingOptions.retryOnSoftDecline - processingOptions.shouldUseFingerprint - processingOptions.verboseResponse - clientIp - isAuthOnly - installment - installment.period - external3ds - external3ds.eci - external3ds.cavv - external3ds.xid - external3ds.version - external3ds.enrolled - external3ds.pAResStatus - external3ds.commerceIndicator - external3ds.ucafAuthenticationData - external3ds.ucafCollectionIndicator - external3ds.directoryServerTransactionId ## Response parameters - id - merchantId - authCode - amount - currency - transactionDate - transactionStatus - transactionType - shouldUpdateCard - card - card.cardHolder - card.expirationMonth - card.expirationYear - card.cardType - card.cardNumber - card.firstSix - card.lastFour - token - token.token - token.firstSix - token.lastFour - token.cardType - data - data.amount - data.currency - data.settlementCurrency - data.customer - data.customer.customerRef - data.customer.orderNumber - data.customer.orderDate - data.customer.invoice - data.customer.firstName - data.customer.lastName - data.customer.birthDate - data.customer.billToAddressOne - data.customer.billToAddressTwo - data.customer.billToCity - data.customer.billToCountry - data.customer.billToPhone - data.customer.billToPostal - data.customer.billToState - data.customer.email - data.customer.phone - data.customer.shipToAddressOne - data.customer.shipToAddressTwo - data.customer.shipToCity - data.customer.shipToCountry - data.customer.shipToPhone - data.customer.shipToPostal - data.customer.shipToState - data.customer.createdAt - data.cart - data.cart.items - data.cart.items.item - data.cart.items.description - data.cart.items.quantity - data.cart.items.price - data.cart.items.type - data.lodging - data.lodging.advanceDeposit - data.lodging.checkInDate - data.lodging.checkOutDate - data.lodging.noShow - data.lodging.roomNumber - data.lodging.roomRate - data.customFields - data.customFields.exampleKey - data.nsu - kountResponse - kountResponse.status - kountResponse.rules - installment - installment.period - gatewayResponse - gatewayResponse.gatewayName - gatewayResponse.refNumber - recurringData - recurringData.recurringId - recurringData.recurringIdType - status - message - redirectUrl - asyncTraceId
- [View transaction async status](https://docs.nexiopay.com/reference/viewtransactionasyncstatus.md): Gets information about the specified asynchronous transaction. Use this for tracking 3D Secure (3DS) transactions submitted through the [Run card transaction](ref:runcardtransaction) or [Run card transaction with iframe](ref:runcardtransactioniframe) endpoint. Set the `check3ds` parameter to `true` in the [Create one-time-use token](ref:createonetimeusetoken) endpoint to have the system return the `asyncTraceId` parameter for use in the path parameter for this endpoint. For a tutorial on the entire 3DS workflow, see the [Using 3DS to run transactions](doc:using-3ds-to-run-transactions) topic. For 3DS transactions, the history object progresses through the following flow for a successful payment: