Skip to main content
POST
Create Custom Charge

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.