Create an NGN virtual account
curl --request POST \
--url https://sandbox-api.bullring.finance/v2/ramp/{storeId}/banking/deposits \
--header 'Content-Type: application/json' \
--header 'X-Key-Id: <api-key>' \
--data '
{
"channelId": "ngn-channel-id-bullring-finance",
"generateNewAccount": true,
"beneficiaryName": "<string>"
}
'import requests
url = "https://sandbox-api.bullring.finance/v2/ramp/{storeId}/banking/deposits"
payload = {
"channelId": "ngn-channel-id-bullring-finance",
"generateNewAccount": True,
"beneficiaryName": "<string>"
}
headers = {
"X-Key-Id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Key-Id': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
channelId: 'ngn-channel-id-bullring-finance',
generateNewAccount: true,
beneficiaryName: '<string>'
})
};
fetch('https://sandbox-api.bullring.finance/v2/ramp/{storeId}/banking/deposits', 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://sandbox-api.bullring.finance/v2/ramp/{storeId}/banking/deposits",
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([
'channelId' => 'ngn-channel-id-bullring-finance',
'generateNewAccount' => true,
'beneficiaryName' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Key-Id: <api-key>"
],
]);
$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://sandbox-api.bullring.finance/v2/ramp/{storeId}/banking/deposits"
payload := strings.NewReader("{\n \"channelId\": \"ngn-channel-id-bullring-finance\",\n \"generateNewAccount\": true,\n \"beneficiaryName\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Key-Id", "<api-key>")
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://sandbox-api.bullring.finance/v2/ramp/{storeId}/banking/deposits")
.header("X-Key-Id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"channelId\": \"ngn-channel-id-bullring-finance\",\n \"generateNewAccount\": true,\n \"beneficiaryName\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.bullring.finance/v2/ramp/{storeId}/banking/deposits")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Key-Id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"channelId\": \"ngn-channel-id-bullring-finance\",\n \"generateNewAccount\": true,\n \"beneficiaryName\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"currency": "NGN",
"bankInfo": {
"bankBeneficiaryName": "<string>",
"bankName": "<string>",
"bankAccountNumber": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"bankCode": "<string>"
},
"channelId": "<string>"
}{
"statusCode": 123,
"code": "<string>",
"message": "<unknown>"
}{
"statusCode": 123,
"message": "<unknown>",
"code": "<string>"
}{
"statusCode": 123,
"message": "<unknown>",
"code": "<string>"
}{
"statusCode": 123,
"message": "<unknown>",
"code": "<string>"
}Deposits
Create virtual account
Retrieve or create an NGN virtual account for deposits.
POST
/
v2
/
ramp
/
{storeId}
/
banking
/
deposits
Create an NGN virtual account
curl --request POST \
--url https://sandbox-api.bullring.finance/v2/ramp/{storeId}/banking/deposits \
--header 'Content-Type: application/json' \
--header 'X-Key-Id: <api-key>' \
--data '
{
"channelId": "ngn-channel-id-bullring-finance",
"generateNewAccount": true,
"beneficiaryName": "<string>"
}
'import requests
url = "https://sandbox-api.bullring.finance/v2/ramp/{storeId}/banking/deposits"
payload = {
"channelId": "ngn-channel-id-bullring-finance",
"generateNewAccount": True,
"beneficiaryName": "<string>"
}
headers = {
"X-Key-Id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Key-Id': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
channelId: 'ngn-channel-id-bullring-finance',
generateNewAccount: true,
beneficiaryName: '<string>'
})
};
fetch('https://sandbox-api.bullring.finance/v2/ramp/{storeId}/banking/deposits', 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://sandbox-api.bullring.finance/v2/ramp/{storeId}/banking/deposits",
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([
'channelId' => 'ngn-channel-id-bullring-finance',
'generateNewAccount' => true,
'beneficiaryName' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Key-Id: <api-key>"
],
]);
$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://sandbox-api.bullring.finance/v2/ramp/{storeId}/banking/deposits"
payload := strings.NewReader("{\n \"channelId\": \"ngn-channel-id-bullring-finance\",\n \"generateNewAccount\": true,\n \"beneficiaryName\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Key-Id", "<api-key>")
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://sandbox-api.bullring.finance/v2/ramp/{storeId}/banking/deposits")
.header("X-Key-Id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"channelId\": \"ngn-channel-id-bullring-finance\",\n \"generateNewAccount\": true,\n \"beneficiaryName\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.bullring.finance/v2/ramp/{storeId}/banking/deposits")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Key-Id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"channelId\": \"ngn-channel-id-bullring-finance\",\n \"generateNewAccount\": true,\n \"beneficiaryName\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"currency": "NGN",
"bankInfo": {
"bankBeneficiaryName": "<string>",
"bankName": "<string>",
"bankAccountNumber": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"bankCode": "<string>"
},
"channelId": "<string>"
}{
"statusCode": 123,
"code": "<string>",
"message": "<unknown>"
}{
"statusCode": 123,
"message": "<unknown>",
"code": "<string>"
}{
"statusCode": 123,
"message": "<unknown>",
"code": "<string>"
}{
"statusCode": 123,
"message": "<unknown>",
"code": "<string>"
}Use
generateNewAccount and beneficiaryName only when a fresh NGN account is required.Authorizations
Headers
Body
application/json