Quickstart

Get your BudPay integration up and running in minutes. This guide walks you through creating an account, testing your first payment, and going live.

What You Can Build

With BudPay, you can:

Step 1: Create Your Account

Sign up for a free BudPay account (opens in a new tab). Takes less than 2 minutes.

Once registered, you will land in Test Mode by default. This is your sandbox to explore the APIs, run test transactions, and build your integration without moving real money.

Step 2: Get Your API Keys

1. Log in to your BudPay Dashboard (opens in a new tab)
2. Navigate to Settings > API Credentials
3. Copy your Test Secret Key (sk_test_xxxxx)

You will use this key to authenticate all API requests during development.

Step 3: Make Your First API Call

Test your setup with a simple request. Fetch the list of supported banks:

curl -X GET https://api.budpay.com/api/v2/bank_list/NGN \
  -H "Authorization: Bearer YOUR_TEST_SECRET_KEY"

You should receive a JSON response with a list of banks. If you see "success": true, your integration is working.

Step 4: Initialize a Test Payment

Try creating your first payment:

curl -X POST https://api.budpay.com/api/v2/transaction/initialize \
  -H "Authorization: Bearer YOUR_TEST_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "customer@example.com",
    "amount": "5000",
    "currency": "NGN",
    "callback": "https://yourwebsite.com/callback"
  }'

The response includes an authorization_url. Open it in your browser to see the BudPay checkout page.

Step 5: Complete Your KYC

Ready to accept real payments? Complete your business verification:

1. Go to Settings > Business Profile in your dashboard
2. Submit your business documents:
   • Certificate of Incorporation (for registered businesses)
   • Valid ID of directors
   • Proof of address
3. Wait for approval (typically 24-48 hours)

Once approved, you can switch to Live Mode and start collecting real payments.

Step 6: Go Live

After KYC approval:

1. Toggle to Live Mode in your dashboard sidebar
2. Copy your Live Secret Key (sk_live_xxxxx)
3. Update your integration to use the live key
4. Start accepting real payments

Choose Your Integration Method

Pick the approach that fits your use case:

Next Steps

Need Help?

• Email: hi@budpay.com
• Documentation: You are here
• APIs Collection: Download for Postman