Admin API service
The unified REST interface used by the FSP for all administrative tasks, including managing assets, wallet addresses, and initiating payments. This is the primary point of integration.
Integrate Rhyza with your FSP
Last reviewed: Oct 5, 2026
You must be, or be working with, a financial service provider (FSP). An FSP is an entity that provides and maintains payment accounts for its customers and is regulated in the jurisdictions it operates. Examples of FSPs include banks, digital wallet providers, and mobile money providers. The financial service provider page provides examples of an FSP’s responsibilities and obligations.
For testing purposes, you can use the Local Playground to run two mock FSPs that automatically peer with one another. However, Rhyza should not be used in production environments by non-regulated FSPs.
From an integration perspective, Rhyza is structured around the core system (which processes payments, runs the ledger, handles wallet address registration and peering, and dispatches webhooks), the internal Admin API, and the external Open Payments APIs.
Rhyza’s API services consist of the following:
Open Payments authorization server
Standalone service implementing the Open Payments authorization server specification. It must be deployed to handle authorization grants from external clients.
Open Payments resource server
Standalone service that hosts and manages access to protected Open Payments resources. It must be deployed to expose wallet addresses and payment resources to the network.
Integration checklist
Review the checklist for all required and optional integration steps.
Set up assets
Required An asset is a monetary unit represented by a currency code and a scale. Rhyza must be set up for at least one asset.
Create a base wallet address
Required Each payment account in the FSP’s system must be linked to a wallet address. Rhyza must be set up with at least one asset before creating wallet addresses.
Expose a webhook endpoint
Required The FSP must expose a webhook endpoint that listens for events dispatched by Rhyza, then react accordingly by calling/interfacing with the Admin API. For example, to approve payments.
The following steps provide an example of using the Admin API to make a basic payment between two wallet addresses on the same Rhyza instance.
1. Create an incoming payment
Use POST /payment-intents to create an incoming payment resource on the
recipient’s wallet account.
2. Create a quote
Use POST /quotes to create a quote resource on the sender’s wallet account.
The quote shows how much it will cost the sender to deliver an amount to the
receiver.
3. Create a payment
Use POST /payments to create a payment resource on the sender’s wallet
account. This operation starts the payment. The payment must be
funded/approved before it can be sent.
Handle webhook requests
As the payment flow progresses, you (as the FSP) are notified about events that happen in your system. Some events are actionable, such as payment.created. Review the Webhook Events page to learn more about handling each event.