canonical: https://jentic.com/apis/8b.world/8b-world

# 8B World Payment API

Jentic publishes the only available OpenAPI specification for 8B World Payment API, keeping it validated and agent-ready. The 8B World Payment API is a payment processing platform interface for managing the back-office accounts that underpin merchant settlement. It exposes admin account lifecycle, settlement account configuration, settlement instrument provisioning, and contact management, all gated by an OAuth-issued bearer token. Sixteen endpoints cover authorization, account creation and updates, status changes, and listing summaries used to operate a payment program at scale.

## For AI agents

Provision and manage 8B World admin accounts, settlement accounts, settlement instruments, and contacts via a bearer-authenticated REST API. Use it to run back-office configuration tasks for a payment processing program.

## Scope

Does not handle card acquiring, fraud scoring, or end-customer checkout - use for back-office admin and settlement configuration only.

## Capabilities

- Authenticate admin sessions and refresh tokens through the OAuth client-credentials endpoints
- Create, retrieve, and update admin accounts that own settlement configuration
- Toggle admin account status to activate, suspend, or close an operator
- Provision and update settlement accounts that route funds to merchant bank details
- Register settlement instruments (cards, bank rails) tied to a settlement account
- Add and update contacts attached to settlement accounts for notifications and approvals
- Pull a short-info list of admin accounts for back-office dashboards

## Use cases

### Merchant Onboarding for a Payment Program

When a payment program operator brings a new merchant onto 8B World, the back office must create the admin account, attach a settlement account with the correct bank details, register the settlement instrument, and add finance and operations contacts. The 8B World Payment API exposes each of these steps as discrete endpoints, so onboarding can be scripted end-to-end rather than entered through a portal. A complete onboarding sequence runs in under a minute once authentication is in place.

Example prompt: Create an admin account, then create a linked settlement account with merchant bank IBAN, then register a card settlement instrument, and verify status is active

### Settlement Configuration Updates

Settlement details change frequently in payment operations: a merchant updates a bank account, a finance contact rotates, or a settlement instrument is replaced. The 8B World Payment API supports targeted PUT and PATCH operations on settlement accounts, settlement instruments, and contacts, so update flows can run without rebuilding the entire admin record. This keeps settlement reliable when underlying details change mid-cycle.

Example prompt: Update the bank account on settlement account ID 1234 and patch the admin account status to active

### Operator Status Management

Compliance and risk teams need to suspend or restore admin accounts quickly when issues are detected. The 8B World Payment API offers a dedicated PATCH endpoint on the admin account status field, separating routine updates from sensitive status transitions. This lets reviewers act in near real time without exposing the rest of the admin record to mass updates.

Example prompt: Patch the status of admin account ID 7821 to suspended and confirm the change with a follow-up GET

### Agent-Driven Back-Office Automation

AI agents can drive 8B World admin tasks through Jentic without browsing the portal or hand-rolling auth. A single Jentic search returns the right operation along with its input schema, and credentials stay isolated in your Jentic One instance. Agents handle ticket-driven onboarding and updates while humans review the resulting records.

Example prompt: Search Jentic for 'create an 8B World admin account', load the schema, and execute the call with the merchant's details

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | /api/v1/admin-accounts/oauth/authorize | Obtain a client access token |
| POST | /api/v1/admin-accounts | Create an admin account |
| PATCH | /api/v1/admin-accounts/{id}/status | Modify admin account status |
| POST | /api/v1/admin-accounts/settlement-accounts | Create a settlement account |
| POST | /api/v1/admin-accounts/settlement-instruments | Create a settlement instrument |
| POST | /api/v1/admin-accounts/settlement-accounts-contacts/contacts | Create contacts on a settlement account |

## Key resources

- **Admin Accounts** — Create, retrieve, update, and list admin accounts; toggle status via PATCH
- **OAuth Tokens** — Authorize, refresh, and terminate sessions for the bearer token used on every call
- **Settlement Accounts** — Create, retrieve, and update settlement accounts that hold bank routing details
- **Settlement Instruments** — Register and update the cards or bank rails that move funds for a settlement account
- **Settlement Contacts** — Attach and update contacts associated with a settlement account

## Why Jentic

- **Setup:** Wiring the 8B World Payment API by hand means managing its bearer token, running the admin-account OAuth authorize step, and shaping settlement-account and instrument payloads yourself. Through Jentic you install once, import the 8B World Payment API from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** 8B World puts the admin-account id in the URL path (/admin-accounts/{id}/status), so a rule can pin your agent to one admin account for that status update. You choose the operations it may call, so creating settlement accounts or instruments is not included unless you add them.
- **Credential handling:** Your 8B World bearer token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create a settlement account' or 'update an admin account status', and Jentic returns the matching 8B World operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Adyen Balance Platform** — Adyen's platform API for managing balance accounts, payment instruments, and account holders for marketplaces and platforms.
- **ABN AMRO Payment Initiation (PSD2)** — PSD2 payment initiation API for SEPA and cross-border payments out of ABN AMRO accounts.
- **1Forge** — Real-time foreign exchange rates for currency conversion.

## FAQ

### Why is there no official OpenAPI spec for 8B World Payment API?

8B World does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call 8B World Payment API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the 8B World Payment API use?

The API uses HTTP bearer authentication. Clients first call POST /api/v1/admin-accounts/oauth/authorize to obtain an access token, then send it as Authorization: Bearer <token> on every subsequent call. Through Jentic, the bearer token is held in your Jentic One instance and injected at execution time, so the raw token never reaches the agent's prompt.

### Can I create and update settlement accounts with the 8B World Payment API?

Yes. POST /api/v1/admin-accounts/settlement-accounts creates a settlement account, GET /api/v1/admin-accounts/settlement-accounts/{id} retrieves it, and PUT on the same path updates it. Settlement instruments and contacts attached to the account each have their own endpoints under /api/v1/admin-accounts/settlement-instruments and /api/v1/admin-accounts/settlement-accounts-contacts.

### How do I suspend an admin account through Jentic?

Search Jentic for 'change admin account status' to find PATCH /api/v1/admin-accounts/{id}/status, load the schema, and execute the call with the new status value. Jentic returns the structured response so an agent can verify the change with a follow-up GET on the same admin account ID.

### What are the rate limits for the 8B World Payment API?

The OpenAPI spec does not document explicit rate limits. Treat the API as standard back-office tooling: serialize bursts of writes and add retry with backoff for any 429 or 5xx responses. Confirm production limits with 8B World support before high-volume use.

### How do I terminate an 8B World session?

Call POST /api/v1/admin-accounts/oauth/logout with the active bearer token to invalidate the session. Through Jentic, this can be wired into an agent's cleanup step so credentials are not left active longer than necessary.

### Can I limit what my agent is allowed to do with the 8B World Payment API?

Yes. Jentic One is self-hosted, so your own rules decide which 8B World operations and credentials the agent may use. Because the API puts the admin-account id in the URL path, such as PATCH /api/v1/admin-accounts/{id}/status, you can pin the agent to one admin account for a status change. You also choose the operations it may call, so creating settlement accounts or registering settlement instruments stays off limits unless you explicitly allow it.
