{
"status": "ok",
"message": "payment link created successfully",
"data": {
"paymentLink": "https://checkout.staging.mavapay.co/9d1c20db-c46b-4a15-8233-1bb999e38195",
"paymentRef": "9d1c20db-c46b-4a15-8233-1bb999e38195"
}
}{
"message": "<string>",
"status": "error"
}Create a payment link
Create a hosted payment link for collecting payments. Payment links simplify the checkout process by creating a hosted payment page where users can complete payments.
{
"status": "ok",
"message": "payment link created successfully",
"data": {
"paymentLink": "https://checkout.staging.mavapay.co/9d1c20db-c46b-4a15-8233-1bb999e38195",
"paymentRef": "9d1c20db-c46b-4a15-8233-1bb999e38195"
}
}{
"message": "<string>",
"status": "error"
}Authorizations
Body
Name or title for the payment link
"Bitcoin Purchase"
The currency to settle in
NGN, ZAR, BTC "NGN, ZAR, BTC"
Settlement method for Bitcoin. ONCHAIN for on-chain transactions, LIGHTNING for Lightning Network
ONCHAIN, LIGHTNING "ONCHAIN"
The currency the user pays in
NGN, ZAR, BTC "NGN, ZAR, BTC"
Accepted payment methods. Currently only BANKTRANSFER and LIGHTNING are supported e.g for ZAR payment link, you can specify two payment methods [BANKTRANSFER, LIGHTNING]
BANKTRANSFER, LIGHTNING ["BANKTRANSFER, LIGHTNING"]
For BTC settlement via on-chain or Lightning
- Bitcoin Beneficiary
- NGN Bank Beneficiary
- ZAR Bank Beneficiary
Show child attributes
Show child attributes
Amount in the lowest denomination of the payment currency (e.g., kobo for NGN)
800000
Description of the payment
"On-chain Bitcoin payment"
Type of payment link
One_Time "One_Time"
Whether to add transaction fees to the total cost
false
Network fee priority for on-chain transactions. Required when settlementMethod is ONCHAIN
slow, medium, fast "medium"
Redirect URL where users are sent after payment completion
"https://your-app.com/payment-success"