Create an NGN recipient
curl --request POST \
--url https://sandbox-api.bullring.finance/v2/ramp/{storeId}/banking/recipients \
--header 'Content-Type: application/json' \
--header 'X-Key-Id: <api-key>' \
--data '
{
"currency": "NGN",
"payment_rail": "BANK_TRANSFER",
"bank_name": "Parkway",
"account_number": "8120001540",
"bank_code": "058"
}
'import requests
url = "https://sandbox-api.bullring.finance/v2/ramp/{storeId}/banking/recipients"
payload = {
"currency": "NGN",
"payment_rail": "BANK_TRANSFER",
"bank_name": "Parkway",
"account_number": "8120001540",
"bank_code": "058"
}
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({
currency: 'NGN',
payment_rail: 'BANK_TRANSFER',
bank_name: 'Parkway',
account_number: '8120001540',
bank_code: '058'
})
};
fetch('https://sandbox-api.bullring.finance/v2/ramp/{storeId}/banking/recipients', 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/recipients",
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([
'currency' => 'NGN',
'payment_rail' => 'BANK_TRANSFER',
'bank_name' => 'Parkway',
'account_number' => '8120001540',
'bank_code' => '058'
]),
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/recipients"
payload := strings.NewReader("{\n \"currency\": \"NGN\",\n \"payment_rail\": \"BANK_TRANSFER\",\n \"bank_name\": \"Parkway\",\n \"account_number\": \"8120001540\",\n \"bank_code\": \"058\"\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/recipients")
.header("X-Key-Id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"currency\": \"NGN\",\n \"payment_rail\": \"BANK_TRANSFER\",\n \"bank_name\": \"Parkway\",\n \"account_number\": \"8120001540\",\n \"bank_code\": \"058\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.bullring.finance/v2/ramp/{storeId}/banking/recipients")
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 \"currency\": \"NGN\",\n \"payment_rail\": \"BANK_TRANSFER\",\n \"bank_name\": \"Parkway\",\n \"account_number\": \"8120001540\",\n \"bank_code\": \"058\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"account_owner_name": "<string>",
"active": true,
"currency": "<string>",
"account_id": "<string>",
"payment_rail": "<string>",
"bank_name": "<string>",
"last_4": "<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>"
}{
"statusCode": 123,
"message": "<unknown>",
"code": "<string>"
}Recipients
Create recipient
Register an NGN bank recipient.
POST
/
v2
/
ramp
/
{storeId}
/
banking
/
recipients
Create an NGN recipient
curl --request POST \
--url https://sandbox-api.bullring.finance/v2/ramp/{storeId}/banking/recipients \
--header 'Content-Type: application/json' \
--header 'X-Key-Id: <api-key>' \
--data '
{
"currency": "NGN",
"payment_rail": "BANK_TRANSFER",
"bank_name": "Parkway",
"account_number": "8120001540",
"bank_code": "058"
}
'import requests
url = "https://sandbox-api.bullring.finance/v2/ramp/{storeId}/banking/recipients"
payload = {
"currency": "NGN",
"payment_rail": "BANK_TRANSFER",
"bank_name": "Parkway",
"account_number": "8120001540",
"bank_code": "058"
}
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({
currency: 'NGN',
payment_rail: 'BANK_TRANSFER',
bank_name: 'Parkway',
account_number: '8120001540',
bank_code: '058'
})
};
fetch('https://sandbox-api.bullring.finance/v2/ramp/{storeId}/banking/recipients', 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/recipients",
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([
'currency' => 'NGN',
'payment_rail' => 'BANK_TRANSFER',
'bank_name' => 'Parkway',
'account_number' => '8120001540',
'bank_code' => '058'
]),
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/recipients"
payload := strings.NewReader("{\n \"currency\": \"NGN\",\n \"payment_rail\": \"BANK_TRANSFER\",\n \"bank_name\": \"Parkway\",\n \"account_number\": \"8120001540\",\n \"bank_code\": \"058\"\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/recipients")
.header("X-Key-Id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"currency\": \"NGN\",\n \"payment_rail\": \"BANK_TRANSFER\",\n \"bank_name\": \"Parkway\",\n \"account_number\": \"8120001540\",\n \"bank_code\": \"058\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.bullring.finance/v2/ramp/{storeId}/banking/recipients")
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 \"currency\": \"NGN\",\n \"payment_rail\": \"BANK_TRANSFER\",\n \"bank_name\": \"Parkway\",\n \"account_number\": \"8120001540\",\n \"bank_code\": \"058\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"account_owner_name": "<string>",
"active": true,
"currency": "<string>",
"account_id": "<string>",
"payment_rail": "<string>",
"bank_name": "<string>",
"last_4": "<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>"
}{
"statusCode": 123,
"message": "<unknown>",
"code": "<string>"
}Recipient creation is idempotent and must use a unique request ID.
Authorizations
Headers
Body
application/json