Paymish Loading Docs Preparing guides, collections, and live API references...
Paymish Docs

Create a Dedicated Virtual Account.

  • Paymish
  • Dedicated Virtual Accounts

Topics

Endpoint Overview

Dedicated Virtual Accounts

Create a Dedicated Virtual Account.

Creates a new dedicated virtual account for a customer. The account will be created with GTBank's Squad as the provider.

POST /api/transaction-service/external/v1/dedicated-virtual-accounts Requires authentication

Purpose

Use this endpoint to create a dedicated virtual account. It belongs to the Dedicated Virtual Accounts collection and is designed for backend integrations.

Request shape

0 parameters and 10 documented body fields using application/json.

Implementation Guide

Recommended workflow

1

Authenticate first and inject a valid bearer token or secret key before calling the endpoint.

2

Validate the input data, identifiers, and account state in your application before making the request.

3

Send the POST request from your backend using the required headers and the expected content type (application/json).

4

Persist the important identifiers returned in the response so later lookups, webhooks, or support actions can be linked correctly.

Implementation notes

  • Validate the request payload on your backend before sending it, especially the 10 documented body fields.
  • Protect state-changing operations with strong validation, logging, and retry rules to avoid duplicate mutations.

Request Body

Content type: application/json

customerId required
string
Unique identifier of the customer. Example: cust_550e8400e29b41d4
firstName required
string
Customer's first name. Example: John
lastName required
string
Customer's last name. Example: Doe
email required
string
Customer's email address. Example: john.doe@example.com
phoneNumber required
string
Customer's phone number (with or without leading 0). Example: 08012345678
bvn required
string
Bank Verification Number. Example: 22222222226
dob required
string
Date of birth in YYYY-MM-DD format. Example: 1990-01-15
address required
string
Residential address. Example: 123 Main Street, Lagos, Nigeria
gender required
string
Customer's gender. Example: Male
businessName
string
Name of the business (optional). Example: John's Store

Responses

200 Dedicated virtual account created successfully.
400 Bad request - validation error or provider error.
401 Unauthorized - missing or invalid authentication token.
500 Internal server error.

Expected Outcomes

200

Success example

Dedicated virtual account created successfully.

Representative Response 
{
  "status": "success",
  "message": "Dedicated virtual account created successfully",
  "data": "value"
}
400

Failure example

Bad request - validation error or provider error.

Representative Error 
{
  "status": "error",
  "error": "Invalid BVN or customer already has an active account"
}
After the response:
  • Log the Paymish reference or request context returned by the API so support teams can trace the call later.
  • Retry only when the failure is safe to repeat; otherwise correct the payload or auth state first.
  • Store enough internal metadata to match the API response back to your order, payout, case, or checkout record.

Language Notes

Python

Use `requests` from a backend worker, service, or Django/Flask app and centralize headers in a reusable helper.

Node.js

Use `axios` or `fetch` from Node.js services only; do not place secret credentials in frontend bundles.

PHP

Wrap cURL usage in a small client class so auth headers, error handling, and logging stay consistent.

cURL

Use cURL for smoke testing and debugging, then move the final logic into your backend service code.

Code Examples

Python 
import requests

headers = {
    "Authorization": "Bearer YOUR_SECRET_KEY",
    "Content-Type": "application/json",
}
payload = {
  "customerId": "cust_550e8400e29b41d4",
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@example.com",
  "phoneNumber": "08012345678"
}

response = requests.post(
    "https://api.paymish.com/api/transaction-service/external/v1/dedicated-virtual-accounts",
    headers=headers,
    json=payload,
)

data = response.json()
print(data)
Node.js 
const axios = require("axios");

const response = await axios({
  method: "post",
  url: "https://api.paymish.com/api/transaction-service/external/v1/dedicated-virtual-accounts",
  headers: {
    Authorization: "Bearer YOUR_SECRET_KEY",
    "Content-Type": "application/json",
  },
  data: {
  "customerId": "cust_550e8400e29b41d4",
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@example.com",
  "phoneNumber": "08012345678"
}
});

console.log(response.data);
cURL 
curl https://api.paymish.com/api/transaction-service/external/v1/dedicated-virtual-accounts \
  -X POST \
  -H "Authorization: Bearer YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{   "customerId": "cust_550e8400e29b41d4",   "firstName": "John",   "lastName": "Doe",   "email": "john.doe@example.com",   "phoneNumber": "08012345678" }'
PHP 
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.paymish.com/api/transaction-service/external/v1/dedicated-virtual-accounts");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer YOUR_SECRET_KEY",
    "Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
    "customerId" => "cust_550e8400e29b41d4",
    "firstName" => "John",
    "lastName" => "Doe",
    "email" => "john.doe@example.com",
    "phoneNumber" => "08012345678",
]));

$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
Previous endpoint Get scheduled transactions Next endpoint Verify Transaction.