> For the complete documentation index, see [llms.txt](https://docs.xplorpay.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.xplorpay.com/api-reference/api.md).

# API

- [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)
- [ReferencesControllerV2](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/merchant-demographics/referencescontrollerv2.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)
- [PricingPlanV2](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/pricing-plan-and-reference/pricingplanv2.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)
- [LegalDocuments](https://docs.xplorpay.com/api-reference/api/merchant-onboarding/onboard-merchant/merchant-legal-documents/legaldocuments.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)
- [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)
- [Customers](https://docs.xplorpay.com/api-reference/api/payments/recurring-payments-service/customers.md)
- [Customer Token](https://docs.xplorpay.com/api-reference/api/payments/recurring-payments-service/customer-token-1.md)
- [Payment Plan](https://docs.xplorpay.com/api-reference/api/payments/recurring-payments-service/payment-plan.md)
- [Payments](https://docs.xplorpay.com/api-reference/api/payments/recurring-payments-service/payments.md)
- [Forecast](https://docs.xplorpay.com/api-reference/api/payments/recurring-payments-service/forecast-1.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)
- [PayLink Settings](https://docs.xplorpay.com/api-reference/api/payments/gateway-settings/paylink-settings.md)
- [HPP Settings](https://docs.xplorpay.com/api-reference/api/payments/gateway-settings/hpp-settings.md)
- [Device Settings](https://docs.xplorpay.com/api-reference/api/payments/gateway-settings/device-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)
- [Duplicate Transaction](https://docs.xplorpay.com/api-reference/api/payments/gateway-settings/duplicate-transaction.md)
- [Terminal](https://docs.xplorpay.com/api-reference/api/payments/gateway-settings/terminal.md)
- [RPS](https://docs.xplorpay.com/api-reference/api/payments/gateway-settings/rps.md)
- [Report](https://docs.xplorpay.com/api-reference/api/payments/gateway-settings/report.md)
- [Paylink](https://docs.xplorpay.com/api-reference/api/payments/gateway-settings/paylink.md)
- [HPP](https://docs.xplorpay.com/api-reference/api/payments/gateway-settings/hpp.md)
- [Device](https://docs.xplorpay.com/api-reference/api/payments/gateway-settings/device.md)
- [CSC](https://docs.xplorpay.com/api-reference/api/payments/gateway-settings/csc.md)
- [AVS](https://docs.xplorpay.com/api-reference/api/payments/gateway-settings/avs.md)
- [Transaction Alert](https://docs.xplorpay.com/api-reference/api/payments/gateway-settings/transaction-alert.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)


---

# 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
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.xplorpay.com/api-reference/api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.