canonical: https://jentic.com/apis/openpayd.com/openpayd # OpenPayd API Jentic publishes the only available OpenAPI specification for OpenPayd API, keeping it validated and agent-ready. OpenPayd is a banking-as-a-service platform that lets businesses spin up named multi-currency accounts, manage beneficiaries, send international payouts, and run currency conversions through a single API. The 42-endpoint surface covers linked-client onboarding, account creation, beneficiary lifecycle, transactions, and FX, making it suitable for fintechs and marketplaces that need embedded banking infrastructure in Europe and the UK. ## For AI agents Spin up multi-currency accounts, manage beneficiaries, send payouts, and run FX through OpenPayd's banking-as-a-service API. ## Scope Does not handle card acquiring, in-store POS, or merchant chargebacks - use for embedded multi-currency accounts, payouts, and FX only. ## Capabilities - Onboard linked clients (individuals or businesses) under the master account - Open multi-currency virtual accounts for each linked client - Create, retrieve, and update beneficiaries before sending funds - Initiate SEPA, SWIFT, and Faster Payments payouts to verified beneficiaries - Run currency conversions between supported currency pairs - List historical transactions on a linked-client account - Authenticate via OAuth bearer JWT obtained from `/oauth/token` ## Use cases ### Embedded multi-currency accounts for marketplace sellers A marketplace creates a linked client per seller, opens GBP and EUR virtual accounts under each, and lets sellers receive payouts directly into named accounts. OpenPayd handles the underlying banking rails so the marketplace does not need its own e-money licence. Onboarding to live is typically a few weeks, mostly KYB. Example prompt: POST /create-business-linked-client for the seller, then open EUR and GBP accounts via the linked-client account endpoint and return both IBANs. ### Cross-border payouts with SEPA and SWIFT Treasury teams use OpenPayd to send batched payouts to suppliers across the EU, UK, and major SWIFT corridors. The beneficiary endpoints store verified counterparties and the payout endpoints initiate transfers with the correct rail selected per destination, reducing manual SWIFT MT103 work. Example prompt: Look up the saved beneficiary by ID, then submit a payout for 25,000 EUR via SEPA and confirm the response status is accepted. ### FX conversion before settlement A platform settling earnings to a seller in a different currency converts funds via OpenPayd's FX endpoints before payout, reducing exposure compared with on-rail FX at the receiving bank. The API exposes quote, execute, and settle steps so the agent can confirm rate and amount before committing. Example prompt: Request an FX quote for 100,000 EUR to GBP, accept the quote, and confirm the converted amount appears on the destination account. ### Agent-driven embedded finance through Jentic An AI ops agent that runs supplier payouts calls OpenPayd via Jentic to refresh the bearer token, look up beneficiaries, and submit transfers. Jentic isolates the OAuth client credentials and exposes the 42 banking operations as discoverable tools so the agent does not need to track token lifetime manually. Example prompt: Search Jentic for 'send a SEPA payout', load the matching operation, and execute it for a saved beneficiary with amount 5,000 EUR. ## Key endpoints | Method | Path | Description | | --- | --- | --- | | POST | `/oauth/token` | Obtain a bearer token for subsequent calls | | POST | `/create-linked-client` | Onboard an individual linked client | | POST | `/create-business-linked-client` | Onboard a business linked client | | GET | `/get-linked-client` | Retrieve a linked client record | | GET | `/list-linked-clients` | List linked clients under the master account | | GET | `/list-accounts-for-linked-clients` | List multi-currency accounts for linked clients | ## Key resources - **Linked clients** — Onboard and manage individual or business clients under the master account - **Accounts** — Open and manage multi-currency virtual accounts per linked client - **Beneficiaries** — Create, update, and look up payout counterparties - **Payments** — Initiate SEPA, SWIFT, and Faster Payments transfers - **FX** — Quote and execute currency conversions between supported pairs - **Transactions** — List and retrieve account transaction history ## Why Jentic - **Setup:** Wiring the OpenPayd API by hand means running its OAuth token exchange, choosing between the sandbox and production hosts, and refreshing the JWT bearer before each accounts, payout, or FX call across a 42-endpoint surface. Through Jentic you install once, import the OpenPayd API from the API Directory, store the client credentials once, and your agent calls it. - **Permission scoping:** You limit the agent to the operations it needs, such as opening a multi-currency account or listing linked clients. You choose which operations it may call, so payout initiation is not included unless you add it. - **Credential handling:** Your OpenPayd OAuth client credentials are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'open a multi-currency account' or 'send a payout', and Jentic returns the matching OpenPayd operation with its input schema so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **Stripe API** — Card processing and Connect-based payouts to connected accounts - **GoCardless API** — Direct debit collections to fund the OpenPayd accounts that send payouts - **TrueLayer API** — Open banking payment initiation alongside OpenPayd's account infrastructure ## FAQ ### Why is there no official OpenAPI spec for OpenPayd API? OpenPayd does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call OpenPayd 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 OpenPayd API use? OpenPayd uses OAuth 2.0 with a JWT bearer token obtained from `/oauth/token.` Through Jentic, the client credentials live in the encrypted vault and Jentic refreshes and attaches the bearer token automatically, so the agent never handles the raw client secret. ### Can I open multi-currency accounts with the OpenPayd API? Yes. After onboarding a linked client via /create-linked-client or /create-business-linked-client, you open named accounts under that client; the spec exposes endpoints to list accounts per linked client and retrieve their details. ### What are the rate limits for the OpenPayd API? OpenPayd applies platform-level rate limits that are not encoded in the OpenAPI spec. Treat the sandbox as a guide for shape and confirm production limits with OpenPayd before scheduling high-volume payout batches. ### How do I send a SEPA payout through Jentic? Run pip install jentic, search 'send a SEPA payout', load the matching payments operation, and execute it with the beneficiary ID, amount, and currency. Jentic obtains the bearer token from `/oauth/token` first, then calls the payout endpoint. ### Does the spec point at sandbox or production? The default base URL in the spec is https://sandbox.openpayd.com/api, the OpenPayd Sandbox Environment. For production traffic, switch the server to OpenPayd's live host once your account has been promoted out of sandbox. ### Can I limit what my agent is allowed to do with the OpenPayd API? Yes. Jentic One is self-hosted by you, so your own rules decide which of OpenPayd's 42 operations and which client credentials the agent may use. You can allow read-only calls such as listing linked clients or opening a multi-currency account while withholding payout initiation like SEPA and SWIFT transfers unless you explicitly grant them. Because you choose the operations the agent can call, sensitive actions such as sending funds to a beneficiary stay off-limits until you add them.