# Zuba

## Docs

- [Create a new API key](https://docs.zuba.com/api-reference/api-keys/create-a-new-api-key.md): Provisions a new M2M application in Auth0 and returns credentials. The client secret is only shown once.
- [Delete an API key](https://docs.zuba.com/api-reference/api-keys/delete-an-api-key.md): Permanently delete an API key from Auth0 and mark as inactive in database.
- [Get API key details](https://docs.zuba.com/api-reference/api-keys/get-api-key-details.md): Get details of a specific API key (client secret will be hidden)
- [Get available API scopes](https://docs.zuba.com/api-reference/api-keys/get-available-api-scopes.md): List all available API scopes/permissions that can be assigned to API keys
- [List all API keys](https://docs.zuba.com/api-reference/api-keys/list-all-api-keys.md): Get a list of all API keys for the authenticated user's workspace
- [Rotate client secret](https://docs.zuba.com/api-reference/api-keys/rotate-client-secret.md): Generate a new client secret for an API key. The old secret will be invalidated immediately.
- [Update API key scopes](https://docs.zuba.com/api-reference/api-keys/update-api-key-scopes.md): Update the permissions/scopes assigned to an API key
- [Create a cross-rate FX quote](https://docs.zuba.com/api-reference/fx-cross-rate-quotes/create-a-cross-rate-fx-quote.md)
- [Get a cross-rate quote by ID](https://docs.zuba.com/api-reference/fx-cross-rate-quotes/get-a-cross-rate-quote-by-id.md)
- [Get indicative cross-rates for display](https://docs.zuba.com/api-reference/fx-cross-rate-quotes/get-indicative-cross-rates-for-display.md): Returns current cross-rates for all supported corridors (NGN→GBP, NGN→EUR, NGN→USD). Rates include the exchange spread/markup but not fixed per-transaction fees. Intended for display purposes (e.g. dashboard rate ticker). Does not create a quote record.
- [Get supported cross-rate corridors](https://docs.zuba.com/api-reference/fx-cross-rate-quotes/get-supported-cross-rate-corridors.md)
- [Get current rate for a currency pair](https://docs.zuba.com/api-reference/fx/get-current-rate-for-a-currency-pair.md): Retrieve the most recent active exchange rate for a specific currency pair. The rate includes any applicable markup for your workspace. Use this to display current rates or validate conversions before creating transactions.
- [Get FX quote with amount conversion](https://docs.zuba.com/api-reference/fx/get-fx-quote-with-amount-conversion.md): Generate a foreign exchange quote for a specific amount and currency pair. The quote includes the exchange rate, source amount, converted amount, and quote expiration time. Quotes are typically valid for a limited time (check expiresAt field).
- [Get rate by ID](https://docs.zuba.com/api-reference/fx/get-rate-by-id.md): Retrieve a specific FX rate by its unique identifier. Useful for looking up historical rates or validating rates used in past transactions. Returns 404 if the rate has expired or does not exist.
- [API Reference](https://docs.zuba.com/api-reference/introduction.md): Complete API reference for the Zuba Payment Platform
- [Generate account statement for a specific currency](https://docs.zuba.com/api-reference/ledger/generate-account-statement-for-a-specific-currency.md): Generate a detailed account statement for a currency account between two dates. The statement includes opening balance, all transactions (debits and credits), and closing balance for the specified period. Useful for reconciliation and accounting purposes.
- [Get all accounts for current user (admin view)](https://docs.zuba.com/api-reference/ledger/get-all-accounts-for-current-user-admin-view.md): Retrieve a comprehensive list of all ledger accounts for the authenticated user. This admin-level view includes detailed account information for all currencies. Optionally include inactive accounts.
- [Get current user balance for a specific currency](https://docs.zuba.com/api-reference/ledger/get-current-user-balance-for-a-specific-currency.md): Retrieve balance details for a specific currency account. Currency code is case-insensitive (e.g., USD, usd, Usd all work).
- [Get current user balances across all currencies](https://docs.zuba.com/api-reference/ledger/get-current-user-balances-across-all-currencies.md): Retrieve your account balances in all currencies. Shows available balance (funds you can use), pending incoming/outgoing amounts, and total balance for each currency account.
- [Get transaction history for current user](https://docs.zuba.com/api-reference/ledger/get-transaction-history-for-current-user.md): Retrieve paginated transaction history for the authenticated user. Optionally filter by currency. Returns transactions in reverse chronological order (most recent first). Use limit and offset parameters for pagination.
- [Cancel manual deposit](https://docs.zuba.com/api-reference/pay-ins/cancel-manual-deposit.md): Cancel a pending manual deposit. Only deposits in pending status can be cancelled. Once a deposit is completed or failed, it cannot be cancelled.
- [Create deposit](https://docs.zuba.com/api-reference/pay-ins/create-deposit.md): Create a new deposit. This endpoint supports various payment methods, including generating bank account details (IBAN and BIC) for manual bank transfers, or initiating other provider-specific payin flows based on the provided currency and user details. For NGN currency, additional user details (firs…
- [Get deposit status](https://docs.zuba.com/api-reference/pay-ins/get-deposit-status.md): Check the status of any deposit by ID, regardless of the payment method. Returns current status, bank account details, and transaction information. For NGN payins, includes the virtual account details in metadata.
- [List manual deposits](https://docs.zuba.com/api-reference/pay-ins/list-manual-deposits.md): Retrieve a list of all manual deposits for the authenticated user. Optionally filter by status to find pending, completed, or failed deposits.
- [Cancel a payout](https://docs.zuba.com/api-reference/payouts/cancel-a-payout.md): Cancel a pending payout transaction
- [Create a new beneficiary](https://docs.zuba.com/api-reference/payouts/create-a-new-beneficiary.md): Create a new beneficiary with their account details for payouts
- [Create one or multiple payouts](https://docs.zuba.com/api-reference/payouts/create-one-or-multiple-payouts.md): Create a single payout or batch of payouts. Send a single payout object or an array of payout objects. The source currency can be specified via inputCurrency field, or will be automatically selected from the currency with the largest available balance.
- [Get beneficiary by ID](https://docs.zuba.com/api-reference/payouts/get-beneficiary-by-id.md): Retrieve a specific beneficiary and their account details
- [Get beneficiary field requirements for a currency](https://docs.zuba.com/api-reference/payouts/get-beneficiary-field-requirements-for-a-currency.md): Returns required and optional beneficiary fields based on destination currency. Aggregates requirements across all providers that support the currency.
- [Get payout by ID](https://docs.zuba.com/api-reference/payouts/get-payout-by-id.md): Retrieve details of a specific payout transaction
- [Get payout receipt](https://docs.zuba.com/api-reference/payouts/get-payout-receipt.md): Download a receipt/proof of payment for a completed payout
- [List all beneficiaries](https://docs.zuba.com/api-reference/payouts/list-all-beneficiaries.md): Retrieve a list of all beneficiaries with their account details for the current user's client
- [List Nigerian banks](https://docs.zuba.com/api-reference/payouts/list-nigerian-banks.md): Returns the list of Nigerian banks with their names and CBN bank codes. Used to populate bank picker dropdowns for NGN payouts.
- [List payouts](https://docs.zuba.com/api-reference/payouts/list-payouts.md): Get a paginated list of payouts sorted by created_at desc with optional filters
- [Resolve GB IBAN from sort code and account number](https://docs.zuba.com/api-reference/payouts/resolve-gb-iban-from-sort-code-and-account-number.md): Looks up the IBAN, BIC, and bank name for a UK bank account using the sort code and account number.
- [Resolve Nigerian bank account name](https://docs.zuba.com/api-reference/payouts/resolve-nigerian-bank-account-name.md): Look up the account holder name for a Nigerian bank account given a bank code and account number. Used to auto-fill recipient names for NGN payouts without requiring users to type in the name.
- [Update beneficiary](https://docs.zuba.com/api-reference/payouts/update-beneficiary.md): Update an existing beneficiary's information
- [Create a webhook endpoint](https://docs.zuba.com/api-reference/webhooks/create-a-webhook-endpoint.md)
- [Delete a webhook endpoint](https://docs.zuba.com/api-reference/webhooks/delete-a-webhook-endpoint.md)
- [Get a webhook endpoint](https://docs.zuba.com/api-reference/webhooks/get-a-webhook-endpoint.md)
- [List all webhook endpoints](https://docs.zuba.com/api-reference/webhooks/list-all-webhook-endpoints.md)
- [List delivery attempts for a webhook endpoint](https://docs.zuba.com/api-reference/webhooks/list-delivery-attempts-for-a-webhook-endpoint.md)
- [Rotate the signing secret for a webhook endpoint](https://docs.zuba.com/api-reference/webhooks/rotate-the-signing-secret-for-a-webhook-endpoint.md)
- [Send a test webhook event to this endpoint](https://docs.zuba.com/api-reference/webhooks/send-a-test-webhook-event-to-this-endpoint.md)
- [Update a webhook endpoint](https://docs.zuba.com/api-reference/webhooks/update-a-webhook-endpoint.md)
- [Authentication](https://docs.zuba.com/authentication.md): Learn how to authenticate with the Zuba API using OAuth 2.0
- [Ledger System](https://docs.zuba.com/concepts/ledger.md): Double-entry bookkeeping and transaction management
- [Platform Overview](https://docs.zuba.com/concepts/overview.md): Understanding the Zuba Payment Platform architecture
- [Payins](https://docs.zuba.com/concepts/payins.md): Accept payments globally with Zuba payins
- [Payouts](https://docs.zuba.com/concepts/payouts.md): Send money globally with Zuba payouts
- [Batch Payouts](https://docs.zuba.com/guides/batch-payouts.md): Process multiple payouts efficiently with batch operations
- [Error Handling](https://docs.zuba.com/guides/error-handling.md): Handle errors and edge cases gracefully in your payment integration
- [Your First Payout](https://docs.zuba.com/guides/first-payout.md): Step-by-step guide to sending your first payout using the Zuba Payment Platform
- [Sandbox Testing](https://docs.zuba.com/guides/sandbox-testing.md): Use documented test values in the Zuba sandbox to obtain deterministic payout outcomes for integration testing
- [Webhook Notifications](https://docs.zuba.com/guides/webhooks.md): Set up real-time notifications for payment events using webhooks
- [Introduction](https://docs.zuba.com/introduction.md): Zuba Payment Platform API — global payouts, payment acceptance, and multi-currency operations
- [Quickstart](https://docs.zuba.com/quickstart.md): Start building with Zuba in under 5 minutes

## OpenAPI Specs

- [openapi](https://docs.zuba.com/openapi.json)