# Hyparrow

## Docs

- [Login](https://docs.hyparrow.com/api-reference/auth/login.md): Authenticate with your credentials and receive a JWT for subsequent requests.
- [Sign Up](https://docs.hyparrow.com/api-reference/auth/signup.md): Create a new Hyparrow account to start accepting payments.
- [Verify Email](https://docs.hyparrow.com/api-reference/auth/verify-email.md): Verify your email address with the OTP sent after signup, and resend a new OTP if needed.
- [List Categories](https://docs.hyparrow.com/api-reference/bills/categories.md): Retrieve all bill payment categories and list billers within a specific category.
- [Pay Bill](https://docs.hyparrow.com/api-reference/bills/pay.md): Initiate a bill payment for airtime, electricity, cable TV, internet, and other supported services.
- [List Services](https://docs.hyparrow.com/api-reference/bills/services.md): Browse all billers, retrieve payment options for a service, search billers by name, and look up a specific biller.
- [Payment Status](https://docs.hyparrow.com/api-reference/bills/status.md): Check the status of a bill payment using its request reference.
- [Validate Customer](https://docs.hyparrow.com/api-reference/bills/validate.md): Verify a customer's details against a biller before initiating a payment.
- [Authenticate OTP](https://docs.hyparrow.com/api-reference/card-payments/authenticate-otp.md): Complete a Verve or Mastercard card payment by submitting the OTP sent to the cardholder's registered phone, or request a new OTP.
- [Initiate Payment](https://docs.hyparrow.com/api-reference/card-payments/purchase.md): Charge a card by submitting encrypted card details and receiving a payment response or OTP challenge.
- [Payment Status](https://docs.hyparrow.com/api-reference/card-payments/status.md): Query the status of a card payment by transaction reference, or list all card transactions for your account.
- [Create Customer](https://docs.hyparrow.com/api-reference/customers/create.md): Create a customer record in your account, then list or retrieve customers by ID.
- [Virtual Account](https://docs.hyparrow.com/api-reference/customers/virtual-account.md): Create a dedicated virtual bank account for a customer to receive payments.
- [Create Invoice](https://docs.hyparrow.com/api-reference/invoices/create.md): Create an invoice with line items, optional taxes, discounts, and shipping, then list or retrieve invoices.
- [Collect Payment](https://docs.hyparrow.com/api-reference/invoices/pay.md): Generate a virtual account for an invoice, check payment status, send the invoice by email, and download PDF copies.
- [BVN Verification](https://docs.hyparrow.com/api-reference/kyc/bvn.md): Look up and verify a Bank Verification Number (BVN) using Zeeh or Interswitch as the data provider.
- [CAC Verification](https://docs.hyparrow.com/api-reference/kyc/cac.md): Verify companies registered with the Corporate Affairs Commission (CAC), and look up TIN, driver's license, and international passport records.
- [NIN Verification](https://docs.hyparrow.com/api-reference/kyc/nin.md): Verify a National Identification Number (NIN) using Zeeh or Interswitch as the data provider.
- [Bank Account Lookup](https://docs.hyparrow.com/api-reference/kyc/nuban.md): Look up the owner of a Nigerian bank account number (NUBAN), resolve the account with a specific bank, or determine which banks an account number belongs to.
- [Create Subscription](https://docs.hyparrow.com/api-reference/subscriptions/create.md): Create a recurring billing subscription for a customer tied to a product, then list or retrieve subscriptions.
- [Collect Payment](https://docs.hyparrow.com/api-reference/subscriptions/pay.md): Generate virtual accounts, record payments, cancel subscriptions, and retrieve payment history for a subscription.
- [Get Transaction](https://docs.hyparrow.com/api-reference/transactions/get.md): Retrieve the full details of a single transaction by its ID.
- [List Transactions](https://docs.hyparrow.com/api-reference/transactions/list.md): Retrieve a paginated, filterable list of all transactions for your account.
- [List Banks](https://docs.hyparrow.com/api-reference/transfers/banks.md): Retrieve the list of supported banks and their codes for use in account inquiries and transfers.
- [Send Transfer](https://docs.hyparrow.com/api-reference/transfers/initiate.md): Initiate a bank transfer from your Hyparrow wallet to any supported Nigerian bank account.
- [Account Inquiry](https://docs.hyparrow.com/api-reference/transfers/inquiry.md): Look up the account name for a bank account number before initiating a transfer.
- [Transfer Status](https://docs.hyparrow.com/api-reference/transfers/status.md): Check the current status of a bank transfer using its transfer code.
- [Authentication](https://docs.hyparrow.com/authentication.md): Hyparrow supports API key authentication for server integrations and JWT authentication for dashboard sessions.
- [API Keys](https://docs.hyparrow.com/concepts/api-keys.md): Create and manage API keys to authenticate your integration with Hyparrow.
- [Transactions](https://docs.hyparrow.com/concepts/transactions.md): Understand the transaction lifecycle, statuses, and how to look up any payment.
- [Webhooks](https://docs.hyparrow.com/concepts/webhooks.md): Receive real-time payment notifications on your server using HMAC-verified webhook events.
- [Bank Transfers](https://docs.hyparrow.com/guides/bank-transfers.md): Send money to any Nigerian bank account using the Hyparrow transfers API.
- [Bill Payments](https://docs.hyparrow.com/guides/bill-payments.md): Pay airtime, data, electricity, cable TV, and other bills through the Hyparrow API.
- [Card Payments](https://docs.hyparrow.com/guides/card-payments.md): Accept Visa, Mastercard, and Verve card payments with OTP authentication via the Hyparrow API.
- [Crypto Wallets](https://docs.hyparrow.com/guides/crypto-wallets.md): Create and manage on-chain crypto wallets for your customers, check balances, and initiate transfers.
- [Customers](https://docs.hyparrow.com/guides/customers.md): Create and manage customers, assign virtual accounts, and receive payment notifications via webhooks.
- [Invoices](https://docs.hyparrow.com/guides/invoices.md): Create professional invoices and collect payment via virtual account, card, USSD, OPay, or crypto.
- [KYC Verification](https://docs.hyparrow.com/guides/kyc-verification.md): Verify identities using BVN, NIN, CAC, drivers license, passport, phone, voters card, credit history, AML checks, and face comparison.
- [OPay Payments](https://docs.hyparrow.com/guides/opay-payments.md): Collect payments via OPay wallets using the Interswitch OPay collection channel.
- [Subscriptions](https://docs.hyparrow.com/guides/subscriptions.md): Set up recurring billing cycles and collect subscription payments via virtual account, card, or manual confirmation.
- [USSD Payments](https://docs.hyparrow.com/guides/ussd-payments.md): Generate USSD codes so customers can pay from any phone without internet access.
- [Virtual Accounts](https://docs.hyparrow.com/guides/virtual-accounts.md): Create dedicated bank account numbers for your customers to collect payments passively.
- [Introduction](https://docs.hyparrow.com/introduction.md): Hyparrow is a white-label payment gateway API for developers who need bill payments, bank transfers, virtual accounts, and more.
- [Quickstart](https://docs.hyparrow.com/quickstart.md): Create an account, verify your email, log in, generate an API key, and make your first API call.
- [Errors](https://docs.hyparrow.com/reference/errors.md): HTTP status codes, error response format, and how to resolve common errors from the Hyparrow API.
- [Idempotency](https://docs.hyparrow.com/reference/idempotency.md): How to use request references to safely retry failed bill payments and transfers without creating duplicate transactions.
- [Rate Limits](https://docs.hyparrow.com/reference/rate-limits.md): Default rate limit thresholds, how limits are applied per API key, and strategies for staying within them.