Skip to main content
POST
Create Payment Link

Authorizations

Authorization
string
header
required

Payaza {{Public API Key in Base 64}}

Body

application/json

The title or name of the payment link.

Example:

"TechMeetup2027"

has_fixed_amount
boolean
required

Indicates whether the payment link has a fixed collection amount.

Example:

true

country_code
string
required

The 3-letter ISO country code.

Example:

"NGA"

currency_code
string
required

The 3-letter ISO currency code.

Example:

"NGN"

fee_bearer_type
enum<string>
required

Determines who absorbs the transaction processing fees.

Available options:
Business,
Customer
Example:

"Customer"

payment_description
string

A brief description of what the payment link is for.

Example:

"This is for support towards the Tech Meetup 2027"

payment_amount
number

The exact amount to be charged. Expected if has_fixed_amount is set to true.

Example:

500

collect_customer_first_and_last_name
boolean

Indicates if the customer's full name should be collected on the checkout page.

Example:

true

collect_customer_email
boolean

Indicates if the customer's email address should be collected.

Example:

true

collect_customer_phone_number
boolean

Indicates if the customer's phone number should be collected.

Example:

false

redirect_url
string

The URL to redirect the customer to after a successful transaction.

Example:

""

A URL pointing to a logo or image displayed on the payment link.

Example:

"https://google.com/face.png"

Response

Create Payment Link Successful Response

status
boolean

Indicates whether the request was successful.

Example:

true

message
string

A descriptive message regarding the outcome of the operation.

Example:

"Payment Link created successfully"

data
object

The payload containing the details of the newly created payment link.