# BillBuddy API ## Integration guide ### Get started - [Introduction](https://docs.billbuddyhq.com/en/introduction.md): Integrate BillBuddy payments and subscriptions through a unified API - [Quickstart](https://docs.billbuddyhq.com/en/quickstart.md): Authentication, identifiers, amounts, dates and hosted subscription integration ## API reference ### Transactions - [Create a direct payment](https://docs.billbuddyhq.com/en/api-reference/transactions/direct-pay.md): ### Parameters by transaction operation - [Create batch direct payments](https://docs.billbuddyhq.com/en/api-reference/transactions/batch-direct-pay.md): ### Parameters for each transaction - [Cancel scheduled payments](https://docs.billbuddyhq.com/en/api-reference/transactions/cancel-direct-pay.md): Only scheduled transactions belonging to the current merchant and business, with Pending status and not already cancelled, can be cancelled. Cancellation must occur strictly before 08:15 Australia/Sydney on process_date. Cancellation is no longer permitted at the cutoff; immediate transactions canno… - [Query a transaction](https://docs.billbuddyhq.com/en/api-reference/transactions/query-transaction.md): Look up the current status of an existing payment, refund or dispute. Use an OAuth2 Bearer token; no request signature is required. Supply at least one of order_number and merchant_order_no. If both are provided, they must identify the same transaction. If a third-party reference matches multiple tr… - [List transactions](https://docs.billbuddyhq.com/en/api-reference/transactions/list-transactions.md): Retrieve transactions for the authenticated merchant, paginated with the newest records first. This is a read-only lookup and does not execute payments again. - [Upload a TXT transaction file](https://docs.billbuddyhq.com/en/api-reference/transactions/bulk-upload.md): Upload a fixed-width TXT file using multipart/form-data for asynchronous bank account or payment token transactions. Use an OAuth2 Bearer token; no request signature or customer identifier is required. Let your upload tool generate the Content-Type boundary. - [Query a TXT batch and its details](https://docs.billbuddyhq.com/en/api-reference/transactions/bulk-upload-result.md): Retrieve a batch and its per-record processing results for the authenticated merchant, optionally filtered by business. Use an OAuth2 Bearer token; no request signature is required. Supply batch_id or file_identifier. When both are supplied, they must match the same batch. ### Subscriptions - [List available subscription templates](https://docs.billbuddyhq.com/en/api-reference/subscriptions/templates.md): Lists subscription templates available to the authorized merchant and specified business. Only ACTIVE, enabled, non-tiered templates other than By agreement are returned, ordered by creation time descending. Price filters apply to the latest template price. Callers must ensure each range starts at o… - [Create a hosted subscription](https://docs.billbuddyhq.com/en/api-reference/subscriptions/create.md): ### Choose a subscription mode - [Create and activate a DDR](https://docs.billbuddyhq.com/en/api-reference/subscriptions/create-ddr.md): ### Customer, subscription and payment method - [Add a payment schedule to a By agreement DDR](https://docs.billbuddyhq.com/en/api-reference/subscriptions/create-schedule.md): ### Parameters by schedule type ### Authentication - [Obtain an OAuth access token](https://docs.billbuddyhq.com/en/api-reference/authentication/token.md): Obtains an access token using OAuth2 client_credentials. Client credentials must be approved, enabled, not revoked and not expired. If an IP allowlist is configured, business requests must originate from an approved IP. Use the Client Secret and access_token only on the merchant server. Request a ne… ## OpenAPI Specs - [billbuddy-v2-openapi.en](/openapi/billbuddy-v2-openapi.en.yaml) > The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages. ## Indexes - [Chinese (14 pages)](https://docs.billbuddyhq.com/_llms/cn.txt): Documentation for Chinese. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.