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

# API Reference

- [REST API](https://docs.number.tech/api-reference/rest-api.md): The API reference for the REST API
- [Authentication](https://docs.number.tech/api-reference/rest-api/authentication.md): Authenticate user and retrieve session key
- [ACH](https://docs.number.tech/api-reference/rest-api/ach.md)
- [Create an ACH Sale](https://docs.number.tech/api-reference/rest-api/ach/create-an-ach-sale.md)
- [Create an ACH Combo Sale and Consent](https://docs.number.tech/api-reference/rest-api/ach/create-an-ach-combo-sale-and-consent.md)
- [Apply credit to an ACH transaction](https://docs.number.tech/api-reference/rest-api/ach/apply-credit-to-an-ach-transaction.md)
- [Process payment with ACH annual consent](https://docs.number.tech/api-reference/rest-api/ach/process-payment-with-ach-annual-consent.md)
- [Void an ACH transaction](https://docs.number.tech/api-reference/rest-api/ach/void-an-ach-transaction.md)
- [Card Operations](https://docs.number.tech/api-reference/rest-api/card-operations.md)
- [Incremental Auth](https://docs.number.tech/api-reference/rest-api/card-operations/authentication.md)
- [Process a Card Sale](https://docs.number.tech/api-reference/rest-api/card-operations/process-a-card-sale.md): Process a card sale with card present
- [Process a Card Sale with Surcharge](https://docs.number.tech/api-reference/rest-api/card-operations/process-card-sale-surcharge.md)
- [Process a Refund](https://docs.number.tech/api-reference/rest-api/card-operations/process-a-refund.md): Process a refund to a settled charge
- [Void a Transaction](https://docs.number.tech/api-reference/rest-api/card-operations/void-a-transaction.md): Void a Transaction
- [Consent Annual](https://docs.number.tech/api-reference/rest-api/consent-annual.md)
- [Calculate surcharging or convenience fees](https://docs.number.tech/api-reference/rest-api/consent-annual/calculate-surcharging-or-convenience-fees.md)
- [Cancel a consent (Card On File)](https://docs.number.tech/api-reference/rest-api/consent-annual/cancel-a-consent-card-on-file.md)
- [Charge a stored card](https://docs.number.tech/api-reference/rest-api/consent-annual/charge-a-stored-card.md)
- [Modify an annual consent](https://docs.number.tech/api-reference/rest-api/consent-annual/modify-an-annual-consent.md)
- [Create Annual Consent](https://docs.number.tech/api-reference/rest-api/consent-annual/create-annual-consent.md): Create an annual consent with card present
- [Create an annual consent with manual card entry](https://docs.number.tech/api-reference/rest-api/consent-annual/create-an-annual-consent-with-manual-card-entry.md)
- [Annual Consent Stats](https://docs.number.tech/api-reference/rest-api/consent-annual/annual-consent-stats.md)
- [Consent Recurring](https://docs.number.tech/api-reference/rest-api/consent-recurring.md)
- [Create a recurring consent with manual card entry](https://docs.number.tech/api-reference/rest-api/consent-recurring/create-a-recurring-consent-with-manual-card-entry.md)
- [Cancel a recurring consent](https://docs.number.tech/api-reference/rest-api/consent-recurring/cancel-a-recurring-consent.md)
- [Modify a recurring consent](https://docs.number.tech/api-reference/rest-api/consent-recurring/modify-a-recurring-consent.md)
- [Consent Subscription](https://docs.number.tech/api-reference/rest-api/consent-subscription.md)
- [Modify a consent subscription](https://docs.number.tech/api-reference/rest-api/consent-subscription/modify-a-consent-subscription.md): Modify an existing subscription consent
- [Cancel a consent subscription](https://docs.number.tech/api-reference/rest-api/consent-subscription/cancel-a-consent-subscription.md): Cancel an existing subscription consent
- [International](https://docs.number.tech/api-reference/rest-api/international.md)
- [Generate a Receipt](https://docs.number.tech/api-reference/rest-api/international/generate-a-receipt.md): Generate a receipt for an international transaction
- [Process Consent](https://docs.number.tech/api-reference/rest-api/international/process-consent.md)
- [Query International Transaction](https://docs.number.tech/api-reference/rest-api/international/query-international-transaction.md)
- [Void Credit](https://docs.number.tech/api-reference/rest-api/international/void-credit.md)
- [PayForm](https://docs.number.tech/api-reference/rest-api/payform.md): Initialize PayForm
- [Query](https://docs.number.tech/api-reference/rest-api/query.md)
- [Account profile](https://docs.number.tech/api-reference/rest-api/query/account-profile.md)
- [ACH transactions](https://docs.number.tech/api-reference/rest-api/query/ach-transactions.md)
- [Annual Consent Receipt Query](https://docs.number.tech/api-reference/rest-api/query/annual-consent-receipt-query.md)
- [Batch logs](https://docs.number.tech/api-reference/rest-api/query/batch-logs.md)
- [Consent Annual Full Detail](https://docs.number.tech/api-reference/rest-api/query/consent-annual-full-detail.md)
- [Consent Annual Query](https://docs.number.tech/api-reference/rest-api/query/consent-annual-query.md)
- [Consent Annual Query APR](https://docs.number.tech/api-reference/rest-api/query/consent-annual-query-apr.md)
- [Consent General Query](https://docs.number.tech/api-reference/rest-api/query/consent-general-query.md)
- [Consents Expiring Cards](https://docs.number.tech/api-reference/rest-api/query/consents-expiring-cards.md)
- [Consents Expiring Cards 01](https://docs.number.tech/api-reference/rest-api/query/consents-expiring-cards-01.md)
- [Enumeration values](https://docs.number.tech/api-reference/rest-api/query/enumeration-values.md): Methods related querying general information such as enum values
- [Receipt Details](https://docs.number.tech/api-reference/rest-api/query/receipt-details.md)
- [Reconcile](https://docs.number.tech/api-reference/rest-api/query/reconcile.md): Reconcile transactions
- [Recurring Consents](https://docs.number.tech/api-reference/rest-api/query/recurring-consents.md)
- [Recurring Consent Full Detail](https://docs.number.tech/api-reference/rest-api/query/recurring-consent-full-detail.md)
- [Recurring Schedules](https://docs.number.tech/api-reference/rest-api/query/recurring-schedules.md)
- [Transaction Full Detail](https://docs.number.tech/api-reference/rest-api/query/transaction-full-detail.md): Retrieve full details of a transaction
- [Transaction Receipt](https://docs.number.tech/api-reference/rest-api/query/transaction-receipt.md): Retrieve a transaction receipt
- [Transaction Search](https://docs.number.tech/api-reference/rest-api/query/transaction-search.md): Search for transactions based on parameters
- [Voice](https://docs.number.tech/api-reference/rest-api/query/voice.md): Retrieve voice settings
- [Receipt](https://docs.number.tech/api-reference/rest-api/receipt.md): Generate a transaction receipt
- [Recurring Schedule](https://docs.number.tech/api-reference/rest-api/recurring-schedule.md)
- [Cancel a recurring payment schedule](https://docs.number.tech/api-reference/rest-api/recurring-schedule/cancel-a-recurring-payment-schedule.md)
- [Modify a recurring payment schedule](https://docs.number.tech/api-reference/rest-api/recurring-schedule/modify-a-recurring-payment-schedule.md)
- [Process scheduled payments](https://docs.number.tech/api-reference/rest-api/recurring-schedule/process-scheduled-payments.md)
- [Process selected scheduled payments](https://docs.number.tech/api-reference/rest-api/recurring-schedule/process-selected-scheduled-payments.md)
- [Settlement](https://docs.number.tech/api-reference/rest-api/settlement.md)
- [Execute selective batch settlement](https://docs.number.tech/api-reference/rest-api/settlement/execute-selective-batch-settlement.md)
- [Execute batch settlement for all transactions](https://docs.number.tech/api-reference/rest-api/settlement/execute-batch-settlement-for-all-transactions.md)
- [Text to Pay](https://docs.number.tech/api-reference/rest-api/text-to-pay.md): Create a payment link via SMS or email
- [REST API Old / Backup](https://docs.number.tech/api-reference/rest-api-alt.md)
- [Authentication Old](https://docs.number.tech/api-reference/rest-api-alt/authentication.md)
- [ACH Old](https://docs.number.tech/api-reference/rest-api-alt/ach.md)
- [Card Operations Old](https://docs.number.tech/api-reference/rest-api-alt/card-operations.md)
- [Process a Card Sale Old](https://docs.number.tech/api-reference/rest-api-alt/card-operations/process-a-card-sale.md)
- [Consent Annual Older](https://docs.number.tech/api-reference/rest-api-alt/consent-annual.md)
- [Create Annual Consent](https://docs.number.tech/api-reference/rest-api-alt/consent-annual/create-annual-consent.md)
- [Consent Recurring Old](https://docs.number.tech/api-reference/rest-api-alt/consent-recurring.md)
- [Create Recurring Consent](https://docs.number.tech/api-reference/rest-api-alt/consent-recurring/create-recurring-consent.md)
- [Consent Subscription Old](https://docs.number.tech/api-reference/rest-api-alt/consent-subscription.md)
- [International Old](https://docs.number.tech/api-reference/rest-api-alt/international.md)
- [PayForm Old](https://docs.number.tech/api-reference/rest-api-alt/payform.md)
- [Query Old](https://docs.number.tech/api-reference/rest-api-alt/query.md): All of the queries for the REST API
- [Account](https://docs.number.tech/api-reference/rest-api-alt/query/account.md): Queries related to the user account
- [ACH](https://docs.number.tech/api-reference/rest-api-alt/query/ach.md): Queries related to ACH (Automated Clearing House) transactions
- [Batch](https://docs.number.tech/api-reference/rest-api-alt/query/batch.md): Queries related to batch transactions
- [Consent Annual](https://docs.number.tech/api-reference/rest-api-alt/query/consent-annual.md): Queries related to annual consent
- [Consent Recurring](https://docs.number.tech/api-reference/rest-api-alt/query/consent-recurring.md): Queries related to recurring consent
- [Consent General](https://docs.number.tech/api-reference/rest-api-alt/query/consent-general.md): Queries related to all types of consent
- [Recurring Schedule](https://docs.number.tech/api-reference/rest-api-alt/query/recurring-schedule.md): Queries related to recurring schedules
- [Receipt](https://docs.number.tech/api-reference/rest-api-alt/query/receipt.md): Queries related to receipts
- [Transaction](https://docs.number.tech/api-reference/rest-api-alt/query/transaction.md): Queries related to transactions
- [Voice](https://docs.number.tech/api-reference/rest-api-alt/query/voice.md): Queries related to voice authorization
- [Query General](https://docs.number.tech/api-reference/rest-api-alt/query/query-general.md): Methods related querying general information such as enum values
- [Reconcile](https://docs.number.tech/api-reference/rest-api-alt/query/reconcile.md)
- [Receipt Old](https://docs.number.tech/api-reference/rest-api-alt/receipt.md)
- [Recurring Schedule Old](https://docs.number.tech/api-reference/rest-api-alt/recurring-schedule.md)
- [Settlement Old](https://docs.number.tech/api-reference/rest-api-alt/settlement.md)
- [Text to Pay Old](https://docs.number.tech/api-reference/rest-api-alt/text-to-pay.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.number.tech/api-reference.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.