Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.payvessel.com/llms.txt

Use this file to discover all available pages before exploring further.

PayVessel provides REST APIs for payments, banking, identity, and card issuing in Nigeria. Use this page to find the right product API for your integration.

Virtual card API

Issue USD virtual Visa and Mastercard cards for your customers. Fund cards from your business wallet, manage freeze and terminate lifecycle, and receive webhooks for spend and funding events.

Virtual card API guide

Getting started, limits, and security

Create a card

API reference with request samples

Fund a card

Load USD from your business wallet

Card webhooks

Virtual account API

Create STATIC or DYNAMIC Nigerian virtual bank accounts so customers can pay you by bank transfer. Reserve accounts per customer and reconcile incoming credits with webhooks.

Create virtual account

Guide: STATIC vs DYNAMIC accounts

Virtual account API

API reference

Get virtual account

Retrieve account details by ID

Reserved accounts guide

Checkout and collection flows

BVN verification API

Verify Bank Verification Number (BVN) details against customer-submitted identity data. Choose basic field-match verification or enhanced profile retrieval for deeper KYC.

Basic BVN verification

Match scores and onboarding checks

Enhanced BVN verification

Full BVN profile fields

BVN API (basic)

API reference

BVN API (enhanced)

API reference

NIN verification API

Verify National Identification Number (NIN) records for Nigerian customers. Use basic verification for match results or enhanced verification when you need richer identity attributes.

Basic NIN verification

Field-match workflows

Enhanced NIN verification

Extended NIN profile data

NIN API (basic)

API reference

NIN API (enhanced)

API reference

Credit score API and risk checks

Run credit score queries, blacklist screening, and loan-feature lookups to support underwriting, limits, and compliance decisions.

Credit score API

Score-based risk signals

Credit score API reference

Request and response schemas

Blacklist query

Screen customers against deny lists

Identity verification overview

Full verification stack

Payments, transfers, and wallets

Accept payments

Checkout and card payments

Bank transfers

Payouts and disbursements

Wallets

Managed balances

API reference

All endpoints

Get started

  1. Create a PayVessel business account and obtain API key and secret from the Dashboard.
  2. Read Authentication and Environments (production and sandbox).
  3. Follow the Quickstart or jump to the product guide above.