Skip to main content
PATCH
Update Payment Link

Authorizations

Authorization
string
header
required

Payaza {{Public API Key in Base 64}}

Path Parameters

The unique identifier of the payment link.

Body

application/json
payment_description
string

A brief description of what the payment link is for.

Example:

"This is for support towards the Youth Conference 2024"

has_fixed_amount
boolean

Indicates whether the payment link has a fixed collection amount.

Example:

false

payment_amount
number

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

Example:

500

country_code
string

The 3-letter ISO country code.

Example:

"USA"

currency_code
string

The 3-letter ISO currency code.

Example:

"USD"

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:

true

success_message
string

The message displayed to the customer after a successful payment.

Example:

"Thank you. God bless you"

failure_message
string

The message displayed to the customer if the payment fails.

Example:

"Try again"

redirect_url
string

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

Example:

""

custom_url
string

A custom vanity URL slug for the payment link.

Example:

"praisefest-2027"

additional_info
string

Any additional information or instructions for the payment link.

Example:

""

fee_bearer_type
enum<string>

Determines who absorbs the transaction processing fees.

Available options:
BUSINESS,
CUSTOMER,
Business,
Customer
Example:

"Customer"

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

Example:

"https://monosnap.com/file/29mZxp6OWo0MrhkrnGXrrG69VKK5tj"

Response

Update Payment Link Successful Response

The response is of type any.