> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bullring.finance/llms.txt
> Use this file to discover all available pages before exploring further.

# AI & agent tools

> Agent-ready capabilities and workflows for integrating with the Bullring Partner API.

THE AGENT

This section provides a downloadable, installable skill for AI coding agents. The skill packages Bullring’s authentication rules, API workflows, webhook contract, safety constraints, and reference links into one agent-readable file.

[Download `skill.md`](https://docs.bullring.finance/skill.md)

For installation instructions, harness-specific setup, and updates, see
[Install Bullring agent tools](https://docs.bullring.finance/ai-skills/install.md).

## Available skills

### Authenticate requests

Configure a registered RSA public key and generate request signatures from the exact canonical request bytes.

Relevant guides:

* [Authentication](https://docs.bullring.finance/01-authentication.md)
* [Request signing](https://docs.bullring.finance/03-signing.md)

### Create and monitor NGN deposits

Create or retrieve a virtual account, list deposits, retrieve a deposit by ID, and simulate sandbox deposits.

Relevant API pages:

* [Create virtual account](https://docs.bullring.finance/api-reference/deposits/create-virtual-account.md)
* [List deposits](https://docs.bullring.finance/api-reference/deposits/list.md)
* [Get deposit](https://docs.bullring.finance/api-reference/deposits/get.md)
* [Simulate deposit](https://docs.bullring.finance/api-reference/deposits/simulate.md)

### Manage recipients and withdrawals

Create and retrieve NGN recipients, create withdrawals, and monitor withdrawal status.

Relevant API pages:

* [Recipients](https://docs.bullring.finance/api-reference/recipients/list.md)
* [Create withdrawal](https://docs.bullring.finance/api-reference/withdrawals/create.md)
* [Get withdrawal](https://docs.bullring.finance/api-reference/withdrawals/get.md)

### Retrieve conversion quotes

Request an exchange-rate and fee quote before initiating a conversion.

Relevant API page:

* [Conversion quote](https://docs.bullring.finance/api-reference/quotes/conversion.md)

### Process webhook notifications

Receive deposit and withdrawal events through Convoy, verify `X-BULLRING-SIGNATURE`, deduplicate deliveries, and handle retries safely.

Relevant guides:

* [Webhook notifications](https://docs.bullring.finance/webhook-notifications.md)
* [Webhook verification](https://docs.bullring.finance/11-webhook-verification.md)

## Standard workflows

### Build a deposit integration

1. Register the partner public key in the dashboard.
2. Create or retrieve the NGN virtual account.
3. Store the account details and display them to the payer.
4. Receive and verify deposit webhook notifications.
5. Retrieve the deposit by ID when reconciliation requires a fresh status.

### Build a withdrawal integration

1. Create and validate an NGN recipient.
2. Request a withdrawal with an idempotency key.
3. Persist the returned withdrawal ID.
4. Process status notifications without assuming delivery order.
5. Retry only according to the documented error and idempotency rules.

## Constraints for agents

* Never expose private keys, webhook secrets, or signature values in logs or source control.
* Sign the exact method, path, headers, and raw body sent over the wire.
* Keep store scope attached to the registered integration.
* Do not use undocumented balance, Lightning deposit, or stablecoin withdrawal routes.
* Treat money values as decimal strings.
* Use sandbox simulation only for testing.

## Machine-readable resources

* [`/llms.txt`](https://docs.bullring.finance/llms.txt) — page index for AI tools.
* [`/llms-full.txt`](https://docs.bullring.finance/llms-full.txt) — complete documentation context.
* [`/skill.md`](https://docs.bullring.finance/skill.md) — generated or custom agent skill.
* [`/openapi.json`](https://docs.bullring.finance/openapi.json) — API schema.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.