Skip to main content
POST
/
subscription
/
api
/
v1
/
subscriptions
/
{id}
/
charge-custom
Create Custom Charge
curl --request POST \
  --url https://api.payaza.africa/live/subscription/api/v1/subscriptions/{id}/charge-custom \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 100,
  "currency": "NGN",
  "description": "Additional Storage",
  "idempotencyKey": "OFFCYCLE-001",
  "countsAsCycle": false
}
'
import requests

url = "https://api.payaza.africa/live/subscription/api/v1/subscriptions/{id}/charge-custom"

payload = {
"amount": 100,
"currency": "NGN",
"description": "Additional Storage",
"idempotencyKey": "OFFCYCLE-001",
"countsAsCycle": False
}
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: 100,
currency: 'NGN',
description: 'Additional Storage',
idempotencyKey: 'OFFCYCLE-001',
countsAsCycle: false
})
};

fetch('https://api.payaza.africa/live/subscription/api/v1/subscriptions/{id}/charge-custom', 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/subscription/api/v1/subscriptions/{id}/charge-custom",
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' => 100,
'currency' => 'NGN',
'description' => 'Additional Storage',
'idempotencyKey' => 'OFFCYCLE-001',
'countsAsCycle' => false
]),
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/subscription/api/v1/subscriptions/{id}/charge-custom"

payload := strings.NewReader("{\n \"amount\": 100,\n \"currency\": \"NGN\",\n \"description\": \"Additional Storage\",\n \"idempotencyKey\": \"OFFCYCLE-001\",\n \"countsAsCycle\": false\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/subscription/api/v1/subscriptions/{id}/charge-custom")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 100,\n \"currency\": \"NGN\",\n \"description\": \"Additional Storage\",\n \"idempotencyKey\": \"OFFCYCLE-001\",\n \"countsAsCycle\": false\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.payaza.africa/live/subscription/api/v1/subscriptions/{id}/charge-custom")

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\": 100,\n \"currency\": \"NGN\",\n \"description\": \"Additional Storage\",\n \"idempotencyKey\": \"OFFCYCLE-001\",\n \"countsAsCycle\": false\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "message": "Success",
  "data": {
    "status": "SUCCESS",
    "transactionReference": "SUB_CYCLE_3_A11783547440938",
    "amount": 100,
    "currency": "NGN",
    "chargeMode": "DIRECT_CHARGE",
    "message": "Charge completed successfully."
  }
}

Authorizations

Authorization
string
header
required

Payaza {{Public API Key in Base 64}}

Path Parameters

id
string
required

The Plan ID.

Body

application/json
amount
number<double>
required

The amount to be charged.

Example:

1500

currency
string
required

The 3-letter ISO currency code.

Example:

"NGN"

description
string
required

A brief description or reason for the one-off charge.

Example:

"Additional Storage"

idempotencyKey
string

A Unique identifier used to prevent duplicate charge requests.

Example:

"OFFCYCLE-001"

countsAsCycle
boolean

Indicates whether this charge should count as a normal subscription billing cycle. Defaults to false.

Example:

false

Response

Funding Successful

success
boolean

Indicates if the request was successful.

Example:

true

message
string

Descriptive message regarding the charge operation.

Example:

"Custom charge completed"

data
object

The payload containing the charge result or the next action details.