Vertueal Docs
SubsManager

Online Payment Gateways

Accept credit and debit cards online with unified adapters for Yoco, Paystack, and Stripe.

Online Payment Gateway Plugins

When you want to accept credit cards and debit cards online alongside offline EFT transfers, SubsManager provides a transparent plugin architecture. You configure your merchant keys once in the dashboard, and SubsManager normalizes the checkout flows across Yoco, Paystack, and Stripe.


1. Unified Hosted Checkout Flow

When a payment gateway plugin is active on your application:

  1. You initiate a subscription (POST /subscriptions) or one-time payment (POST /payments).
  2. SubsManager securely communicates with the gateway's API using encrypted tenant credentials.
  3. The response returns a checkoutUrl.
  4. You redirect the customer to checkoutUrl to complete 3D Secure verification.
  5. The gateway sends an asynchronous reverse webhook to SubsManager.
  6. SubsManager verifies the gateway signature, updates the database, and dispatches a signed webhook to your server.
Loading diagram...

2. One-Time Payments API

For standalone transactions such as setup fees, account top-ups, or professional services:

Create One-Time Payment

  • Endpoint: POST /payments
  • Headers: Authorization: Bearer ap_...

Request Body:

{
  "customerName": "Jane Smith",
  "customerEmail": "jane@example.com",
  "externalId": "usr_99182",
  "amount": 499.00,
  "currency": "ZAR",
  "description": "Onboarding & Architecture Review Package",
  "metadata": {
    "orderId": "ORD-5012"
  }
}

Response (201 Created):

{
  "payment": {
    "_id": "67dc1091...",
    "amount": 499.00,
    "currency": "ZAR",
    "status": "pending",
    "customerEmail": "jane@example.com"
  },
  "checkoutUrl": "https://payments.yoco.com/checkout/ch_88129..."
}

Query Completed Payments

GET /api/v1/payments?externalId=usr_99182&status=completed
Authorization: Bearer ap_live_your_api_key

On this page