curl --request POST \
--url https://api.payaza.africa/live/merchant-collection/mobile_payment/initiate \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": 2,
"first_name": "John",
"last_name": "Doe",
"email_address": "johndoe@email.com",
"payment_option": "GOOGLEPAY",
"description": "Support",
"transaction_reference": "TX20251109",
"redirect_url": "https://redirect.url/success",
"cancel_url": "https://redirect.urlcancel",
"error_url": "https://redirect.url/error",
"country_code": "USA",
"currency_code": "USD"
}
'import requests
url = "https://api.payaza.africa/live/merchant-collection/mobile_payment/initiate"
payload = {
"amount": 2,
"first_name": "John",
"last_name": "Doe",
"email_address": "johndoe@email.com",
"payment_option": "GOOGLEPAY",
"description": "Support",
"transaction_reference": "TX20251109",
"redirect_url": "https://redirect.url/success",
"cancel_url": "https://redirect.urlcancel",
"error_url": "https://redirect.url/error",
"country_code": "USA",
"currency_code": "USD"
}
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({
amount: 2,
first_name: 'John',
last_name: 'Doe',
email_address: 'johndoe@email.com',
payment_option: 'GOOGLEPAY',
description: 'Support',
transaction_reference: 'TX20251109',
redirect_url: 'https://redirect.url/success',
cancel_url: 'https://redirect.urlcancel',
error_url: 'https://redirect.url/error',
country_code: 'USA',
currency_code: 'USD'
})
};
fetch('https://api.payaza.africa/live/merchant-collection/mobile_payment/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.payaza.africa/live/merchant-collection/mobile_payment/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([
'amount' => 2,
'first_name' => 'John',
'last_name' => 'Doe',
'email_address' => 'johndoe@email.com',
'payment_option' => 'GOOGLEPAY',
'description' => 'Support',
'transaction_reference' => 'TX20251109',
'redirect_url' => 'https://redirect.url/success',
'cancel_url' => 'https://redirect.urlcancel',
'error_url' => 'https://redirect.url/error',
'country_code' => 'USA',
'currency_code' => 'USD'
]),
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.payaza.africa/live/merchant-collection/mobile_payment/initiate"
payload := strings.NewReader("{\n \"amount\": 2,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email_address\": \"johndoe@email.com\",\n \"payment_option\": \"GOOGLEPAY\",\n \"description\": \"Support\",\n \"transaction_reference\": \"TX20251109\",\n \"redirect_url\": \"https://redirect.url/success\",\n \"cancel_url\": \"https://redirect.urlcancel\",\n \"error_url\": \"https://redirect.url/error\",\n \"country_code\": \"USA\",\n \"currency_code\": \"USD\"\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.payaza.africa/live/merchant-collection/mobile_payment/initiate")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 2,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email_address\": \"johndoe@email.com\",\n \"payment_option\": \"GOOGLEPAY\",\n \"description\": \"Support\",\n \"transaction_reference\": \"TX20251109\",\n \"redirect_url\": \"https://redirect.url/success\",\n \"cancel_url\": \"https://redirect.urlcancel\",\n \"error_url\": \"https://redirect.url/error\",\n \"country_code\": \"USA\",\n \"currency_code\": \"USD\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.payaza.africa/live/merchant-collection/mobile_payment/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 \"amount\": 2,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email_address\": \"johndoe@email.com\",\n \"payment_option\": \"GOOGLEPAY\",\n \"description\": \"Support\",\n \"transaction_reference\": \"TX20251109\",\n \"redirect_url\": \"https://redirect.url/success\",\n \"cancel_url\": \"https://redirect.urlcancel\",\n \"error_url\": \"https://redirect.url/error\",\n \"country_code\": \"USA\",\n \"currency_code\": \"USD\"\n}"
response = http.request(request)
puts response.read_body{
"status": true,
"message": "payment initiated successfully",
"data": {
"error_url": "https://redirect.url/error",
"merchant_reference": "TX20251109",
"payment_option": "GOOGLEPAY",
"transaction_amount": 2,
"slug_name": "dev-guide-test",
"currency": "USD",
"paymentUrl": "{{paymentUrl}}",
"transaction_reference": "TX20251109",
"cancel_url": "https://redirect.urlcancel",
"redirect_url": "https://redirect.url/success"
}
}Initiate Payment
This endpoint is used to initiate an Apple Pay or Google Pay collection.
Notes:
-
Please be advised that access to this API is available upon request. To initiate this process, kindly send an email to support@payaza.africa. You will be granted access once our team reviews and approves your request.
-
Ensure that the Check Transaction Status API using the merchant reference is used for your transaction status checks which can be found here.
curl --request POST \
--url https://api.payaza.africa/live/merchant-collection/mobile_payment/initiate \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": 2,
"first_name": "John",
"last_name": "Doe",
"email_address": "johndoe@email.com",
"payment_option": "GOOGLEPAY",
"description": "Support",
"transaction_reference": "TX20251109",
"redirect_url": "https://redirect.url/success",
"cancel_url": "https://redirect.urlcancel",
"error_url": "https://redirect.url/error",
"country_code": "USA",
"currency_code": "USD"
}
'import requests
url = "https://api.payaza.africa/live/merchant-collection/mobile_payment/initiate"
payload = {
"amount": 2,
"first_name": "John",
"last_name": "Doe",
"email_address": "johndoe@email.com",
"payment_option": "GOOGLEPAY",
"description": "Support",
"transaction_reference": "TX20251109",
"redirect_url": "https://redirect.url/success",
"cancel_url": "https://redirect.urlcancel",
"error_url": "https://redirect.url/error",
"country_code": "USA",
"currency_code": "USD"
}
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({
amount: 2,
first_name: 'John',
last_name: 'Doe',
email_address: 'johndoe@email.com',
payment_option: 'GOOGLEPAY',
description: 'Support',
transaction_reference: 'TX20251109',
redirect_url: 'https://redirect.url/success',
cancel_url: 'https://redirect.urlcancel',
error_url: 'https://redirect.url/error',
country_code: 'USA',
currency_code: 'USD'
})
};
fetch('https://api.payaza.africa/live/merchant-collection/mobile_payment/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.payaza.africa/live/merchant-collection/mobile_payment/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([
'amount' => 2,
'first_name' => 'John',
'last_name' => 'Doe',
'email_address' => 'johndoe@email.com',
'payment_option' => 'GOOGLEPAY',
'description' => 'Support',
'transaction_reference' => 'TX20251109',
'redirect_url' => 'https://redirect.url/success',
'cancel_url' => 'https://redirect.urlcancel',
'error_url' => 'https://redirect.url/error',
'country_code' => 'USA',
'currency_code' => 'USD'
]),
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.payaza.africa/live/merchant-collection/mobile_payment/initiate"
payload := strings.NewReader("{\n \"amount\": 2,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email_address\": \"johndoe@email.com\",\n \"payment_option\": \"GOOGLEPAY\",\n \"description\": \"Support\",\n \"transaction_reference\": \"TX20251109\",\n \"redirect_url\": \"https://redirect.url/success\",\n \"cancel_url\": \"https://redirect.urlcancel\",\n \"error_url\": \"https://redirect.url/error\",\n \"country_code\": \"USA\",\n \"currency_code\": \"USD\"\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.payaza.africa/live/merchant-collection/mobile_payment/initiate")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 2,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email_address\": \"johndoe@email.com\",\n \"payment_option\": \"GOOGLEPAY\",\n \"description\": \"Support\",\n \"transaction_reference\": \"TX20251109\",\n \"redirect_url\": \"https://redirect.url/success\",\n \"cancel_url\": \"https://redirect.urlcancel\",\n \"error_url\": \"https://redirect.url/error\",\n \"country_code\": \"USA\",\n \"currency_code\": \"USD\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.payaza.africa/live/merchant-collection/mobile_payment/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 \"amount\": 2,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email_address\": \"johndoe@email.com\",\n \"payment_option\": \"GOOGLEPAY\",\n \"description\": \"Support\",\n \"transaction_reference\": \"TX20251109\",\n \"redirect_url\": \"https://redirect.url/success\",\n \"cancel_url\": \"https://redirect.urlcancel\",\n \"error_url\": \"https://redirect.url/error\",\n \"country_code\": \"USA\",\n \"currency_code\": \"USD\"\n}"
response = http.request(request)
puts response.read_body{
"status": true,
"message": "payment initiated successfully",
"data": {
"error_url": "https://redirect.url/error",
"merchant_reference": "TX20251109",
"payment_option": "GOOGLEPAY",
"transaction_amount": 2,
"slug_name": "dev-guide-test",
"currency": "USD",
"paymentUrl": "{{paymentUrl}}",
"transaction_reference": "TX20251109",
"cancel_url": "https://redirect.urlcancel",
"redirect_url": "https://redirect.url/success"
}
}Authorizations
Payaza {{Public API Key in Base 64}}
Body
The amount to be charged.
2
The customer's first name.
"John"
The customer's last name..
"Doe"
The customer's email address.
"johndoe@email.com"
APPLEPAY or GOOGLEPAY.
"GOOGLEPAY"
The description of this transaction.
"Support"
The unique identifier of this transaction.
"TX20251109"
URL to redirect on successsful.
"https://redirect.url/success"
URL to redirect when user cancels.
"https://redirect.url/cancel"
URL to redirect on failed payment.
"https://redirect.url/error"
The country code. (ISO 3166-1 alpha-3).
"NGN"
GBP, EUR and USD.
"USD"