Create a checkout payment with payment link reference
POST
/
api
/
v1
/
paymentlink
/
initiate
cURL
curl --request POST \
--url https://api.novacpayment.com/api/v1/paymentlink/initiate \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"paymentLinkReference": "<string>",
"amount": 123,
"currency": "<string>",
"checkoutCustomerData": {
"email": "jsmith@example.com",
"firstName": "<string>",
"lastName": "<string>",
"phoneNumber": "<string>"
},
"allowedPaymentOptions": "<string>",
"metaData": "<string>",
"checkoutCustomizationData": {
"logoUrl": "<string>",
"paymentDescription": "<string>",
"checkoutModalTitle": "<string>"
}
}
'import requests
url = "https://api.novacpayment.com/api/v1/paymentlink/initiate"
payload = {
"paymentLinkReference": "<string>",
"amount": 123,
"currency": "<string>",
"checkoutCustomerData": {
"email": "jsmith@example.com",
"firstName": "<string>",
"lastName": "<string>",
"phoneNumber": "<string>"
},
"allowedPaymentOptions": "<string>",
"metaData": "<string>",
"checkoutCustomizationData": {
"logoUrl": "<string>",
"paymentDescription": "<string>",
"checkoutModalTitle": "<string>"
}
}
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({
paymentLinkReference: '<string>',
amount: 123,
currency: '<string>',
checkoutCustomerData: {
email: 'jsmith@example.com',
firstName: '<string>',
lastName: '<string>',
phoneNumber: '<string>'
},
allowedPaymentOptions: '<string>',
metaData: '<string>',
checkoutCustomizationData: {
logoUrl: '<string>',
paymentDescription: '<string>',
checkoutModalTitle: '<string>'
}
})
};
fetch('https://api.novacpayment.com/api/v1/paymentlink/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/paymentlink/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([
'paymentLinkReference' => '<string>',
'amount' => 123,
'currency' => '<string>',
'checkoutCustomerData' => [
'email' => 'jsmith@example.com',
'firstName' => '<string>',
'lastName' => '<string>',
'phoneNumber' => '<string>'
],
'allowedPaymentOptions' => '<string>',
'metaData' => '<string>',
'checkoutCustomizationData' => [
'logoUrl' => '<string>',
'paymentDescription' => '<string>',
'checkoutModalTitle' => '<string>'
]
]),
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/paymentlink/initiate"
payload := strings.NewReader("{\n \"paymentLinkReference\": \"<string>\",\n \"amount\": 123,\n \"currency\": \"<string>\",\n \"checkoutCustomerData\": {\n \"email\": \"jsmith@example.com\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phoneNumber\": \"<string>\"\n },\n \"allowedPaymentOptions\": \"<string>\",\n \"metaData\": \"<string>\",\n \"checkoutCustomizationData\": {\n \"logoUrl\": \"<string>\",\n \"paymentDescription\": \"<string>\",\n \"checkoutModalTitle\": \"<string>\"\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/paymentlink/initiate")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"paymentLinkReference\": \"<string>\",\n \"amount\": 123,\n \"currency\": \"<string>\",\n \"checkoutCustomerData\": {\n \"email\": \"jsmith@example.com\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phoneNumber\": \"<string>\"\n },\n \"allowedPaymentOptions\": \"<string>\",\n \"metaData\": \"<string>\",\n \"checkoutCustomizationData\": {\n \"logoUrl\": \"<string>\",\n \"paymentDescription\": \"<string>\",\n \"checkoutModalTitle\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.novacpayment.com/api/v1/paymentlink/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 \"paymentLinkReference\": \"<string>\",\n \"amount\": 123,\n \"currency\": \"<string>\",\n \"checkoutCustomerData\": {\n \"email\": \"jsmith@example.com\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phoneNumber\": \"<string>\"\n },\n \"allowedPaymentOptions\": \"<string>\",\n \"metaData\": \"<string>\",\n \"checkoutCustomizationData\": {\n \"logoUrl\": \"<string>\",\n \"paymentDescription\": \"<string>\",\n \"checkoutModalTitle\": \"<string>\"\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
16 character unique reference for the payment link
Minimum string length:
1The amount to be charged for the transaction
The currency in which the transaction is to be processed
Minimum string length:
1Show child attributes
Show child attributes
The payment options allowed for the transaction
Additional metadata for the transaction
Show child attributes
Show child attributes
Was this page helpful?
Create a checkout payment with transaction reference
Previous
Retrieve a checkout payment transaction
Next
⌘I
cURL
curl --request POST \
--url https://api.novacpayment.com/api/v1/paymentlink/initiate \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"paymentLinkReference": "<string>",
"amount": 123,
"currency": "<string>",
"checkoutCustomerData": {
"email": "jsmith@example.com",
"firstName": "<string>",
"lastName": "<string>",
"phoneNumber": "<string>"
},
"allowedPaymentOptions": "<string>",
"metaData": "<string>",
"checkoutCustomizationData": {
"logoUrl": "<string>",
"paymentDescription": "<string>",
"checkoutModalTitle": "<string>"
}
}
'import requests
url = "https://api.novacpayment.com/api/v1/paymentlink/initiate"
payload = {
"paymentLinkReference": "<string>",
"amount": 123,
"currency": "<string>",
"checkoutCustomerData": {
"email": "jsmith@example.com",
"firstName": "<string>",
"lastName": "<string>",
"phoneNumber": "<string>"
},
"allowedPaymentOptions": "<string>",
"metaData": "<string>",
"checkoutCustomizationData": {
"logoUrl": "<string>",
"paymentDescription": "<string>",
"checkoutModalTitle": "<string>"
}
}
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({
paymentLinkReference: '<string>',
amount: 123,
currency: '<string>',
checkoutCustomerData: {
email: 'jsmith@example.com',
firstName: '<string>',
lastName: '<string>',
phoneNumber: '<string>'
},
allowedPaymentOptions: '<string>',
metaData: '<string>',
checkoutCustomizationData: {
logoUrl: '<string>',
paymentDescription: '<string>',
checkoutModalTitle: '<string>'
}
})
};
fetch('https://api.novacpayment.com/api/v1/paymentlink/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/paymentlink/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([
'paymentLinkReference' => '<string>',
'amount' => 123,
'currency' => '<string>',
'checkoutCustomerData' => [
'email' => 'jsmith@example.com',
'firstName' => '<string>',
'lastName' => '<string>',
'phoneNumber' => '<string>'
],
'allowedPaymentOptions' => '<string>',
'metaData' => '<string>',
'checkoutCustomizationData' => [
'logoUrl' => '<string>',
'paymentDescription' => '<string>',
'checkoutModalTitle' => '<string>'
]
]),
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/paymentlink/initiate"
payload := strings.NewReader("{\n \"paymentLinkReference\": \"<string>\",\n \"amount\": 123,\n \"currency\": \"<string>\",\n \"checkoutCustomerData\": {\n \"email\": \"jsmith@example.com\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phoneNumber\": \"<string>\"\n },\n \"allowedPaymentOptions\": \"<string>\",\n \"metaData\": \"<string>\",\n \"checkoutCustomizationData\": {\n \"logoUrl\": \"<string>\",\n \"paymentDescription\": \"<string>\",\n \"checkoutModalTitle\": \"<string>\"\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/paymentlink/initiate")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"paymentLinkReference\": \"<string>\",\n \"amount\": 123,\n \"currency\": \"<string>\",\n \"checkoutCustomerData\": {\n \"email\": \"jsmith@example.com\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phoneNumber\": \"<string>\"\n },\n \"allowedPaymentOptions\": \"<string>\",\n \"metaData\": \"<string>\",\n \"checkoutCustomizationData\": {\n \"logoUrl\": \"<string>\",\n \"paymentDescription\": \"<string>\",\n \"checkoutModalTitle\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.novacpayment.com/api/v1/paymentlink/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 \"paymentLinkReference\": \"<string>\",\n \"amount\": 123,\n \"currency\": \"<string>\",\n \"checkoutCustomerData\": {\n \"email\": \"jsmith@example.com\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phoneNumber\": \"<string>\"\n },\n \"allowedPaymentOptions\": \"<string>\",\n \"metaData\": \"<string>\",\n \"checkoutCustomizationData\": {\n \"logoUrl\": \"<string>\",\n \"paymentDescription\": \"<string>\",\n \"checkoutModalTitle\": \"<string>\"\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."
}
}