> ## 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.

# Quickstart

> Get started with the PayVessel API: authentication, sandbox, virtual card API, virtual account API, and identity verification in minutes.

<img src="https://www.payvessel.com/hero-image-three.png" alt="Payvessel Integration Journey" />

**Chart your integration course before setting sail with Payvessel.**

To integrate Payvessel into your application, follow this step-by-step navigation guide.

<CardGroup cols={2}>
  <Card title="⚡ Fast Setup" icon="bolt">
    Get up and running in minutes with our streamlined onboarding
  </Card>

  <Card title="🔒 Secure Testing" icon="shield-check">
    Test safely in our sandbox environment with no real money
  </Card>
</CardGroup>

***

## 🏗️ Step 1: Create Your Developer Account

**Sign up for a free merchant account** to access your payvessel dashboard.

<Frame>
  <img src="https://mintcdn.com/payvessel/3kSZ3GGKwBYBkQzL/images/signuppage.png?fit=max&auto=format&n=3kSZ3GGKwBYBkQzL&q=85&s=680fc223d9539419d00ccdefc027540a" alt="Sandbox Environment Features" width="2642" height="2058" data-path="images/signuppage.png" />
</Frame>

In the Payvessel sandbox, you'll be able to:

* 💳 Process payments using test card data and mock accounts
* 🏦 Simulate bank transfers and mobile money transactions
* 🔔 Test webhooks and error scenarios
* ✅ Validate customer identification processes

<Tip>
  Learn more about testing in our sandbox environment in our [development guide](/development).
</Tip>

## ⚙️ Step 2: Configure Your Integration

**Choose your integration vessel** based on your technical stack and business needs:

<CardGroup cols={3}>
  <Card title="Payvessel Checkout" icon="credit-card" href="/accept-payment/checkout">
    Use our pre-built checkout (cards + bank transfer) or the payvessel-checkout npm package
  </Card>

  <Card title="SDKs & Plugins" icon="code" href="/accept-payment/checkout">
    Leverage our libraries for popular frameworks and platforms
  </Card>

  <Card title="Direct API Integration" icon="plug" href="/api-reference/introduction">
    Build custom payment flows using our flexible endpoints
  </Card>
</CardGroup>

<Warning>
  📘 **New to APIs?**
  Read our [beginner-friendly guide](/essentials/markdown) to understand how APIs work and how to implement them in your application.
</Warning>

Once you select your integration method, test thoroughly using sandbox credentials and our provided test data. We've compiled common integration patterns and best practices to help you avoid early obstacles.

<AccordionGroup>
  <Accordion icon="flask" title="Testing Best Practices">
    * Use our comprehensive test card numbers
    * Validate all error scenarios
    * Test webhook endpoints thoroughly
    * Verify mobile money simulations
  </Accordion>

  <Accordion icon="book" title="Integration Patterns">
    * Single payment flows
    * Subscription billing
    * Multi-party transactions
    * Mobile-first implementations
  </Accordion>
</AccordionGroup>

## 🚀 Step 3: Launch Your Live Account

After successful testing, **upgrade to a production account** to access real transaction processing capabilities and actual fund movements.

## 📋 Step 4: Complete Business Verification

To begin live transactions, you'll need to **complete our verification process**, which includes submitting business documentation and bank account details for settlement.

<Steps>
  <Step title="Submit Business Documents">
    Upload your business registration and tax documents
  </Step>

  <Step title="Verify Banking Details">
    Provide settlement account information for fund transfers
  </Step>

  <Step title="Complete KYC Process">
    Submit identity verification for business owners
  </Step>

  <Step title="Wait for Approval">
    Our team will review and approve your application within 24-48 hours
  </Step>
</Steps>

## 🌟 Step ∞: Go Live! 🚀

**Once verified and approved, you're ready to navigate live waters!** Start accepting real payments in multiple currencies through your Payvessel dashboard.

<CardGroup cols={2}>
  <Card title="🎯 Explore Dashboard" icon="chart-line">
    Discover advanced features and settings unavailable in test mode
  </Card>

  <Card title="✅ Review Integration" icon="list-check">
    Use our go-live checklist to ensure everything is shipshape
  </Card>

  <Card title="🔄 Transfer Configurations" icon="arrows-rotate">
    Migrate webhooks, redirect URLs, and security settings
  </Card>

  <Card title="📊 Monitor Performance" icon="gauge-high">
    Track transactions and optimize your payment flows
  </Card>
</CardGroup>

<Note>
  **Pre-Launch Checklist:**

  * [ ] All sandbox tests passing
  * [ ] Webhook endpoints configured
  * [ ] Error handling implemented
  * [ ] Security best practices followed
  * [ ] Production credentials updated
</Note>

***

## 🆘 Need Guidance?

Our developer documentation includes detailed tutorials, API references, and troubleshooting guides to ensure smooth sailing throughout your integration journey.

<CardGroup cols={2}>
  <Card title="📚 Documentation Hub" icon="book-open" href="/api-reference/introduction">
    Comprehensive API references and guides
  </Card>

  <Card title="💬 Developer Support" icon="comments" href="https://support.payvessel.com">
    Get help from our integration experts
  </Card>

  <Card title="🧪 Testing Tools" icon="vial" href="/development">
    Sandbox environment and test utilities
  </Card>

  <Card title="📖 Code Examples" icon="code" href="/accept-payment/checkout">
    Ready-to-use integration snippets
  </Card>
</CardGroup>

<div style={{textAlign: 'center', marginTop: '2rem'}}>
  **Ready to begin your payment journey?**

  <CardGroup cols={2}>
    <Card title="🚀 Create Developer Account" icon="user-plus" href="https://dashboard.payvessel.com/signup">
      Start building with Payvessel today
    </Card>

    <Card title="📖 Explore API Docs" icon="book" href="/api-reference/introduction">
      Dive deep into our comprehensive API
    </Card>
  </CardGroup>
</div>