Create a checkout payment with transaction reference
POST
/
api
/
v1
/
initiate
cURL
curl --request POST \
--url https://api.novacpayment.com/api/v1/initiate \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"transactionReference": "<string>",
"amount": 123,
"currency": "<string>",
"metaData": "<string>",
"redirectUrl": "<string>",
"allowedPaymentOptions": "<string>",
"checkoutCustomizationData": {
"logoUrl": "<string>",
"paymentDescription": "<string>",
"checkoutModalTitle": "<string>"
},
"splitPaymentTransactionInfo": {
"use_preconfiguration": false,
"splitDetails": [
{
"split_reference_code": "31SPLIT0000130004498921",
"split_type": "flat",
"split_value": 200
}
]
}
}
'import requests
url = "https://api.novacpayment.com/api/v1/initiate"
payload = {
"transactionReference": "<string>",
"amount": 123,
"currency": "<string>",
"metaData": "<string>",
"redirectUrl": "<string>",
"allowedPaymentOptions": "<string>",
"checkoutCustomizationData": {
"logoUrl": "<string>",
"paymentDescription": "<string>",
"checkoutModalTitle": "<string>"
},
"splitPaymentTransactionInfo": {
"use_preconfiguration": False,
"splitDetails": [
{
"split_reference_code": "31SPLIT0000130004498921",
"split_type": "flat",
"split_value": 200
}
]
}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
transactionReference: '<string>',
amount: 123,
currency: '<string>',
metaData: '<string>',
redirectUrl: '<string>',
allowedPaymentOptions: '<string>',
checkoutCustomizationData: {
logoUrl: '<string>',
paymentDescription: '<string>',
checkoutModalTitle: '<string>'
},
splitPaymentTransactionInfo: {
use_preconfiguration: false,
splitDetails: [
{
split_reference_code: '31SPLIT0000130004498921',
split_type: 'flat',
split_value: 200
}
]
}
})
};
fetch('https://api.novacpayment.com/api/v1/initiate', 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.novacpayment.com/api/v1/initiate",
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([
'transactionReference' => '<string>',
'amount' => 123,
'currency' => '<string>',
'metaData' => '<string>',
'redirectUrl' => '<string>',
'allowedPaymentOptions' => '<string>',
'checkoutCustomizationData' => [
'logoUrl' => '<string>',
'paymentDescription' => '<string>',
'checkoutModalTitle' => '<string>'
],
'splitPaymentTransactionInfo' => [
'use_preconfiguration' => false,
'splitDetails' => [
[
'split_reference_code' => '31SPLIT0000130004498921',
'split_type' => 'flat',
'split_value' => 200
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.novacpayment.com/api/v1/initiate"
payload := strings.NewReader("{\n \"transactionReference\": \"<string>\",\n \"amount\": 123,\n \"currency\": \"<string>\",\n \"metaData\": \"<string>\",\n \"redirectUrl\": \"<string>\",\n \"allowedPaymentOptions\": \"<string>\",\n \"checkoutCustomizationData\": {\n \"logoUrl\": \"<string>\",\n \"paymentDescription\": \"<string>\",\n \"checkoutModalTitle\": \"<string>\"\n },\n \"splitPaymentTransactionInfo\": {\n \"use_preconfiguration\": false,\n \"splitDetails\": [\n {\n \"split_reference_code\": \"31SPLIT0000130004498921\",\n \"split_type\": \"flat\",\n \"split_value\": 200\n }\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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://api.novacpayment.com/api/v1/initiate")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"transactionReference\": \"<string>\",\n \"amount\": 123,\n \"currency\": \"<string>\",\n \"metaData\": \"<string>\",\n \"redirectUrl\": \"<string>\",\n \"allowedPaymentOptions\": \"<string>\",\n \"checkoutCustomizationData\": {\n \"logoUrl\": \"<string>\",\n \"paymentDescription\": \"<string>\",\n \"checkoutModalTitle\": \"<string>\"\n },\n \"splitPaymentTransactionInfo\": {\n \"use_preconfiguration\": false,\n \"splitDetails\": [\n {\n \"split_reference_code\": \"31SPLIT0000130004498921\",\n \"split_type\": \"flat\",\n \"split_value\": 200\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.novacpayment.com/api/v1/initiate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"transactionReference\": \"<string>\",\n \"amount\": 123,\n \"currency\": \"<string>\",\n \"metaData\": \"<string>\",\n \"redirectUrl\": \"<string>\",\n \"allowedPaymentOptions\": \"<string>\",\n \"checkoutCustomizationData\": {\n \"logoUrl\": \"<string>\",\n \"paymentDescription\": \"<string>\",\n \"checkoutModalTitle\": \"<string>\"\n },\n \"splitPaymentTransactionInfo\": {\n \"use_preconfiguration\": false,\n \"splitDetails\": [\n {\n \"split_reference_code\": \"31SPLIT0000130004498921\",\n \"split_type\": \"flat\",\n \"split_value\": 200\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"status": true,
"message": "Transaction Initialized successfully",
"data": {
"transactionReference": "string",
"amount": 0,
"statusCode": "01",
"statusMessage": "Transaction initiated successfully",
"publicKey": "string",
"paymentRedirectUrl": "string"
}
}{
"status": false,
"message": "Empty request not allowed.",
"data": {
"responseCode": "400",
"responseDescription": "Invalid request."
}
}Authorizations
Input your API key (e.g. your public key) as a Bearer token to access this API.
Body
application/jsontext/jsonapplication/*+json
The reference ID for the transaction
Required string length:
16 - 50The amount to be charged for the transaction
The currency in which the transaction is to be processed
Additional metadata for the transaction
The URL to redirect the user after the transaction
The payment options allowed for the transaction
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?
⌘I
cURL
curl --request POST \
--url https://api.novacpayment.com/api/v1/initiate \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"transactionReference": "<string>",
"amount": 123,
"currency": "<string>",
"metaData": "<string>",
"redirectUrl": "<string>",
"allowedPaymentOptions": "<string>",
"checkoutCustomizationData": {
"logoUrl": "<string>",
"paymentDescription": "<string>",
"checkoutModalTitle": "<string>"
},
"splitPaymentTransactionInfo": {
"use_preconfiguration": false,
"splitDetails": [
{
"split_reference_code": "31SPLIT0000130004498921",
"split_type": "flat",
"split_value": 200
}
]
}
}
'import requests
url = "https://api.novacpayment.com/api/v1/initiate"
payload = {
"transactionReference": "<string>",
"amount": 123,
"currency": "<string>",
"metaData": "<string>",
"redirectUrl": "<string>",
"allowedPaymentOptions": "<string>",
"checkoutCustomizationData": {
"logoUrl": "<string>",
"paymentDescription": "<string>",
"checkoutModalTitle": "<string>"
},
"splitPaymentTransactionInfo": {
"use_preconfiguration": False,
"splitDetails": [
{
"split_reference_code": "31SPLIT0000130004498921",
"split_type": "flat",
"split_value": 200
}
]
}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
transactionReference: '<string>',
amount: 123,
currency: '<string>',
metaData: '<string>',
redirectUrl: '<string>',
allowedPaymentOptions: '<string>',
checkoutCustomizationData: {
logoUrl: '<string>',
paymentDescription: '<string>',
checkoutModalTitle: '<string>'
},
splitPaymentTransactionInfo: {
use_preconfiguration: false,
splitDetails: [
{
split_reference_code: '31SPLIT0000130004498921',
split_type: 'flat',
split_value: 200
}
]
}
})
};
fetch('https://api.novacpayment.com/api/v1/initiate', 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.novacpayment.com/api/v1/initiate",
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([
'transactionReference' => '<string>',
'amount' => 123,
'currency' => '<string>',
'metaData' => '<string>',
'redirectUrl' => '<string>',
'allowedPaymentOptions' => '<string>',
'checkoutCustomizationData' => [
'logoUrl' => '<string>',
'paymentDescription' => '<string>',
'checkoutModalTitle' => '<string>'
],
'splitPaymentTransactionInfo' => [
'use_preconfiguration' => false,
'splitDetails' => [
[
'split_reference_code' => '31SPLIT0000130004498921',
'split_type' => 'flat',
'split_value' => 200
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.novacpayment.com/api/v1/initiate"
payload := strings.NewReader("{\n \"transactionReference\": \"<string>\",\n \"amount\": 123,\n \"currency\": \"<string>\",\n \"metaData\": \"<string>\",\n \"redirectUrl\": \"<string>\",\n \"allowedPaymentOptions\": \"<string>\",\n \"checkoutCustomizationData\": {\n \"logoUrl\": \"<string>\",\n \"paymentDescription\": \"<string>\",\n \"checkoutModalTitle\": \"<string>\"\n },\n \"splitPaymentTransactionInfo\": {\n \"use_preconfiguration\": false,\n \"splitDetails\": [\n {\n \"split_reference_code\": \"31SPLIT0000130004498921\",\n \"split_type\": \"flat\",\n \"split_value\": 200\n }\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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://api.novacpayment.com/api/v1/initiate")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"transactionReference\": \"<string>\",\n \"amount\": 123,\n \"currency\": \"<string>\",\n \"metaData\": \"<string>\",\n \"redirectUrl\": \"<string>\",\n \"allowedPaymentOptions\": \"<string>\",\n \"checkoutCustomizationData\": {\n \"logoUrl\": \"<string>\",\n \"paymentDescription\": \"<string>\",\n \"checkoutModalTitle\": \"<string>\"\n },\n \"splitPaymentTransactionInfo\": {\n \"use_preconfiguration\": false,\n \"splitDetails\": [\n {\n \"split_reference_code\": \"31SPLIT0000130004498921\",\n \"split_type\": \"flat\",\n \"split_value\": 200\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.novacpayment.com/api/v1/initiate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"transactionReference\": \"<string>\",\n \"amount\": 123,\n \"currency\": \"<string>\",\n \"metaData\": \"<string>\",\n \"redirectUrl\": \"<string>\",\n \"allowedPaymentOptions\": \"<string>\",\n \"checkoutCustomizationData\": {\n \"logoUrl\": \"<string>\",\n \"paymentDescription\": \"<string>\",\n \"checkoutModalTitle\": \"<string>\"\n },\n \"splitPaymentTransactionInfo\": {\n \"use_preconfiguration\": false,\n \"splitDetails\": [\n {\n \"split_reference_code\": \"31SPLIT0000130004498921\",\n \"split_type\": \"flat\",\n \"split_value\": 200\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"status": true,
"message": "Transaction Initialized successfully",
"data": {
"transactionReference": "string",
"amount": 0,
"statusCode": "01",
"statusMessage": "Transaction initiated successfully",
"publicKey": "string",
"paymentRedirectUrl": "string"
}
}{
"status": false,
"message": "Empty request not allowed.",
"data": {
"responseCode": "400",
"responseDescription": "Invalid request."
}
}