# SpherePay

## Docs

- [Delete a Registered Customer Bank Account](https://docs.spherepay.co/api-reference/bank-account/delete-id.md): DELETE /v2/bank-account/{id} — Remove a registered bank account from SpherePay. Cannot delete accounts with pending or active transfers.
- [List All Registered Customer Bank Accounts](https://docs.spherepay.co/api-reference/bank-account/get.md): GET /v2/bank-account — Retrieve all bank accounts registered in your SpherePay account. Optionally filter by customer ID or currency.
- [Retrieve a Bank Account by ID](https://docs.spherepay.co/api-reference/bank-account/get-id.md): GET /v2/bank-account/{id} — Retrieve a single bank account by ID, including account details, currency, supported networks, and linked customer.
- [Update Bank Account Payment Rail Settings](https://docs.spherepay.co/api-reference/bank-account/patch-id.md): PATCH /v2/bank-account/{id} — Update mutable fields on a registered bank account, such as the enabled payment rail networks for ACH, Wire, or SEPA.
- [Register a Customer Bank Account for Transfers](https://docs.spherepay.co/api-reference/bank-account/post.md): POST /v2/bank-account — Link a customer's fiat bank account to SpherePay. Supports USD via ACH/Wire, EUR via SEPA, and BRL via PIX. Returns a bank account ID.
- [Remove a Business Representative or UBO](https://docs.spherepay.co/api-reference/business-representative/delete-id.md): DELETE /v2/business-representative/{id} — Remove a business representative from a business customer's KYB profile before submission.
- [List All Business Representatives and UBOs](https://docs.spherepay.co/api-reference/business-representative/get.md): GET /v2/business-representative — Retrieve all business representatives registered for business customers in your SpherePay account.
- [Retrieve a Business Representative by ID](https://docs.spherepay.co/api-reference/business-representative/get-id.md): GET /v2/business-representative/{id} — Retrieve a single business representative by ID, including identity details, ownership stake, and verification status.
- [Update a Business Representative Before KYB](https://docs.spherepay.co/api-reference/business-representative/patch-id.md): PATCH /v2/business-representative/{id} — Update mutable fields for a business representative before KYB submission, such as address or contact details.
- [Register a Business UBO for KYB Verification](https://docs.spherepay.co/api-reference/business-representative/post.md): POST /v2/business-representative — Register a business representative or Ultimate Beneficial Owner (UBO) for a business customer undergoing KYB verification.
- [List Customers with Filters and Pagination](https://docs.spherepay.co/api-reference/customer/get.md): GET /v2/customer — Retrieve a paginated list of all customers. Filter by verification status, customer type (individual or business), and creation date.
- [Retrieve a Customer with Verification Status](https://docs.spherepay.co/api-reference/customer/get-id.md): GET /v2/customer/{id} — Retrieve a single customer by ID, including verification profile status, registered bank accounts, and wallets.
- [Submit a Customer for KYC or KYB Review](https://docs.spherepay.co/api-reference/customer/kyc.md): POST /v2/customer/{id}/kyc — Submit a customer for KYC or KYB review after all required documents and verification steps have been completed.
- [Update Customer Address, Phone, or Email](https://docs.spherepay.co/api-reference/customer/patch-id.md): PATCH /v2/customer/{id} — Update a customer's mutable fields such as address, phone, or email. Some fields cannot be changed after KYC submission.
- [Create an Individual or Business Customer](https://docs.spherepay.co/api-reference/customer/post.md): POST /v2/customer — Create an individual or business customer. Required before any transfer. Accepts type, email, phone, address, and identity fields.
- [Upload KYC and KYB Identity Documents](https://docs.spherepay.co/api-reference/document/post.md): POST /v2/document — Upload KYC/KYB identity documents for a customer, including government-issued ID, proof of address, and liveness reports.
- [Generate a Customer Face Verification Link](https://docs.spherepay.co/api-reference/enhanced-due-diligence/face-verification-link.md): POST /v2/enhanced-due-diligence/face-verification-link — Generate a face liveness verification link for an individual customer. For Sphere-Managed KYC.
- [Send an OTP Code for Customer Verification](https://docs.spherepay.co/api-reference/enhanced-due-diligence/send-verification-code.md): POST /v2/enhanced-due-diligence/send-verification-code — Send an OTP verification code to a customer's email address or phone number during KYC.
- [Record Customer Terms of Service Acceptance](https://docs.spherepay.co/api-reference/enhanced-due-diligence/tos.md): POST /v2/enhanced-due-diligence/tos — Record a customer's acceptance of SpherePay's Terms of Service during the Sphere-Managed KYC/KYB onboarding flow.
- [Generate a UBO Face Verification Link for KYB](https://docs.spherepay.co/api-reference/enhanced-due-diligence/ubo-face-verification-link.md): POST /v2/enhanced-due-diligence/ubo-face-verification-link — Generate a face liveness link for a business UBO. Part of Sphere-Managed KYB verification.
- [Verify a Customer OTP Code for Email or Phone](https://docs.spherepay.co/api-reference/enhanced-due-diligence/verify-verification-code.md): POST /v2/enhanced-due-diligence/verify-verification-code — Verify an OTP code sent to a customer's email or phone to confirm contact details during KYC.
- [List All Offloader Wallets for Your Account](https://docs.spherepay.co/api-reference/offloader-wallet/get.md): GET /v2/offloader-wallet — Retrieve all Offloader Wallets in your SpherePay account. Filter by customer ID, stablecoin network, or active status.
- [Retrieve an Offloader Wallet by ID](https://docs.spherepay.co/api-reference/offloader-wallet/get-id.md): GET /v2/offloader-wallet/{id} — Retrieve a single Offloader Wallet by ID, including on-chain address, linked bank account, network, and status.
- [Update an Offloader Wallet Bank Destination](https://docs.spherepay.co/api-reference/offloader-wallet/patch-id.md): PATCH /v2/offloader-wallet/{id} — Update mutable fields on an Offloader Wallet, including the linked bank account destination and integrator fee rate.
- [Create an Offloader Wallet for Crypto Payouts](https://docs.spherepay.co/api-reference/offloader-wallet/post.md): POST /v2/offloader-wallet — Create a dedicated on-chain wallet address for a customer that automatically converts stablecoin deposits to fiat bank payouts.
- [List All Rate-Locked Quotes for Your Account](https://docs.spherepay.co/api-reference/quote/get.md): GET /v2/quote — List quotes for the authenticated application. Supports pagination and filtering by customer ID and status (active, used, expired).
- [Retrieve a Quote by ID](https://docs.spherepay.co/api-reference/quote/get-id.md): GET /v2/quote/{id} — Look up a single rate-locked quote by ID. Returns full status, fee breakdown, exchange rate, expiration, and customer ID.
- [Create a Rate-Locked Quote](https://docs.spherepay.co/api-reference/quote/post.md): POST /v2/quote — Generate a locked exchange rate for an on-ramp or off-ramp transfer. The quote is valid for 30, 60, or 300 seconds and can be redeemed once.
- [Update Quote Status](https://docs.spherepay.co/api-reference/quote/put-id.md): PUT /v2/quote/{id} — Mark an active quote as used or expired. Only active quotes can be updated. Used quotes are consumed; expired quotes are voided.
- [Cancel an Unfunded Pending Transfer](https://docs.spherepay.co/api-reference/transfer/delete-id.md): DELETE /v2/transfer/{id} — Cancel a transfer that has not yet been funded. Only transfers in pendingFunding status can be canceled.
- [List On-Ramp and Off-Ramp Transfers](https://docs.spherepay.co/api-reference/transfer/get.md): GET /v2/transfer — Retrieve a paginated list of transfers. Filter by customer ID, status, type (on_ramp or off_ramp), and date range.
- [Retrieve a Transfer with Deposit Instructions](https://docs.spherepay.co/api-reference/transfer/get-id.md): GET /v2/transfer/{id} — Retrieve a single transfer by ID, including full status, source, destination, amount, and depositInstructions for crypto off-ramp.
- [Create an On-Ramp or Off-Ramp Transfer](https://docs.spherepay.co/api-reference/transfer/post.md): POST /v2/transfer — Initiate an on-ramp or off-ramp transfer for a verified customer. Requires customer ID, source, and destination with currency and network.
- [Deactivate an Onramper Virtual Bank Account](https://docs.spherepay.co/api-reference/virtual-account/deactivate.md): POST /v2/virtual-account/{id}/deactivate — Deactivate an Onramper Account to stop processing new deposits. The account can be reactivated later.
- [List All Onramper Virtual Bank Accounts](https://docs.spherepay.co/api-reference/virtual-account/get.md): GET /v2/virtual-account — Retrieve all Onramper Accounts (virtual bank accounts) in your SpherePay account, with filtering by customer and status.
- [Retrieve an Onramper Account by ID](https://docs.spherepay.co/api-reference/virtual-account/get-id.md): GET /v2/virtual-account/{id} — Retrieve a single Onramper Account by ID, including virtual bank account details, destination wallet, and status.
- [List Transfers for an Onramper Account](https://docs.spherepay.co/api-reference/virtual-account/list-transfers.md): GET /v2/virtual-account/{id}/transfers — List all transfers processed through a specific Onramper Account, with pagination and date filtering.
- [Update an Onramper Account Destination Wallet](https://docs.spherepay.co/api-reference/virtual-account/patch.md): PATCH /v2/virtual-account/{id} — Update mutable fields on an Onramper Account such as the destination wallet address or account name.
- [Create a Virtual Bank Account for Fiat On-Ramp](https://docs.spherepay.co/api-reference/virtual-account/post.md): POST /v2/virtual-account — Create an Onramper Account: a virtual bank account that auto-converts fiat deposits to stablecoins and delivers them on-chain.
- [Reactivate a Deactivated Onramper Account](https://docs.spherepay.co/api-reference/virtual-account/reactivate.md): POST /v2/virtual-account/{id}/reactivate — Reactivate a previously deactivated Onramper Account to resume processing fiat deposits.
- [Remove a Registered Customer Crypto Wallet](https://docs.spherepay.co/api-reference/wallet/delete-id.md): DELETE /v2/wallet/{id} — Remove a registered wallet from SpherePay. Cannot delete wallets that are the destination or source of active transfers.
- [List All Registered Customer Crypto Wallets](https://docs.spherepay.co/api-reference/wallet/get.md): GET /v2/wallet — Retrieve all crypto wallets registered in your SpherePay account. Filter by customer ID, blockchain network, or stablecoin currency.
- [Retrieve a Customer Crypto Wallet by ID](https://docs.spherepay.co/api-reference/wallet/get-id.md): GET /v2/wallet/{id} — Retrieve a single registered wallet by ID. Returns the on-chain address, network, stablecoin currency, and linked customer ID.
- [Register a Customer Crypto Wallet for Transfers](https://docs.spherepay.co/api-reference/wallet/post.md): POST /v2/wallet — Register a customer's existing blockchain wallet address. Supports Ethereum, Solana, Polygon, Base, Tron, Arbitrum, Avalanche, and Starknet.
- [SpherePay API Release Notes and Changelog](https://docs.spherepay.co/changelog.md): Latest SpherePay API updates, including new features, breaking changes, deprecations, compliance updates, and newly supported payment rails and assets.
- [Offloader Wallets: Automated Crypto-to-Fiat](https://docs.spherepay.co/concepts/automation/offloader-wallets.md): Offloader Wallets give each customer a dedicated on-chain address that automatically converts incoming stablecoins to fiat bank payouts.
- [Onramper Accounts: Automated Fiat-to-Stablecoin](https://docs.spherepay.co/concepts/automation/onramper-accounts.md): Onramper Accounts give each customer a dedicated virtual bank account that automatically converts fiat deposits to stablecoins on-chain.
- [KYB for Business Customers](https://docs.spherepay.co/concepts/onboarding/business-kyb.md): Onboard business customers through KYB verification. Submit company documents, register UBOs, and complete identity verification via API or hosted link.
- [KYC for Individual Customers](https://docs.spherepay.co/concepts/onboarding/individual-kyc.md): Onboard individual customers with KYC identity verification. Choose API or hosted link, with Sphere-Managed or Platform-Managed compliance.
- [Onboard Customers with a Hosted KYC Link](https://docs.spherepay.co/concepts/onboarding/kyc-via-link.md): Use SpherePay's hosted onboarding link to verify customers without building a custom UI. Redirect customers to complete KYC or KYB in minutes.
- [Customers & Onboarding in SpherePay](https://docs.spherepay.co/concepts/onboarding/overview.md): Before any transfer can occur, customers must be created and verified. Learn about KYC for individuals and KYB for businesses in SpherePay.
- [Customer Verification Profile and Statuses](https://docs.spherepay.co/concepts/onboarding/verification-profile.md): The verification profile tracks a customer's KYC or KYB approval state. Learn what each status means and what triggers transitions between states.
- [API Rate Limits and Best Practices](https://docs.spherepay.co/concepts/operational/rate-limits.md): SpherePay enforces 100 RPS for read and write operations. Learn how to handle rate limit errors, implement retry logic, and request temporary increases.
- [SpherePay Concepts and Reference Data Overview](https://docs.spherepay.co/concepts/overview.md): Core mental models and reference data for building on SpherePay — onboarding, transfers, automation, supported rails, and operational details.
- [Payment Channel Codes in SpherePay](https://docs.spherepay.co/concepts/reference/channel-codes.md): Reference for network and channel codes used in SpherePay transfer requests, including ach, wire, sepa, pix, and blockchain network identifiers.
- [Prohibited Countries and Sanctioned Regions](https://docs.spherepay.co/concepts/reference/prohibited-countries.md): Reference list of countries and jurisdictions where SpherePay accounts cannot be opened, plus the regional restrictions that apply for sanctioned regions.
- [Supported Currency Codes in SpherePay](https://docs.spherepay.co/concepts/reference/supported-assets.md): Reference for all fiat and stablecoin currency codes used in SpherePay API requests. Includes USD, EUR, BRL, USDC, USDT, and EURC with supported networks.
- [Country Codes Reference for SpherePay API](https://docs.spherepay.co/concepts/reference/supported-countries.md): SpherePay uses ISO 3166-1 alpha-3 country codes in customer address fields. Reference common country codes used when creating customers and bank accounts.
- [Register Bank Accounts for Fiat Transfers](https://docs.spherepay.co/concepts/transfers/bank-accounts.md): Link a customer's fiat bank account to SpherePay to enable on-ramp and off-ramp transfers via ACH, Wire, SEPA, or PIX payment rails.
- [Transfer Lifecycle and Status Reference](https://docs.spherepay.co/concepts/transfers/lifecycle.md): Understand how SpherePay transfers move through each status — from pendingFunding through succeeded, returned, or failed — and how to handle each state.
- [Transfers API: On-Ramp and Off-Ramp Guide](https://docs.spherepay.co/concepts/transfers/overview.md): Create on-ramp and off-ramp transfers with the SpherePay Transfers API. Covers integration workflow, request examples for USD and BRL/PIX, and status tracking.
- [Supported Payment Rails and Stablecoins](https://docs.spherepay.co/concepts/transfers/supported-rails.md): View all supported source and destination rails, currencies, and stablecoin networks for SpherePay Transfers, Onramper Accounts, and Offloader Wallets.
- [Register Crypto Wallets for Stablecoin Transfers](https://docs.spherepay.co/concepts/transfers/wallets.md): Link a customer's existing blockchain wallet address to SpherePay to enable on-ramp and off-ramp transfers across supported stablecoin networks.
- [Authenticate with the SpherePay API](https://docs.spherepay.co/get-started/authentication.md): All SpherePay API requests use Bearer token authentication. Learn how to generate your API key and pass it correctly in every request.
- [Make Your First SpherePay API Call](https://docs.spherepay.co/get-started/first-api-call.md): Walk through creating a customer, registering a bank account and wallet, then executing your first on-ramp transfer with the SpherePay API.
- [How SpherePay Works: Integration Overview](https://docs.spherepay.co/get-started/how-it-works.md): Learn the three-step integration model behind SpherePay: create a verified customer, register a transfer instrument, then execute a transfer.
- [SpherePay OpenAPI 3.0 Specification Download](https://docs.spherepay.co/get-started/openapi-spec.md): Download the SpherePay OpenAPI 3.0 specification to generate API clients, import into Postman or Insomnia, or build custom tooling and integrations.
- [SpherePay: Stablecoin payments for global businesses](https://docs.spherepay.co/introduction.md): SpherePay is an API-first platform for on-ramp and off-ramp transfers. Convert between USD, EUR, BRL and USDC, USDT, EURC with built-in KYC/KYB compliance.
- [Cross-Border Trade Finance](https://docs.spherepay.co/solutions/cross-border-trade-finance.md): Settle international invoices and receivables across currencies using stablecoins as the bridge — built for importers, exporters, and trade finance platforms.
- [SpherePay Solutions: Use Case Integration Guides](https://docs.spherepay.co/solutions/overview.md): Outcome-shaped guides for common SpherePay use cases — payroll, payment acceptance, trading, cross-border trade finance, and treasury management.
- [Accept Fiat Payments and Settle in Stablecoins](https://docs.spherepay.co/solutions/payment-acceptance.md): Accept fiat payments from end users and settle them as on-chain stablecoins automatically, with no per-payment API call. Built on Onramper virtual accounts.
- [Stablecoin and Fiat Payroll for Global Teams](https://docs.spherepay.co/solutions/payroll.md): Pay W-2 employees and 1099 contractors in stablecoins or fiat. Cover both crypto-native and traditional payroll models with a single integration.
- [Fiat Currency Trading with Stablecoin Settlement](https://docs.spherepay.co/solutions/trading.md): Trade between fiat currency pairs using stablecoins as the settlement bridge — BRL ↔ USD, USD ↔ EUR, and other corridors as SpherePay's rails expand.
- [Treasury Management with Fiat-to-Stablecoin Conversion](https://docs.spherepay.co/solutions/treasury-management.md): Convert company funds between fiat and stablecoins for treasury operations — yield, faster settlement, or multi-currency strategy.

## OpenAPI Specs

- [spherepay](https://docs.spherepay.co/openapi/spherepay.yaml)