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

# API reference overview

> Understand NorthFond API conventions before using the generated endpoint reference and interactive request builder.

Base URL: `https://payment.gideondevrel.xyz`

All `/api/v1/business/*` requests use a scoped bearer API key. Mutating requests require an `Idempotency-Key` unless an endpoint explicitly documents otherwise.

| Resource      | Endpoints                                                                   |
| ------------- | --------------------------------------------------------------------------- |
| Account       | `GET /api/v1/business/account`                                              |
| Customers     | `POST/GET /api/v1/business/customers`, `GET /api/v1/business/customers/:id` |
| Wallets       | `POST/GET /api/v1/business/wallets`, detail, balance, verification, archive |
| Beneficiaries | requirements, create, list, detail, update, archive                         |
| Quotes        | `POST /api/v1/business/quotes`, `GET /api/v1/business/quotes/:id`           |
| On-ramps      | readiness and initiation                                                    |
| Off-ramps     | initiation                                                                  |
| Transactions  | list, detail, settlement, confirmation, retry                               |

The endpoint pages in this section are generated from the repository's OpenAPI 3.1 contract. They include parameters, request and response schemas, and an interactive request builder.

<Warning>Use sandbox credentials while integrating. A successful request with an `nf_live_` key can affect real funds when the requested route is enabled.</Warning>