# PayVessel

> PayVessel API documentation for virtual card API, virtual account API, BVN and NIN verification API, credit score API, payments, transfers, and wallets in Nigeria.

## Docs

- [PayVessel API Documentation](https://docs.payvessel.com/index.md): Official PayVessel API docs for virtual card API, virtual account API, BVN and NIN verification API, credit score API, payments, transfers, and wallets. Build fintech products in Nigeria.
- [PayVessel API Products](https://docs.payvessel.com/api-products.md): Explore PayVessel APIs for USD virtual cards, Nigerian virtual accounts, BVN and NIN verification, credit score checks, payments, transfers, and wallets.
- [Quickstart](https://docs.payvessel.com/quickstart.md): Get started with the PayVessel API: authentication, sandbox, virtual card API, virtual account API, and identity verification in minutes.
- [Support](https://docs.payvessel.com/support.md): Get help with your Payvessel integration
- [Fintechs](https://docs.payvessel.com/use-cases/fintechs.md): Payment solutions tailored for financial technology companies
- [Banks and OFIs](https://docs.payvessel.com/use-cases/banks-and-ofis.md): Modern payment infrastructure for traditional financial institutions
- [Travel and Hospitality](https://docs.payvessel.com/use-cases/travel-and-hospitality.md): Seamless payment solutions for the travel and hospitality industry
- [E-Commerce](https://docs.payvessel.com/use-cases/e-commerce.md): Complete payment solutions for online retail and digital commerce
- [Remittance](https://docs.payvessel.com/use-cases/remittance.md): Secure and affordable cross-border money transfer solutions
- [Telecommunications](https://docs.payvessel.com/use-cases/telecommunications.md): Payment solutions for telecom operators and mobile service providers
- [Authentication](https://docs.payvessel.com/api-basics/authentication.md): Learn how to authenticate your API requests with Payvessel
- [Environments](https://docs.payvessel.com/api-basics/environments.md): Understanding Payvessel's sandbox and production environments
- [Payvessel Checkout](https://docs.payvessel.com/accept-payment/checkout.md): Hosted checkout for cards and bank transfer: integrate with the payvessel-checkout npm package or Merchant Checkout API
- [Customer Reserved Account](https://docs.payvessel.com/accept-payment/customer-reserved-account.md): Create virtual bank accounts for customers: STATIC (permanent) or DYNAMIC (one-time) reserve accounts
- [Get Bank List](https://docs.payvessel.com/transfer-payout/get-bank-list.md): Fetch all supported banks and their codes before initiating a transfer
- [Validate Account](https://docs.payvessel.com/transfer-payout/validate-account.md): Resolve a bank account number to a name before sending money
- [Single transfers](https://docs.payvessel.com/transfer-payout/single-transfers.md)
- [Bulk transfers](https://docs.payvessel.com/transfer-payout/bulk-transfers.md)
- [Transfer Status](https://docs.payvessel.com/transfer-payout/transfer-status.md): Check the status of a previously initiated transfer
- [Wallets Overview](https://docs.payvessel.com/wallets/overview.md): Managed external wallets for holding and moving funds
- [Wallet Balance](https://docs.payvessel.com/wallets/wallet-balance.md): Guide: understanding wallet balances
- [Get Wallets](https://docs.payvessel.com/wallets/get-wallets.md): Guide: listing and retrieving wallets
- [Virtual Account API](https://docs.payvessel.com/virtual-accounts/create-virtual-account.md): PayVessel virtual account API to create STATIC or DYNAMIC Nigerian virtual bank accounts for customer bank transfer collections.
- [Get Virtual Account](https://docs.payvessel.com/virtual-accounts/get-virtual-account.md): Retrieve Nigerian virtual account details by ID using the PayVessel virtual account API.
- [Virtual Card API](https://docs.payvessel.com/virtual-cards/overview.md): PayVessel virtual card API to issue USD Visa and Mastercard cards, fund from your wallet, withdraw, freeze, and receive webhooks for card transactions.
- [Virtual Card Webhooks](https://docs.payvessel.com/virtual-cards/webhooks.md): Virtual card API webhooks for card creation, transactions, funding, withdrawal, termination, and issuing events.
- [Create a Card](https://docs.payvessel.com/virtual-cards/create-customer-card.md): Create a USD virtual card for a customer (asynchronous)
- [Get a Card](https://docs.payvessel.com/virtual-cards/get-card.md): Retrieve one issued virtual card by ID
- [Get all Cards](https://docs.payvessel.com/virtual-cards/list-cards.md): List customer virtual cards for your business
- [Fund a Card](https://docs.payvessel.com/virtual-cards/fund-card.md): Load USD from your business wallet onto a virtual card
- [Withdraw from a Card](https://docs.payvessel.com/virtual-cards/withdraw-card.md): Move USD from a virtual card back to your business wallet
- [Get Card Transactions](https://docs.payvessel.com/virtual-cards/list-transactions.md): Transaction history for a virtual card
- [Simulate Card Transaction](https://docs.payvessel.com/virtual-cards/mock-transaction.md): Sandbox-only test spend and credits on virtual cards
- [Freeze a Card](https://docs.payvessel.com/virtual-cards/freeze-card.md): Temporarily block card spend
- [Unfreeze a Card](https://docs.payvessel.com/virtual-cards/unfreeze-card.md): Restore spend on a frozen card
- [Terminate Card](https://docs.payvessel.com/virtual-cards/terminate-card.md): Permanently close a virtual card
- [Identity Verification API](https://docs.payvessel.com/identity-verification/overview.md): PayVessel identity verification API for BVN verification, NIN verification, credit score API, blacklist checks, and KYC in Nigeria.
- [BVN Verification API (Basic)](https://docs.payvessel.com/identity-verification/basic-bvn-verification.md): PayVessel basic BVN verification API to match customer identity fields against Bank Verification Number records in Nigeria.
- [BVN Verification API (Enhanced)](https://docs.payvessel.com/identity-verification/enhanced-bvn-verification.md): PayVessel enhanced BVN verification API returns full BVN profile data for Nigerian KYC and onboarding workflows.
- [NIN Verification API (Basic)](https://docs.payvessel.com/identity-verification/basic-nin-verification.md): PayVessel basic NIN verification API to match customer identity fields against National Identification Number records.
- [NIN Verification API (Enhanced)](https://docs.payvessel.com/identity-verification/enhanced-nin-verification.md): PayVessel enhanced NIN verification API returns extended NIN profile data for Nigerian identity verification.
- [Driver's License Verification](https://docs.payvessel.com/identity-verification/drivers-license-verification.md): Use driver's license verification when a license is part of your accepted identity set
- [Voter's Card Verification](https://docs.payvessel.com/identity-verification/voters-card-verification.md): Use voter's card verification when voter-registration data is part of your review flow
- [International Passport Verification](https://docs.payvessel.com/identity-verification/international-passport-verification.md): Use passport verification when you need passport-backed identity evidence
- [Compare Faces](https://docs.payvessel.com/identity-verification/merchant-face.md): When to use face comparison and how to work with similarity scores
- [Verify Bank Account](https://docs.payvessel.com/identity-verification/merchant-bank-account.md): Use bank account verification before linking a customer bank account to payouts or settlements
- [Blacklist Query](https://docs.payvessel.com/identity-verification/blacklist-query.md): Use blacklist queries to screen customers before high-risk actions
- [Credit Score API](https://docs.payvessel.com/identity-verification/credit-score-query.md): PayVessel credit score API for Nigerian customer risk grading, underwriting, limits, and lending decisions.
- [Loan Feature Query](https://docs.payvessel.com/identity-verification/loan-feature-query.md): Use loan-feature queries when your workflow needs downstream loan-related signals
- [Biller Reseller API](https://docs.payvessel.com/biller-reseller/overview.md): Resell airtime, data bundles, and betting top-ups through a single integration with the PayVessel biller reseller API.
- [Get Billers](https://docs.payvessel.com/biller-reseller/get-billers.md): Retrieve available billers for a given category (airtime, data, or betting)
- [Get Biller Items](https://docs.payvessel.com/biller-reseller/get-biller-items.md): Retrieve available items and packages for a specific biller
- [Validate Recharge Account](https://docs.payvessel.com/biller-reseller/validate-account.md): Validate a customer's recharge account before placing a biller reseller order
- [Create Order](https://docs.payvessel.com/biller-reseller/create-order.md): Create a biller reseller order to purchase airtime, data, or betting top-ups
- [Get Order](https://docs.payvessel.com/biller-reseller/get-order.md): Retrieve a biller reseller order by ID to check its status
- [Verify Order](https://docs.payvessel.com/biller-reseller/verify-order.md): Verify the status of a biller reseller order by its merchant reference
- [eSIM API](https://docs.payvessel.com/esim/overview.md): Issue and manage eSIM data packages for global travel through the PayVessel eSIM API.
- [List Regions](https://docs.payvessel.com/esim/list-regions.md): List all supported eSIM regions and countries
- [List Packages](https://docs.payvessel.com/esim/list-packages.md): Browse available eSIM data packages with optional filters
- [Create eSIM Order](https://docs.payvessel.com/esim/create-order.md): Purchase an eSIM data package and provision a profile
- [Get eSIM Order](https://docs.payvessel.com/esim/get-order.md): Retrieve an eSIM order by ID, including profile and activation details
- [Gift Card API](https://docs.payvessel.com/gift-cards/overview.md): Purchase and deliver digital gift cards from global brands through the PayVessel gift card API.
- [List Countries](https://docs.payvessel.com/gift-cards/list-countries.md): List all countries that have gift card products available
- [Get Country](https://docs.payvessel.com/gift-cards/get-country.md): Retrieve a single gift card country by its numeric ID
- [List Operators](https://docs.payvessel.com/gift-cards/list-operators.md): Fetch all gift card operators available in a specific country
- [List Products](https://docs.payvessel.com/gift-cards/list-products.md): Fetch all available products for a gift card operator
- [Purchase Gift Card](https://docs.payvessel.com/gift-cards/purchase.md): Purchase a gift card and receive a redemption code
- [Get Order](https://docs.payvessel.com/gift-cards/get-order.md): Retrieve a gift card order by ID to check status and get the redemption code
- [Verify Order](https://docs.payvessel.com/gift-cards/verify-order.md): Verify the status of a gift card order by its merchant reference
- [Flight API](https://docs.payvessel.com/flight/overview.md): Search airports, retrieve flight options, create quotes, and place flight orders through the PayVessel flight API.
- [List Airports](https://docs.payvessel.com/flight/airports.md): Retrieve the supported airport catalogue for flight search
- [Search Flights](https://docs.payvessel.com/flight/search-flights.md): Retrieve available flight options and preview pricing
- [Create Quote](https://docs.payvessel.com/flight/create-quote.md): Validate a selected flight option and receive a bookable quote
- [Create Order](https://docs.payvessel.com/flight/create-order.md): Charge your wallet and create a flight booking order
- [List Orders](https://docs.payvessel.com/flight/list-orders.md): Retrieve all flight orders for the authenticated business
- [Get Order](https://docs.payvessel.com/flight/get-order.md): Retrieve a single flight order by ID
- [Webhook Overview](https://docs.payvessel.com/api-reference/webhook/overview.md): Understand how Payvessel webhooks deliver real-time payment notifications and how to integrate them safely.
- [Verifying Webhooks](https://docs.payvessel.com/api-reference/webhook/verifying-webhooks.md): Secure your Payvessel webhook endpoints by validating signatures, IP addresses, and duplicate deliveries.
- [API Reference](https://docs.payvessel.com/api-reference/introduction.md): PayVessel REST API reference for virtual card API, virtual account API, BVN and NIN verification API, credit score API, payments, transfers, and wallets.
- [Initialize Payment](https://docs.payvessel.com/api-reference/transactions/initialize-payment.md): Initialize a new payment transaction to collect money from customers
- [Verify Payment](https://docs.payvessel.com/api-reference/transactions/verify-payment.md): Verify the status of a payment transaction by reference
- [Create Virtual Account](https://docs.payvessel.com/api-reference/virtual-accounts/create-virtual-account.md): Virtual account API: create a STATIC or DYNAMIC Nigerian reserved bank account for customer collections.
- [Get Virtual Account](https://docs.payvessel.com/api-reference/virtual-accounts/get-virtual-account.md): Fetch details of a specific virtual account using its business ID and account number.
- [Create a Card](https://docs.payvessel.com/api-reference/virtual-cards/create-customer-card.md): Virtual card API: create a USD Visa or Mastercard virtual card for a customer with KYC and optional prefund (asynchronous).
- [Get all Cards](https://docs.payvessel.com/api-reference/virtual-cards/list-cards.md): List customer virtual cards for your business
- [Get a Card](https://docs.payvessel.com/api-reference/virtual-cards/get-card.md): Retrieve one issued virtual card by ID
- [Fund a Card](https://docs.payvessel.com/api-reference/virtual-cards/fund-card.md): Load USD from your business wallet onto a virtual card
- [Withdraw from a Card](https://docs.payvessel.com/api-reference/virtual-cards/withdraw-card.md): Move USD from a virtual card back to your business wallet
- [Get Card Transactions](https://docs.payvessel.com/api-reference/virtual-cards/list-transactions.md): Transaction history for a virtual card
- [Simulate Card Transaction](https://docs.payvessel.com/api-reference/virtual-cards/mock-transaction.md): Sandbox-only simulated spend or credit on a virtual card
- [Freeze a Card](https://docs.payvessel.com/api-reference/virtual-cards/freeze-card.md): Temporarily block card spend
- [Unfreeze a Card](https://docs.payvessel.com/api-reference/virtual-cards/unfreeze-card.md): Restore spend on a frozen card
- [Terminate Card](https://docs.payvessel.com/api-reference/virtual-cards/terminate-card.md): Permanently close a virtual card
- [Get Bank List](https://docs.payvessel.com/api-reference/transfers/get-bank-list.md): Retrieve list of supported banks for fund transfers
- [Validate Account](https://docs.payvessel.com/api-reference/transfers/validate-account.md): Resolve an account number to an account name before initiating transfer
- [Initiate Transfer](https://docs.payvessel.com/api-reference/transfers/initiate-transfer.md): Send money from your managed wallet to a bank account
- [Bulk Transfer](https://docs.payvessel.com/api-reference/transfers/bulk-transfer.md): Initiate multiple wallet transfers in a single batch
- [Transfer Status](https://docs.payvessel.com/api-reference/transfers/transfer-status.md): Check the status of a previously initiated transfer
- [Wallet Balance](https://docs.payvessel.com/api-reference/wallets/wallet-balance.md): Retrieve the current balance for a managed wallet
- [Get Wallets](https://docs.payvessel.com/api-reference/wallets/get-wallets.md): List or retrieve managed wallets for your business
- [Verify BVN (Basic)](https://docs.payvessel.com/api-reference/verification/basic-bvn-verification.md): BVN verification API: match customer identity fields against Bank Verification Number records (basic endpoint).
- [Verify BVN (Enhanced)](https://docs.payvessel.com/api-reference/verification/enhanced-bvn-verification.md): BVN verification API (enhanced): retrieve full BVN-linked identity profile for Nigerian KYC.
- [Verify NIN (Basic)](https://docs.payvessel.com/api-reference/verification/basic-nin-verification.md): NIN verification API: match customer identity fields against National Identification Number records (basic endpoint).
- [Verify NIN (Enhanced)](https://docs.payvessel.com/api-reference/verification/enhanced-nin-verification.md): NIN verification API (enhanced): retrieve full NIN-linked identity profile for Nigerian KYC.
- [Verify Driver's License](https://docs.payvessel.com/api-reference/verification/drivers-license-verification.md): Verify a driver's license and retrieve the identity details attached to the license number.
- [Verify Voter's Card](https://docs.payvessel.com/api-reference/verification/voters-card-verification.md): Verify a voter's card and retrieve the identity details attached to the voter ID.
- [Verify International Passport](https://docs.payvessel.com/api-reference/verification/international-passport-verification.md): Verify an international passport and retrieve the identity details attached to the passport number.
- [Compare Faces](https://docs.payvessel.com/api-reference/verification/merchant-face.md): Compare two face images and return a similarity score.
- [BVN and Account](https://docs.payvessel.com/api-reference/verification/merchant-bank-account.md): Verify a bank account against a BVN, bank code, and account number.
- [Blacklist Query](https://docs.payvessel.com/api-reference/verification/blacklist-query.md): Query blacklist data using phone number, BVN, and NIN identifiers.
- [Credit Score Query](https://docs.payvessel.com/api-reference/verification/credit-score-query.md): Credit score API: query Nigerian customer credit score and risk signals for lending and underwriting.
- [Loan Feature Query](https://docs.payvessel.com/api-reference/verification/loan-feature-query.md): Query loan-feature information using access type, value, authorization, type, and encryption settings.
- [Get Billers](https://docs.payvessel.com/api-reference/biller-reseller/get-billers.md): Get available billers for a given category
- [Get Biller Items](https://docs.payvessel.com/api-reference/biller-reseller/get-biller-items.md): Get available items/packages for a specific biller and category
- [Validate Recharge Account](https://docs.payvessel.com/api-reference/biller-reseller/validate-account.md): Validate a customer recharge account before placing an order
- [Create Order](https://docs.payvessel.com/api-reference/biller-reseller/create-order.md): Create a biller reseller order and charge the merchant wallet
- [Get Order](https://docs.payvessel.com/api-reference/biller-reseller/get-order.md): Get a biller reseller order by ID
- [Verify Order](https://docs.payvessel.com/api-reference/biller-reseller/verify-order.md): Verify the status of a biller reseller order by its merchant reference
- [List Regions](https://docs.payvessel.com/api-reference/esim/list-regions.md): List all supported eSIM regions
- [List Packages](https://docs.payvessel.com/api-reference/esim/list-packages.md): List available eSIM packages with optional filters
- [Create eSIM Order](https://docs.payvessel.com/api-reference/esim/create-order.md): Create an eSIM order and charge the merchant wallet
- [Get eSIM Order](https://docs.payvessel.com/api-reference/esim/get-order.md): Get an eSIM order by ID and refresh provider status
- [List Countries](https://docs.payvessel.com/api-reference/gift-cards/list-countries.md): List all countries with gift card products available
- [Get Country](https://docs.payvessel.com/api-reference/gift-cards/get-country.md): Retrieve a single country by its numeric ID
- [List Operators](https://docs.payvessel.com/api-reference/gift-cards/list-operators.md): Fetch all gift card operators available in a specific country
- [List Products](https://docs.payvessel.com/api-reference/gift-cards/list-products.md): Fetch all available products for a gift card operator
- [Purchase Gift Card](https://docs.payvessel.com/api-reference/gift-cards/purchase.md): Purchase a gift card and charge the business wallet
- [Get Order](https://docs.payvessel.com/api-reference/gift-cards/get-order.md): Retrieve a gift card order by ID
- [Verify Order](https://docs.payvessel.com/api-reference/gift-cards/verify-order.md): Verify the status of a gift card order by its merchant reference
- [List Airports](https://docs.payvessel.com/api-reference/flight/airports.md): Retrieve the supported airport catalogue for the flight API
- [Search Flights](https://docs.payvessel.com/api-reference/flight/search.md): Retrieve available flight options and preview pricing
- [Create Flight Quote](https://docs.payvessel.com/api-reference/flight/create-quote.md): Validate a selected flight option and create a bookable quote
- [Create Flight Order](https://docs.payvessel.com/api-reference/flight/create-order.md): Charge the wallet and create a flight booking order
- [List Flight Orders](https://docs.payvessel.com/api-reference/flight/list-orders.md): Retrieve all flight orders for the authenticated business
- [Get Flight Order](https://docs.payvessel.com/api-reference/flight/get-order.md): Retrieve a single flight order by ID

## OpenAPI Specs

- [vaas-services-openapi](https://docs.payvessel.com/api-reference/vaas-services-openapi.json)
- [openapi](https://docs.payvessel.com/api-reference/openapi.json)