Create Individual Virtual Account

curl --request POST \
  --url https://api.usepooler.com/accounts/individual-virtual-accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_type": "individual",
  "first_name": "<string>",
  "last_name": "<string>",
  "dob": "1999-05-09",
  "email": "jsmith@example.com",
  "bvn": "<string>",
  "mobile_number": "<string>",
  "display_name": "<string>",
  "metadata": {}
}
'

import requests

url = "https://api.usepooler.com/accounts/individual-virtual-accounts"

payload = {
    "account_type": "individual",
    "first_name": "<string>",
    "last_name": "<string>",
    "dob": "1999-05-09",
    "email": "jsmith@example.com",
    "bvn": "<string>",
    "mobile_number": "<string>",
    "display_name": "<string>",
    "metadata": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    account_type: 'individual',
    first_name: '<string>',
    last_name: '<string>',
    dob: '1999-05-09',
    email: 'jsmith@example.com',
    bvn: '<string>',
    mobile_number: '<string>',
    display_name: '<string>',
    metadata: {}
  })
};

fetch('https://api.usepooler.com/accounts/individual-virtual-accounts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.usepooler.com/accounts/individual-virtual-accounts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'account_type' => 'individual',
    'first_name' => '<string>',
    'last_name' => '<string>',
    'dob' => '1999-05-09',
    'email' => 'jsmith@example.com',
    'bvn' => '<string>',
    'mobile_number' => '<string>',
    'display_name' => '<string>',
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.usepooler.com/accounts/individual-virtual-accounts"

	payload := strings.NewReader("{\n  \"account_type\": \"individual\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"dob\": \"1999-05-09\",\n  \"email\": \"jsmith@example.com\",\n  \"bvn\": \"<string>\",\n  \"mobile_number\": \"<string>\",\n  \"display_name\": \"<string>\",\n  \"metadata\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.usepooler.com/accounts/individual-virtual-accounts")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account_type\": \"individual\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"dob\": \"1999-05-09\",\n  \"email\": \"jsmith@example.com\",\n  \"bvn\": \"<string>\",\n  \"mobile_number\": \"<string>\",\n  \"display_name\": \"<string>\",\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.usepooler.com/accounts/individual-virtual-accounts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account_type\": \"individual\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"dob\": \"1999-05-09\",\n  \"email\": \"jsmith@example.com\",\n  \"bvn\": \"<string>\",\n  \"mobile_number\": \"<string>\",\n  \"display_name\": \"<string>\",\n  \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "<string>",
  "stan": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "data": {
    "message": "<string>",
    "reference": "<string>",
    "status": "<string>",
    "account_type": "<string>"
  }
}

POST

accounts

individual-virtual-accounts

Create Individual Virtual Account

curl --request POST \
  --url https://api.usepooler.com/accounts/individual-virtual-accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_type": "individual",
  "first_name": "<string>",
  "last_name": "<string>",
  "dob": "1999-05-09",
  "email": "jsmith@example.com",
  "bvn": "<string>",
  "mobile_number": "<string>",
  "display_name": "<string>",
  "metadata": {}
}
'

import requests

url = "https://api.usepooler.com/accounts/individual-virtual-accounts"

payload = {
    "account_type": "individual",
    "first_name": "<string>",
    "last_name": "<string>",
    "dob": "1999-05-09",
    "email": "jsmith@example.com",
    "bvn": "<string>",
    "mobile_number": "<string>",
    "display_name": "<string>",
    "metadata": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    account_type: 'individual',
    first_name: '<string>',
    last_name: '<string>',
    dob: '1999-05-09',
    email: 'jsmith@example.com',
    bvn: '<string>',
    mobile_number: '<string>',
    display_name: '<string>',
    metadata: {}
  })
};

fetch('https://api.usepooler.com/accounts/individual-virtual-accounts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.usepooler.com/accounts/individual-virtual-accounts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'account_type' => 'individual',
    'first_name' => '<string>',
    'last_name' => '<string>',
    'dob' => '1999-05-09',
    'email' => 'jsmith@example.com',
    'bvn' => '<string>',
    'mobile_number' => '<string>',
    'display_name' => '<string>',
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.usepooler.com/accounts/individual-virtual-accounts"

	payload := strings.NewReader("{\n  \"account_type\": \"individual\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"dob\": \"1999-05-09\",\n  \"email\": \"jsmith@example.com\",\n  \"bvn\": \"<string>\",\n  \"mobile_number\": \"<string>\",\n  \"display_name\": \"<string>\",\n  \"metadata\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.usepooler.com/accounts/individual-virtual-accounts")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account_type\": \"individual\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"dob\": \"1999-05-09\",\n  \"email\": \"jsmith@example.com\",\n  \"bvn\": \"<string>\",\n  \"mobile_number\": \"<string>\",\n  \"display_name\": \"<string>\",\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.usepooler.com/accounts/individual-virtual-accounts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account_type\": \"individual\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"dob\": \"1999-05-09\",\n  \"email\": \"jsmith@example.com\",\n  \"bvn\": \"<string>\",\n  \"mobile_number\": \"<string>\",\n  \"display_name\": \"<string>\",\n  \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "<string>",
  "stan": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "data": {
    "message": "<string>",
    "reference": "<string>",
    "status": "<string>",
    "account_type": "<string>"
  }
}

Create a new virtual account for receiving payments. Virtual accounts can be used to collect payments from customers and are automatically generated with unique account numbers.

Overview

Virtual accounts are bank accounts that are created on-demand for receiving payments. Each virtual account has a unique account number that customers can send payments to. Funds received in virtual accounts are automatically credited to your main Pooler account.

Request Body

string

required

Type of account holder: “individual”

string

required

First name (required for individual accounts)

string

required

Last name (required for individual accounts)

string

required

Display name for the account

string

required

Date of birth of account holder: 1999-05-09

string

required

Email address of the account holder

string

required

Bank Verification Number (required for Nigerian accounts)

string

required

Mobile phone number

object

Additional metadata object that can include:

business_reg_number: Business registration number
country: Country code
use_case: Use case description
reference: Custom reference

Response

object

Virtual account details including:

message: Virtual account creation message
reference: Reference tied to the virtual account
status: The status of the virtual account. The status will always be pending. Webhook event will be sent to you with the final status of the virtual account
account_type: The type of account you are trying to create. Individual

The account number is unique and can be shared with customers for receiving payments. All payments to this account will be automatically credited to your Pooler account.

Authorizations

Authorization

string

header

required

Bearer token authentication. Include your API key in the Authorization header as: Bearer {your_api_key}

Body

application/json

account_type

enum<string>

required

Type of account holder

Available options:

individual

first_name

string

required

First name (for individual accounts)

last_name

string

required

Last name (for individual accounts)

dob

string<date>

required

Date of birth of the account holder

Example:

"1999-05-09"

string<email>

required

Email address

bvn

string

required

Bank Verification Number (for Nigerian accounts)

mobile_number

string

required

Mobile phone number

display_name

string

Display name for the account

metadata

object

Additional metadata

Response

202 - application/json

Virtual account created successfully

success

boolean

message

string

stan

string<uuid>

data

object

Show child attributes

API documentation

Business

Payments

Accounts

Recipients

Webhooks

FX

Utilities

Create Individual Virtual Account

Overview

Request Body

Response

Authorizations

Body

Response

​Overview

​Request Body

​Response

Authorizations

Body

Response

Overview

Request Body

Response