# Xplor Pay Documentation ## Home - [Home](https://docs.xplorpay.com/home.md) ## Getting Started - [Our Products](https://docs.xplorpay.com/getting-started/getting-started/our-products.md) - [Merchant Onboarding](https://docs.xplorpay.com/getting-started/getting-started/our-products/merchant-onboarding.md) - [Hosted Merchant Onboarding](https://docs.xplorpay.com/getting-started/getting-started/our-products/merchant-onboarding/hosted-merchant-onboarding.md) - [Merchant Onboarding via Partner Portal](https://docs.xplorpay.com/getting-started/getting-started/our-products/merchant-onboarding/merchant-onboarding-via-partner-portal.md) - [Merchant Onboarding via API](https://docs.xplorpay.com/getting-started/getting-started/our-products/merchant-onboarding/merchant-onboarding-via-api.md) - [Payment Processing](https://docs.xplorpay.com/getting-started/getting-started/our-products/payment-processing.md) - [Cloud EMV](https://docs.xplorpay.com/getting-started/getting-started/our-products/payment-processing/cloud-emv.md) - [Mobile EMV SDK](https://docs.xplorpay.com/getting-started/getting-started/our-products/payment-processing/mobile-emv-sdk.md) - [JavaScript SDK](https://docs.xplorpay.com/getting-started/getting-started/our-products/payment-processing/javascript-sdk.md) - [Recurring Payments](https://docs.xplorpay.com/getting-started/getting-started/our-products/payment-processing/recurring-payments.md) - [ACH Transactions](https://docs.xplorpay.com/getting-started/getting-started/our-products/payment-processing/ach-transactions.md) - [Paylink](https://docs.xplorpay.com/getting-started/getting-started/our-products/payment-processing/paylink.md) - [Payment UI](https://docs.xplorpay.com/getting-started/getting-started/our-products/payment-processing/payment-ui.md): Learn how to integrate Xplor Pay Payment UI for iOS to accept card-present payments with the VP3300 Bluetooth reader, manual card entry, offline mode, and built-in payment screens. - [Tap to Pay on iPhone](https://docs.xplorpay.com/getting-started/getting-started/our-products/payment-processing/tap-to-pay-on-iphone.md): Learn how to integrate Tap to Pay on iPhone with the iOS SDK, verify device support, and launch contactless payments. - [Cards on File](https://docs.xplorpay.com/getting-started/getting-started/our-products/payment-processing/cards-on-file.md): Manage stored payment tokens, Account Updater results, and decline responses for card-on-file payments. - [Overview](https://docs.xplorpay.com/getting-started/getting-started/our-products/payment-processing/cards-on-file/overview.md): Learn how Cards on File uses stored tokens and Account Updater data to improve payment decisions. - [Account Updater Responses](https://docs.xplorpay.com/getting-started/getting-started/our-products/payment-processing/cards-on-file/account-updater-responses.md): Interpret token update statuses and determine whether to authorize a stored payment method. - [Manage Declines](https://docs.xplorpay.com/getting-started/getting-started/our-products/payment-processing/cards-on-file/manage-declines.md): Handle issuer decline responses and prevent retries that can increase risk and cost. - [Collect Updated Payment Details](https://docs.xplorpay.com/getting-started/getting-started/our-products/payment-processing/cards-on-file/collect-updated-payment-details.md): Retrieve token update statuses and collect a replacement payment method when required. - [Common Scenarios & Troubleshooting](https://docs.xplorpay.com/getting-started/getting-started/our-products/payment-processing/cards-on-file/common-scenarios-and-troubleshooting.md): Resolve common Cards on File status and decline scenarios with the correct next action. - [Financial Management](https://docs.xplorpay.com/getting-started/getting-started/our-products/financial-management.md) - [Merchant Pricing](https://docs.xplorpay.com/getting-started/getting-started/our-products/financial-management/merchant-pricing.md) - [Merchant Billing & Funding](https://docs.xplorpay.com/getting-started/getting-started/our-products/financial-management/merchant-billing-and-funding.md) - [Financial Reporting](https://docs.xplorpay.com/getting-started/getting-started/our-products/financial-management/financial-reporting.md) - [Disputes Management](https://docs.xplorpay.com/getting-started/getting-started/our-products/financial-management/disputes-management.md) - [Reporting Solutions](https://docs.xplorpay.com/getting-started/getting-started/our-products/reporting-solutions.md) - [Reporting](https://docs.xplorpay.com/getting-started/getting-started/our-products/reporting-solutions/reporting.md) - [Partner & Merchant Solutions](https://docs.xplorpay.com/getting-started/getting-started/our-products/partner-and-merchant-solutions.md) - [Partner Portal](https://docs.xplorpay.com/getting-started/getting-started/our-products/partner-and-merchant-solutions/partner-portal.md) - [Merchant Portal](https://docs.xplorpay.com/getting-started/getting-started/our-products/partner-and-merchant-solutions/merchant-portal.md) - [Integration Process](https://docs.xplorpay.com/getting-started/integration-process.md) - [Devices](https://docs.xplorpay.com/getting-started/devices.md) - [Dejavoo](https://docs.xplorpay.com/getting-started/devices/dejavoo.md) - [PAX](https://docs.xplorpay.com/getting-started/devices/pax.md) - [ID TECH](https://docs.xplorpay.com/getting-started/devices/id-tech.md) - [Security Solutions](https://docs.xplorpay.com/getting-started/security-solutions.md) - [PCI Compliance](https://docs.xplorpay.com/getting-started/security-solutions/pci-compliance.md) - [Tokenization](https://docs.xplorpay.com/getting-started/security-solutions/tokenization.md) - [Encryption](https://docs.xplorpay.com/getting-started/security-solutions/encryption.md) - [Advanced Compliance & Security Measures & Programs](https://docs.xplorpay.com/getting-started/security-solutions/advanced-compliance-and-security-measures-and-programs.md) ## SDKs - [Overview](https://docs.xplorpay.com/guides/overview.md): High-level guidance for choosing and integrating our SDKs. - [JavaScript](https://docs.xplorpay.com/guides/javascript.md) - [Prerequisites](https://docs.xplorpay.com/guides/javascript/prerequisites.md) - [Add payment form](https://docs.xplorpay.com/guides/javascript/add-payment-form.md) - [Format payment page](https://docs.xplorpay.com/guides/javascript/format-payment-page.md) - [Process payment](https://docs.xplorpay.com/guides/javascript/process-payment.md) - [Apple Pay for Web](https://docs.xplorpay.com/guides/javascript/apple-pay-for-web.md) - [Google Pay for Web](https://docs.xplorpay.com/guides/javascript/google-pay-for-web.md) - [IDTech VP8300](https://docs.xplorpay.com/guides/javascript/idtech-vp8300.md) - [Configure payment page](https://docs.xplorpay.com/guides/javascript/configure-payment-page.md) - [Members](https://docs.xplorpay.com/guides/javascript/configure-payment-page/members.md) - [Methods](https://docs.xplorpay.com/guides/javascript/configure-payment-page/methods.md) - [Card validations](https://docs.xplorpay.com/guides/javascript/card-validations.md) - [Card number](https://docs.xplorpay.com/guides/javascript/card-validations/card-number.md) - [Card expiration date](https://docs.xplorpay.com/guides/javascript/card-validations/card-expiration-date.md) - [CSC/CVC](https://docs.xplorpay.com/guides/javascript/card-validations/csc-cvc.md) - [Mobile EMV](https://docs.xplorpay.com/guides/mobile-emv.md) - [iOS framework](https://docs.xplorpay.com/guides/mobile-emv/ios-framework.md) - [Prerequisites](https://docs.xplorpay.com/guides/mobile-emv/ios-framework/prerequisites.md) - [Start Bluetooth connection](https://docs.xplorpay.com/guides/mobile-emv/ios-framework/start-bluetooth-connection.md) - [Integrate iOS framework](https://docs.xplorpay.com/guides/mobile-emv/ios-framework/integrate-ios-framework.md) - [Set iOS framework](https://docs.xplorpay.com/guides/mobile-emv/ios-framework/set-ios-framework.md) - [Optional settings](https://docs.xplorpay.com/guides/mobile-emv/ios-framework/optional-settings.md) - [Android framework](https://docs.xplorpay.com/guides/mobile-emv/android-framework.md) - [Integrate Android framework](https://docs.xplorpay.com/guides/mobile-emv/android-framework/integrate-android-framework.md) - [Disable EMV configuration](https://docs.xplorpay.com/guides/mobile-emv/android-framework/disable-emv-configuration.md) - [Optional settings](https://docs.xplorpay.com/guides/mobile-emv/android-framework/optional-settings.md) - [IDTech VP3300](https://docs.xplorpay.com/guides/mobile-emv/idtech-vp3300.md) - [Charge battery](https://docs.xplorpay.com/guides/mobile-emv/idtech-vp3300/charge-battery.md) - [Pair card reader](https://docs.xplorpay.com/guides/mobile-emv/idtech-vp3300/pair-card-reader.md) - [Read card data](https://docs.xplorpay.com/guides/mobile-emv/idtech-vp3300/read-card-data.md) - [Start transaction](https://docs.xplorpay.com/guides/mobile-emv/start-transaction.md) - [Generate JSON Web Token](https://docs.xplorpay.com/guides/mobile-emv/generate-json-web-token.md) - [Feedback messages](https://docs.xplorpay.com/guides/mobile-emv/feedback-messages.md) - [ClearentWrapper](https://docs.xplorpay.com/guides/mobile-emv/clearentwrapper.md) - [Prerequisites](https://docs.xplorpay.com/guides/mobile-emv/clearentwrapper/prerequisites.md) - [Initialize SDK](https://docs.xplorpay.com/guides/mobile-emv/clearentwrapper/initialize-sdk.md) - [Pair card reader](https://docs.xplorpay.com/guides/mobile-emv/clearentwrapper/pair-card-reader.md) - [Start transaction](https://docs.xplorpay.com/guides/mobile-emv/clearentwrapper/start-transaction.md) - [Manage transactions](https://docs.xplorpay.com/guides/mobile-emv/clearentwrapper/manage-transactions.md) - [Handle reader information](https://docs.xplorpay.com/guides/mobile-emv/clearentwrapper/handle-reader-information.md) - [Upload signature](https://docs.xplorpay.com/guides/mobile-emv/clearentwrapper/upload-signature.md) - [Send e-mail receipt](https://docs.xplorpay.com/guides/mobile-emv/clearentwrapper/send-e-mail-receipt.md) - [Process offline transactions](https://docs.xplorpay.com/guides/mobile-emv/clearentwrapper/process-offline-transactions.md) - [Messaging and feedback](https://docs.xplorpay.com/guides/mobile-emv/clearentwrapper/messaging-and-feedback.md) - [Cloud EMV](https://docs.xplorpay.com/guides/cloud-emv.md) - [Cloud EMV integration](https://docs.xplorpay.com/guides/cloud-emv/cloud-emv-integration.md) - [Manage duplicate transactions](https://docs.xplorpay.com/guides/cloud-emv/manage-duplicate-transactions.md) ## Quick Starts - [Overview](https://docs.xplorpay.com/quick-starts/overview.md): Start here to choose the right Quick Start and complete the required integration steps. - [Hosted Merchant Onboarding](https://docs.xplorpay.com/quick-starts/hosted-merchant-onboarding.md) - [Cloud EMV](https://docs.xplorpay.com/quick-starts/cloud-emv.md) - [JavaScript](https://docs.xplorpay.com/quick-starts/javascript.md) - [iOS Framework](https://docs.xplorpay.com/quick-starts/ios-framework.md) - [Payment UI](https://docs.xplorpay.com/quick-starts/payment-ui.md) - [Android Framework](https://docs.xplorpay.com/quick-starts/android-framework.md) - [Recurring Payments](https://docs.xplorpay.com/quick-starts/recurring-payments.md) - [ACH Transactions](https://docs.xplorpay.com/quick-starts/ach-transactions.md) - [Disputes Management](https://docs.xplorpay.com/quick-starts/disputes-management.md) - [Reporting](https://docs.xplorpay.com/quick-starts/reporting.md) ## API References - [Overview](https://docs.xplorpay.com/api-reference/overview.md) - [API Core Standards](https://docs.xplorpay.com/api-reference/api-core-standards.md) - [Webhooks](https://docs.xplorpay.com/api-reference/webhooks.md) - [Prerequisites](https://docs.xplorpay.com/api-reference/webhooks/prerequisites.md) - [Register URL](https://docs.xplorpay.com/api-reference/webhooks/register-url.md) - [Webhook Subscriptions](https://docs.xplorpay.com/api-reference/webhooks/webhook-subscriptions.md) - [Working with Webhooks](https://docs.xplorpay.com/api-reference/webhooks/working-with-webhooks.md) - [Transaction Webhooks](https://docs.xplorpay.com/api-reference/webhooks/working-with-webhooks/transaction-webhooks.md) - [Merchant Onboarding Webhooks](https://docs.xplorpay.com/api-reference/webhooks/working-with-webhooks/merchant-onboarding-webhooks.md) - [Application Status](https://docs.xplorpay.com/api-reference/webhooks/working-with-webhooks/merchant-onboarding-webhooks/application-status.md) - [Application Fixes](https://docs.xplorpay.com/api-reference/webhooks/working-with-webhooks/merchant-onboarding-webhooks/application-fixes.md) - [Equipment Tracking & Activation Webhooks](https://docs.xplorpay.com/api-reference/webhooks/working-with-webhooks/equipment-tracking-and-activation-webhooks.md) - [Equipment Tracking](https://docs.xplorpay.com/api-reference/webhooks/working-with-webhooks/equipment-tracking-and-activation-webhooks/equipment-tracking.md) - [Equipment Activation](https://docs.xplorpay.com/api-reference/webhooks/working-with-webhooks/equipment-tracking-and-activation-webhooks/equipment-activation.md) - [ACH Transaction Status Webhooks](https://docs.xplorpay.com/api-reference/webhooks/working-with-webhooks/ach-transaction-status-webhooks.md) - [Chargeback](https://docs.xplorpay.com/api-reference/webhooks/working-with-webhooks/ach-transaction-status-webhooks/chargeback.md) - [Returned](https://docs.xplorpay.com/api-reference/webhooks/working-with-webhooks/ach-transaction-status-webhooks/returned.md) - [Rejected: Authorization Declined](https://docs.xplorpay.com/api-reference/webhooks/working-with-webhooks/ach-transaction-status-webhooks/rejected-authorization-declined.md) - [Rejected: Account Is Invalid](https://docs.xplorpay.com/api-reference/webhooks/working-with-webhooks/ach-transaction-status-webhooks/rejected-account-is-invalid.md) - [Rejected: Voiding](https://docs.xplorpay.com/api-reference/webhooks/working-with-webhooks/ach-transaction-status-webhooks/rejected-voiding.md) - [Rejected: Voided](https://docs.xplorpay.com/api-reference/webhooks/working-with-webhooks/ach-transaction-status-webhooks/rejected-voided.md) - [Settled](https://docs.xplorpay.com/api-reference/webhooks/working-with-webhooks/ach-transaction-status-webhooks/settled.md) - [Updated](https://docs.xplorpay.com/api-reference/webhooks/working-with-webhooks/ach-transaction-status-webhooks/updated.md) - [Resources](https://docs.xplorpay.com/api-reference/resources.md) - [Test Cards & ACH Accounts](https://docs.xplorpay.com/api-reference/resources/test-cards-and-ach-accounts.md) - [Merchant Onboarding API Result Codes](https://docs.xplorpay.com/api-reference/resources/merchant-onboarding-api-result-codes.md) - [Transaction Error Generation Data](https://docs.xplorpay.com/api-reference/resources/transaction-error-generation-data.md) - [Card Response & Result Codes](https://docs.xplorpay.com/api-reference/resources/card-response-and-result-codes.md) - [Card Error Response Codes](https://docs.xplorpay.com/api-reference/resources/card-response-and-result-codes/card-error-response-codes.md) - [Card Transaction Result Codes](https://docs.xplorpay.com/api-reference/resources/card-response-and-result-codes/card-transaction-result-codes.md) - [Card Security Code (CSC)](https://docs.xplorpay.com/api-reference/resources/card-response-and-result-codes/card-security-code-csc.md) - [Address Verification Service (AVS)](https://docs.xplorpay.com/api-reference/resources/card-response-and-result-codes/address-verification-service-avs.md) - [Duplicate Transaction Settings](https://docs.xplorpay.com/api-reference/resources/card-response-and-result-codes/duplicate-transaction-settings.md) - [ACH Request Validation, Response & Return Codes](https://docs.xplorpay.com/api-reference/resources/ach-request-validation-response-and-return-codes.md) - [ACH Request Validation Codes](https://docs.xplorpay.com/api-reference/resources/ach-request-validation-response-and-return-codes/ach-request-validation-codes.md) - [ACH Response Codes](https://docs.xplorpay.com/api-reference/resources/ach-request-validation-response-and-return-codes/ach-response-codes.md) - [ACH Return Codes](https://docs.xplorpay.com/api-reference/resources/ach-request-validation-response-and-return-codes/ach-return-codes.md) - [ACH Transaction Statuses](https://docs.xplorpay.com/api-reference/resources/ach-request-validation-response-and-return-codes/ach-transaction-statuses.md) - [Visa's Commercial Enhanced Data Program](https://docs.xplorpay.com/api-reference/resources/visas-commercial-enhanced-data-program.md) - [Lower Interchange Rates](https://docs.xplorpay.com/api-reference/resources/visas-commercial-enhanced-data-program/lower-interchange-rates.md) - [Process Payments](https://docs.xplorpay.com/api-reference/resources/visas-commercial-enhanced-data-program/process-payments.md) - [Submit Enhanced Transaction Data](https://docs.xplorpay.com/api-reference/resources/visas-commercial-enhanced-data-program/submit-enhanced-transaction-data.md) - [Sales tax amount](https://docs.xplorpay.com/api-reference/resources/visas-commercial-enhanced-data-program/submit-enhanced-transaction-data/sales-tax-amount.md) - [Summary](https://docs.xplorpay.com/api-reference/resources/visas-commercial-enhanced-data-program/submit-enhanced-transaction-data/summary.md) - [Line-item](https://docs.xplorpay.com/api-reference/resources/visas-commercial-enhanced-data-program/submit-enhanced-transaction-data/line-item.md) - [API request code](https://docs.xplorpay.com/api-reference/resources/visas-commercial-enhanced-data-program/api-request-code.md) - [Level 3 error code](https://docs.xplorpay.com/api-reference/resources/visas-commercial-enhanced-data-program/level-3-error-code.md): Resolve Visa Commercial Enhanced Data Program Level 3 validation errors. - [Merchant Onboarding](https://docs.xplorpay.com/api-reference/api/merchant-onboarding.md) - [Getting Started](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/getting-started.md) - [Onboard Merchant](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant.md) - [Application Management](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/application-management.md) - [Application](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/application-management/application.md) - [Models](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/application-management/models.md) - [Merchant Demographics](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/merchant-demographics.md) - [Merchant Profile](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/merchant-demographics/merchant-profile.md) - [Bank Account](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/merchant-demographics/bank-account.md) - [Business Contact](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/merchant-demographics/business-contact.md) - [Addresses](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/merchant-demographics/addresses.md) - [Taxpayer](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/merchant-demographics/taxpayer.md) - [Sales Profile](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/merchant-demographics/sales-profile.md) - [Site Survey](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/merchant-demographics/site-survey.md) - [Supporting Documents](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/merchant-demographics/supporting-documents.md) - [Bank Account](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/merchant-demographics/bank-account-1.md) - [Business Contact](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/merchant-demographics/business-contact-1.md) - [Documents](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/merchant-demographics/documents.md) - [Merchant](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/merchant-demographics/merchant.md) - [References](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/merchant-demographics/references.md) - [References Controller V2](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/merchant-demographics/references-controller-v2.md) - [Sales Profile](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/merchant-demographics/sales-profile-1.md) - [Site Survey](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/merchant-demographics/site-survey-1.md) - [Tax Payer](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/merchant-demographics/tax-payer.md) - [Models](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/merchant-demographics/models.md) - [Pricing Plan and Reference](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/pricing-plan-and-reference.md) - [Pricing Plans](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/pricing-plan-and-reference/pricing-plans.md) - [Pricing Reference](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/pricing-plan-and-reference/pricing-reference.md) - [Pricing Plan V2](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/pricing-plan-and-reference/pricing-plan-v2.md) - [Reference](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/pricing-plan-and-reference/reference.md) - [Models](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/pricing-plan-and-reference/models.md) - [Equipment](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/equipment.md) - [Equipment Products](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/equipment/equipment-products.md) - [Products](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/equipment/equipment-products/products.md) - [Models](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/equipment/equipment-products/models.md) - [Equipment Configuration Survey](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/equipment/equipment-configuration-survey.md) - [Survey](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/equipment/equipment-configuration-survey/survey.md) - [Models](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/equipment/equipment-configuration-survey/models.md) - [Equipment Order](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/equipment/equipment-order.md) - [Equipment Order](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/equipment/equipment-order/equipment-order.md) - [Equipment Order Service API](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/equipment/equipment-order/equipment-order-service-api.md) - [Models](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/equipment/equipment-order/models.md) - [Equipment Order new](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/equipment/equipment-order-new.md) - [Equipment Order](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/equipment/equipment-order-new/equipment-order.md) - [Equipment Order Service API](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/equipment/equipment-order-new/equipment-order-service-api.md) - [Models](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/equipment/equipment-order-new/models.md) - [Merchant Legal Documents](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/merchant-legal-documents.md) - [Documents](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/merchant-legal-documents/documents.md) - [Terms and Conditions](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/merchant-legal-documents/terms-and-conditions.md) - [Legal Documents](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/merchant-legal-documents/legal-documents.md) - [Types](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/merchant-legal-documents/types.md) - [Terms And Conditions](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/merchant-legal-documents/terms-and-conditions-1.md) - [Models](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/merchant-legal-documents/models.md) - [eDocs Reporting](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/edocs-reporting.md) - [Documents](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/edocs-reporting/documents.md) - [Models](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/edocs-reporting/models.md) - [Reference Data (v1)](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/reference-data-v1.md) - [Reference Data (v2)](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/reference-data-v2.md) - [Hosted Merchant Onboarding](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/hosted-merchant-onboarding.md) - [Merchant](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/hosted-merchant-onboarding/merchant.md) - [Models](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/hosted-merchant-onboarding/models.md) - [Payments](https://docs.xplorpay.com/api-reference/api/payments.md) - [Getting Started](https://docs.xplorpay.com/api-reference/api/payments/getting-started.md) - [Cards (card-not-present)](https://docs.xplorpay.com/api-reference/api/payments/cards-card-not-present.md) - [Transactions](https://docs.xplorpay.com/api-reference/api/payments/cards-card-not-present/transactions.md) - [Transactions](https://docs.xplorpay.com/api-reference/api/payments/cards-card-not-present/transactions/transactions.md) - [Models](https://docs.xplorpay.com/api-reference/api/payments/cards-card-not-present/transactions/models.md) - [Vault](https://docs.xplorpay.com/api-reference/api/payments/cards-card-not-present/vault.md) - [Tokens](https://docs.xplorpay.com/api-reference/api/payments/cards-card-not-present/vault/tokens.md) - [Models](https://docs.xplorpay.com/api-reference/api/payments/cards-card-not-present/vault/models.md) - [HPP signature verification](https://docs.xplorpay.com/api-reference/api/payments/cards-card-not-present/hpp-signature-verification.md) - [HPP Verification Service](https://docs.xplorpay.com/api-reference/api/payments/cards-card-not-present/hpp-signature-verification/hpp-verification-service.md) - [Models](https://docs.xplorpay.com/api-reference/api/payments/cards-card-not-present/hpp-signature-verification/models.md) - [Terminal (card-present)](https://docs.xplorpay.com/api-reference/api/payments/terminal-card-present.md) - [Transaction EMV](https://docs.xplorpay.com/api-reference/api/payments/terminal-card-present/transaction-emv.md) - [Semi Integrated Transactions](https://docs.xplorpay.com/api-reference/api/payments/terminal-card-present/transaction-emv/semi-integrated-transactions.md) - [Models](https://docs.xplorpay.com/api-reference/api/payments/terminal-card-present/transaction-emv/models.md) - [Transaction Signature](https://docs.xplorpay.com/api-reference/api/payments/terminal-card-present/transaction-signature.md) - [Signature Service](https://docs.xplorpay.com/api-reference/api/payments/terminal-card-present/transaction-signature/signature-service.md) - [Models](https://docs.xplorpay.com/api-reference/api/payments/terminal-card-present/transaction-signature/models.md) - [Transaction EMV Batches](https://docs.xplorpay.com/api-reference/api/payments/terminal-card-present/transaction-emv-batches.md) - [Semi Integrated Batches](https://docs.xplorpay.com/api-reference/api/payments/terminal-card-present/transaction-emv-batches/semi-integrated-batches.md) - [Models](https://docs.xplorpay.com/api-reference/api/payments/terminal-card-present/transaction-emv-batches/models.md) - [ACH](https://docs.xplorpay.com/api-reference/api/payments/ach.md) - [ACH Transaction](https://docs.xplorpay.com/api-reference/api/payments/ach/ach-transaction.md) - [ACH Transactions](https://docs.xplorpay.com/api-reference/api/payments/ach/ach-transaction/ach-transactions.md) - [ACH Provider](https://docs.xplorpay.com/api-reference/api/payments/ach/ach-transaction/ach-provider.md) - [Models](https://docs.xplorpay.com/api-reference/api/payments/ach/ach-transaction/models.md) - [ACH Vault (Token)](https://docs.xplorpay.com/api-reference/api/payments/ach/ach-vault-token.md) - [ACH Tokens](https://docs.xplorpay.com/api-reference/api/payments/ach/ach-vault-token/ach-tokens.md) - [Models](https://docs.xplorpay.com/api-reference/api/payments/ach/ach-vault-token/models.md) - [Mobile](https://docs.xplorpay.com/api-reference/api/payments/mobile.md) - [Mobile Payment Transactions](https://docs.xplorpay.com/api-reference/api/payments/mobile/mobile-payment-transactions.md) - [Mobile Transactions](https://docs.xplorpay.com/api-reference/api/payments/mobile/mobile-payment-transactions/mobile-transactions.md) - [Models](https://docs.xplorpay.com/api-reference/api/payments/mobile/mobile-payment-transactions/models.md) - [ACH Mobile Transactions](https://docs.xplorpay.com/api-reference/api/payments/mobile/ach-mobile-transactions.md) - [Ach Transactions](https://docs.xplorpay.com/api-reference/api/payments/mobile/ach-mobile-transactions/ach-transactions.md) - [Models](https://docs.xplorpay.com/api-reference/api/payments/mobile/ach-mobile-transactions/models.md) - [Apple Pay for Web](https://docs.xplorpay.com/api-reference/api/payments/mobile/apple-pay-for-web.md) - [Apple Pay For Web](https://docs.xplorpay.com/api-reference/api/payments/mobile/apple-pay-for-web/apple-pay-for-web.md) - [Models](https://docs.xplorpay.com/api-reference/api/payments/mobile/apple-pay-for-web/models.md) - [Android Device Configuration](https://docs.xplorpay.com/api-reference/api/payments/mobile/android-device-configuration.md) - [Android Device Configuration](https://docs.xplorpay.com/api-reference/api/payments/mobile/android-device-configuration/android-device-configuration.md) - [Models](https://docs.xplorpay.com/api-reference/api/payments/mobile/android-device-configuration/models.md) - [Batches](https://docs.xplorpay.com/api-reference/api/payments/batches.md) - [Batch Out And Query Open Batch](https://docs.xplorpay.com/api-reference/api/payments/batches/batch-out-and-query-open-batch.md) - [Batches Batch Out And Open Batches Query](https://docs.xplorpay.com/api-reference/api/payments/batches/batches-batch-out-and-open-batches-query.md) - [Models](https://docs.xplorpay.com/api-reference/api/payments/batches/models.md) - [Batches Warehouse](https://docs.xplorpay.com/api-reference/api/payments/batches-warehouse.md) - [Batches](https://docs.xplorpay.com/api-reference/api/payments/batches-warehouse/batches.md) - [Models](https://docs.xplorpay.com/api-reference/api/payments/batches-warehouse/models.md) - [Recurring Payments Service](https://docs.xplorpay.com/api-reference/api/payments/recurring-payments-service.md) - [Payment Plans](https://docs.xplorpay.com/api-reference/api/payments/recurring-payments-service/payment-plans.md) - [Customer Token](https://docs.xplorpay.com/api-reference/api/payments/recurring-payments-service/customer-token.md) - [Customer](https://docs.xplorpay.com/api-reference/api/payments/recurring-payments-service/customer.md) - [Forecast](https://docs.xplorpay.com/api-reference/api/payments/recurring-payments-service/forecast.md) - [Payment Transaction](https://docs.xplorpay.com/api-reference/api/payments/recurring-payments-service/payment-transaction.md) - [Models](https://docs.xplorpay.com/api-reference/api/payments/recurring-payments-service/models.md) - [Gateway Settings](https://docs.xplorpay.com/api-reference/api/payments/gateway-settings.md) - [Check Duplicate Transaction Settings](https://docs.xplorpay.com/api-reference/api/payments/gateway-settings/check-duplicate-transaction-settings.md) - [Terminal Settings](https://docs.xplorpay.com/api-reference/api/payments/gateway-settings/terminal-settings.md) - [RPS Settings](https://docs.xplorpay.com/api-reference/api/payments/gateway-settings/rps-settings.md) - [Report Settings](https://docs.xplorpay.com/api-reference/api/payments/gateway-settings/report-settings.md) - [Pay Link Settings](https://docs.xplorpay.com/api-reference/api/payments/gateway-settings/pay-link-settings.md) - [HPP Settings](https://docs.xplorpay.com/api-reference/api/payments/gateway-settings/hpp-settings.md) - [CSC Settings](https://docs.xplorpay.com/api-reference/api/payments/gateway-settings/csc-settings.md) - [AVS Settings](https://docs.xplorpay.com/api-reference/api/payments/gateway-settings/avs-settings.md) - [Transaction Alert Settings](https://docs.xplorpay.com/api-reference/api/payments/gateway-settings/transaction-alert-settings.md) - [Models](https://docs.xplorpay.com/api-reference/api/payments/gateway-settings/models.md) - [Receipt Service](https://docs.xplorpay.com/api-reference/api/payments/receipt-service.md) - [Receipt Service](https://docs.xplorpay.com/api-reference/api/payments/receipt-service/receipt-service.md) - [Models](https://docs.xplorpay.com/api-reference/api/payments/receipt-service/models.md) - [Disputes](https://docs.xplorpay.com/api-reference/api/disputes.md) - [Getting Started](https://docs.xplorpay.com/api-reference/api/disputes/getting-started.md) - [Disputes Management](https://docs.xplorpay.com/api-reference/api/disputes/disputes-management.md) - [Dispute Responses](https://docs.xplorpay.com/api-reference/api/disputes/disputes-management/dispute-responses.md) - [Disputes Reporting](https://docs.xplorpay.com/api-reference/api/disputes/disputes-management/disputes-reporting.md) - [Models](https://docs.xplorpay.com/api-reference/api/disputes/disputes-management/models.md) - [Reporting](https://docs.xplorpay.com/api-reference/api/reporting.md) - [Getting Started](https://docs.xplorpay.com/api-reference/api/reporting/getting-started.md) - [Standard Reporting](https://docs.xplorpay.com/api-reference/api/reporting/standard-reporting.md) - [Report](https://docs.xplorpay.com/api-reference/api/reporting/standard-reporting/report.md) - [Models](https://docs.xplorpay.com/api-reference/api/reporting/standard-reporting/models.md) - [Enhanced Reporting](https://docs.xplorpay.com/api-reference/api/reporting/enhanced-reporting.md) - [Report](https://docs.xplorpay.com/api-reference/api/reporting/enhanced-reporting/report.md) - [Models](https://docs.xplorpay.com/api-reference/api/reporting/enhanced-reporting/models.md) ## Partner Portal - [Overview](https://docs.xplorpay.com/partner-portal/partner-portal/overview.md) - [Accessing the Partner Portal](https://docs.xplorpay.com/partner-portal/partner-portal/accessing-the-partner-portal.md) - [Navigating the User Interface](https://docs.xplorpay.com/partner-portal/partner-portal/navigating-the-user-interface.md) - [Core Features](https://docs.xplorpay.com/partner-portal/partner-portal/core-features.md) - [Monitoring Performance with Dashboard](https://docs.xplorpay.com/partner-portal/partner-portal/core-features/monitoring-performance-with-dashboard.md) - [Managing Merchant Applications](https://docs.xplorpay.com/partner-portal/partner-portal/core-features/managing-merchant-applications.md) - [Managing Merchants](https://docs.xplorpay.com/partner-portal/partner-portal/core-features/managing-merchants.md) - [Accessing Reports and Managing Subscriptions](https://docs.xplorpay.com/partner-portal/partner-portal/core-features/accessing-reports-and-managing-subscriptions.md) - [Accessing Reports](https://docs.xplorpay.com/partner-portal/partner-portal/core-features/accessing-reports-and-managing-subscriptions/accessing-reports.md) - [Managing Subscriptions](https://docs.xplorpay.com/partner-portal/partner-portal/core-features/accessing-reports-and-managing-subscriptions/managing-subscriptions.md) - [Submitting Support Ticket](https://docs.xplorpay.com/partner-portal/partner-portal/core-features/submitting-support-ticket.md) - [Guides](https://docs.xplorpay.com/partner-portal/partner-portal/guides.md) - [Merchant Onboarding via Partner Portal](https://docs.xplorpay.com/partner-portal/partner-portal/guides/merchant-onboarding-via-partner-portal.md) - [Starting New Application](https://docs.xplorpay.com/partner-portal/partner-portal/guides/merchant-onboarding-via-partner-portal/starting-new-application.md) - [Adding Hierarchy & Compensation Details](https://docs.xplorpay.com/partner-portal/partner-portal/guides/merchant-onboarding-via-partner-portal/adding-hierarchy-and-compensation-details.md) - [Entering Business Information](https://docs.xplorpay.com/partner-portal/partner-portal/guides/merchant-onboarding-via-partner-portal/entering-business-information.md) - [Entering Profile Details](https://docs.xplorpay.com/partner-portal/partner-portal/guides/merchant-onboarding-via-partner-portal/entering-profile-details.md) - [Conducting Site Survey](https://docs.xplorpay.com/partner-portal/partner-portal/guides/merchant-onboarding-via-partner-portal/conducting-site-survey.md) - [Configuring Pricing Details](https://docs.xplorpay.com/partner-portal/partner-portal/guides/merchant-onboarding-via-partner-portal/configuring-pricing-details.md) - [Adding Banking Information](https://docs.xplorpay.com/partner-portal/partner-portal/guides/merchant-onboarding-via-partner-portal/adding-banking-information.md) - [Adding Equipment](https://docs.xplorpay.com/partner-portal/partner-portal/guides/merchant-onboarding-via-partner-portal/adding-equipment.md) - [Submitting Signature](https://docs.xplorpay.com/partner-portal/partner-portal/guides/merchant-onboarding-via-partner-portal/submitting-signature.md) - [Reviewing & Submitting Application](https://docs.xplorpay.com/partner-portal/partner-portal/guides/merchant-onboarding-via-partner-portal/reviewing-and-submitting-application.md) - [Viewing Application Summary](https://docs.xplorpay.com/partner-portal/partner-portal/guides/merchant-onboarding-via-partner-portal/viewing-application-summary.md) - [Configure Application](https://docs.xplorpay.com/partner-portal/partner-portal/guides/merchant-onboarding-via-partner-portal/configure-application.md) - [Reporting](https://docs.xplorpay.com/partner-portal/partner-portal/guides/reporting.md) - [Reporting Solutions](https://docs.xplorpay.com/partner-portal/partner-portal/guides/reporting/reporting-solutions.md) - [Retrieving Report via Partner Portal](https://docs.xplorpay.com/partner-portal/partner-portal/guides/reporting/retrieving-report-via-partner-portal.md) - [Support Ticketing](https://docs.xplorpay.com/partner-portal/partner-portal/guides/support-ticketing.md) - [Types of Support Tickets](https://docs.xplorpay.com/partner-portal/partner-portal/guides/support-ticketing/types-of-support-tickets.md) - [Submitting a Support Ticket via Partner Portal](https://docs.xplorpay.com/partner-portal/partner-portal/guides/support-ticketing/submitting-a-support-ticket-via-partner-portal.md) ## Merchant Portal - [Overview](https://docs.xplorpay.com/merchant-portal/merchant-portal/overview.md) - [Accessing the Merchant Portal](https://docs.xplorpay.com/merchant-portal/merchant-portal/accessing-the-merchant-portal.md) - [Navigating the User Interface](https://docs.xplorpay.com/merchant-portal/merchant-portal/navigating-the-user-interface.md) - [Core Features](https://docs.xplorpay.com/merchant-portal/merchant-portal/core-features.md) - [Monitoring Home page](https://docs.xplorpay.com/merchant-portal/merchant-portal/core-features/monitoring-home-page.md) - [Accessing Batches](https://docs.xplorpay.com/merchant-portal/merchant-portal/core-features/accessing-batches.md) - [Managing Transactions](https://docs.xplorpay.com/merchant-portal/merchant-portal/core-features/managing-transactions.md) - [Managing Funding Transactions](https://docs.xplorpay.com/merchant-portal/merchant-portal/core-features/managing-funding-transactions.md) - [Managing Virtual Terminal](https://docs.xplorpay.com/merchant-portal/merchant-portal/core-features/managing-virtual-terminal.md) - [Viewing Chargebacks](https://docs.xplorpay.com/merchant-portal/merchant-portal/core-features/viewing-chargebacks.md) - [Managing Disputes](https://docs.xplorpay.com/merchant-portal/merchant-portal/core-features/managing-disputes.md) - [Managing Statements and Tax forms](https://docs.xplorpay.com/merchant-portal/merchant-portal/core-features/managing-statements-and-tax-forms.md) - [Managing User and Account Settings](https://docs.xplorpay.com/merchant-portal/merchant-portal/core-features/managing-user-and-account-settings.md) - [Managing Dispute Email Notifications](https://docs.xplorpay.com/merchant-portal/merchant-portal/core-features/managing-dispute-email-notifications.md) - [Accessing Support Tickets](https://docs.xplorpay.com/merchant-portal/merchant-portal/core-features/accessing-support-tickets.md) - [Guides](https://docs.xplorpay.com/merchant-portal/guides.md) - [Account Updater](https://docs.xplorpay.com/merchant-portal/guides/account-updater.md) - [Checking card updates](https://docs.xplorpay.com/merchant-portal/guides/account-updater/checking-card-updates.md) - [Paylink](https://docs.xplorpay.com/merchant-portal/guides/paylink.md) - [Configure Paylink using the Merchant Portal](https://docs.xplorpay.com/merchant-portal/guides/paylink/configure-paylink-using-the-merchant-portal.md) - [Generate Payment Link using the Merchant Portal](https://docs.xplorpay.com/merchant-portal/guides/paylink/generate-payment-link-using-the-merchant-portal.md) - [Virtual Terminal](https://docs.xplorpay.com/merchant-portal/guides/virtual-terminal.md) - [Accessing Virtual Terminal](https://docs.xplorpay.com/merchant-portal/guides/virtual-terminal/accessing-virtual-terminal.md) - [Adding or Ordering the Equipment](https://docs.xplorpay.com/merchant-portal/guides/virtual-terminal/adding-or-ordering-the-equipment.md) - [Recurring Payments](https://docs.xplorpay.com/merchant-portal/guides/virtual-terminal/recurring-payments.md) - [Adding a new customer](https://docs.xplorpay.com/merchant-portal/guides/virtual-terminal/recurring-payments/adding-a-new-customer.md) - [Adding a payment method](https://docs.xplorpay.com/merchant-portal/guides/virtual-terminal/recurring-payments/adding-a-payment-method.md) - [Adding a new payment plan](https://docs.xplorpay.com/merchant-portal/guides/virtual-terminal/recurring-payments/adding-a-new-payment-plan.md) - [Viewing the plans](https://docs.xplorpay.com/merchant-portal/guides/virtual-terminal/recurring-payments/viewing-the-plans.md) - [Processing Sales Transaction](https://docs.xplorpay.com/merchant-portal/guides/virtual-terminal/processing-sales-transaction.md) - [Processing ACH transaction](https://docs.xplorpay.com/merchant-portal/guides/virtual-terminal/processing-ach-transaction.md) - [Transaction Search](https://docs.xplorpay.com/merchant-portal/guides/virtual-terminal/transaction-search.md) - [Viewing Transactions](https://docs.xplorpay.com/merchant-portal/guides/virtual-terminal/transaction-search/viewing-transactions.md) - [Viewing Transaction Receipt](https://docs.xplorpay.com/merchant-portal/guides/virtual-terminal/transaction-search/viewing-transaction-receipt.md) - [Printing Transaction Receipt](https://docs.xplorpay.com/merchant-portal/guides/virtual-terminal/transaction-search/printing-transaction-receipt.md) - [Emailing Transaction Receipt](https://docs.xplorpay.com/merchant-portal/guides/virtual-terminal/transaction-search/emailing-transaction-receipt.md) - [Void a Transaction](https://docs.xplorpay.com/merchant-portal/guides/virtual-terminal/transaction-search/void-a-transaction.md) - [Refund a Transaction](https://docs.xplorpay.com/merchant-portal/guides/virtual-terminal/transaction-search/refund-a-transaction.md) - [Processing Pending Transactions](https://docs.xplorpay.com/merchant-portal/guides/virtual-terminal/transaction-search/processing-pending-transactions.md) - [Open Batches](https://docs.xplorpay.com/merchant-portal/guides/virtual-terminal/open-batches.md) - [Viewing Batches](https://docs.xplorpay.com/merchant-portal/guides/virtual-terminal/open-batches/viewing-batches.md) - [VT Settings](https://docs.xplorpay.com/merchant-portal/guides/virtual-terminal/vt-settings.md) - [Merchant](https://docs.xplorpay.com/merchant-portal/guides/virtual-terminal/vt-settings/merchant.md) - [Terminal](https://docs.xplorpay.com/merchant-portal/guides/virtual-terminal/vt-settings/terminal.md) - [External Terminal](https://docs.xplorpay.com/merchant-portal/guides/virtual-terminal/vt-settings/external-terminal.md) - [Address Verification (AVS)](https://docs.xplorpay.com/merchant-portal/guides/virtual-terminal/vt-settings/address-verification-avs.md) - [Card Security Code (CSC)](https://docs.xplorpay.com/merchant-portal/guides/virtual-terminal/vt-settings/card-security-code-csc.md) - [Hosted Payment Page (HPP)](https://docs.xplorpay.com/merchant-portal/guides/virtual-terminal/vt-settings/hosted-payment-page-hpp.md) - [Disputes Management](https://docs.xplorpay.com/merchant-portal/guides/disputes-management.md) - [Understanding Dispute Process](https://docs.xplorpay.com/merchant-portal/guides/disputes-management/understanding-dispute-process.md) - [Managing Disputes via Merchant Portal](https://docs.xplorpay.com/merchant-portal/guides/disputes-management/managing-disputes-via-merchant-portal.md) - [Support Ticketing](https://docs.xplorpay.com/merchant-portal/guides/support-ticketing.md) - [Types of Support Tickets](https://docs.xplorpay.com/merchant-portal/guides/support-ticketing/types-of-support-tickets.md) - [Submitting a Support Ticket via Merchant Portal](https://docs.xplorpay.com/merchant-portal/guides/support-ticketing/submitting-a-support-ticket-via-merchant-portal.md) ## Token Portal - [Overview](https://docs.xplorpay.com/token-portal/token-portal/overview.md) - [Information for Merchants](https://docs.xplorpay.com/token-portal/information-for-merchants.md): What You Need to Know to Bring Your Tokens to Xplor Pay - [Information for Software Providers](https://docs.xplorpay.com/token-portal/information-for-software-providers.md): Managing Your Software's Integration with Xplor Pay's Vault - [Information for Payment Processors](https://docs.xplorpay.com/token-portal/information-for-payment-processors.md): Exporting Merchant Tokens to Xplor Pay --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation This site has an agentic ask interface you may use to query the documentation dynamically by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.xplorpay.com/index.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.