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.

This resource allows you to create a card for a customer. PayVessel debits your business USD wallet, completes customer KYC with the card issuer, and returns a card you can fund and manage through the API. This operation is asynchronous, meaning we notify you via a webhook event on the final status (for example when the card becomes ACTIVE). You can also poll Get a Card until card_number is available. Supported card networks:
Networkbrand value
VisaVISA
MastercardMASTERCARD
Currency must be USD. Minimum prefund is $3.00.

​
How it works

  1. Send a request with full customer KYC and card details (brand, currency). Optionally include prefund_amount to fund the card on creation.
  2. PayVessel debits your business USD wallet (issuance + prefund fees apply).
  3. Receive a card in PENDING status with a PayVessel card_id.
  4. Wait for the final status via your webhook handler, or poll Get a Card until status is ACTIVE.

​
Required request fields

FieldRequiredNotes
first_name, last_nameYesCustomer legal name
email, phoneYesNigerian phone format
bvn, ninYes11 digits each
dobYesYYYY-MM-DD
imageYesBase64 identity document (JPEG or PNG)
state, lga, street, postal_codeYesNigerian address
brand, currencyYesUSD only
prefund_amountNoOptional; minimum $3 USD when provided
card_nameOptionalLabel on card (max 255 characters)
Existing customers are matched automatically by email — do not send customer_id.

​
Use cases

  • Issue virtual cards for marketplace sellers or wallet users
  • Prefund cards for subscription or travel spend
  • Onboard customers with full KYC in one API call

​
Example request

{
  "first_name": "Jane",
  "last_name": "Doe",
  "email": "jane.doe@example.com",
  "phone": "08031234567",
  "bvn": "22345678901",
  "nin": "12345678901",
  "dob": "1990-05-15",
  "image": "data:image/jpeg;base64,YOUR_BASE64_IDENTITY_IMAGE",
  "state": "Lagos",
  "lga": "Ikeja",
  "street": "12 Admiralty Way, Lekki Phase 1",
  "postal_code": "101233",
  "brand": "VISA",
  "currency": "USD",
  "prefund_amount": "10.00",
  "card_name": "Jane Doe"
}

API Reference — Try it

Run this endpoint in the browser (interactive playground)