Create Payment Link

Generate shareable payment links programmatically using BudPay's Payment Link API.

Endpoint

POST https://api.budpay.com/api/v2/create_payment_link

Request Parameters

Parameter	Description	Required
`name`	Customer or payment recipient name	Yes
`amount`	Amount to be paid	Yes
`currency`	Currency code (`NGN`, `USD`, `GHS`, `KES`)	Yes
`description`	Description of what the payment is for	Yes
`redirect`	URL to redirect customer after payment	No
`type`	`onetime` or `recurring`	No (default: `onetime`)
`interval`	Billing interval: `daily`, `weekly`, `monthly`, `yearly`	Required if `type` is `recurring`
`times`	Number of charges for recurring payments	Required if `type` is `recurring`
`custom_url`	Custom slug for the payment link URL	No
`paycode`	Custom payment code/reference	No

One-Time Payment Link

Endpoint: POST https://api.budpay.com/api/v2/create_payment_link

1curl -X POST 'https://api.budpay.com/api/v2/create_payment_link' \2  -H 'Content-Type: application/json' \3  -H 'Authorization: Bearer YOUR_SECRET_KEY' \4  -d '{5  "name": "John Doe",6  "amount": "5000",7  "currency": "NGN",8  "description": "Payment for Premium Package",9  "redirect": "https://yourwebsite.com/thank-you",10  "type": "onetime",11  "custom_url": "premium_package_2024",12  "paycode": "P323543943593858"13}'

{  "success": true,  "message": "Payment Link created successfully",  "data": [    {      "ref_id": "ovgelkfsdjfdsfss",      "paycode": "P323543943593858",      "payment_link": "https://app.budpay.com/pay/ovgelkfsdjfdsfss"    }  ]}

Recurring Payment Link

For subscriptions, set type to recurring with interval and times:

Endpoint: POST https://api.budpay.com/api/v2/create_payment_link

1curl -X POST 'https://api.budpay.com/api/v2/create_payment_link' \2  -H 'Content-Type: application/json' \3  -H 'Authorization: Bearer YOUR_SECRET_KEY' \4  -d '{5  "name": "Jane Smith",6  "amount": "2500",7  "currency": "NGN",8  "description": "Monthly Subscription",9  "type": "recurring",10  "interval": "monthly",11  "times": 1212}'

{  "success": true,  "message": "Payment Link created successfully",  "data": [    {      "ref_id": "ovgelkfsdjfdsfss",      "paycode": "P323543943593858",      "payment_link": "https://app.budpay.com/pay/ovgelkfsdjfdsfss"    }  ]}

Interval	Description
`daily`	Charge every day
`weekly`	Charge every week
`monthly`	Charge every month
`yearly`	Charge every year

Custom URL

Create branded URLs using custom_url:

{
    "custom_url": "summer-sale-2024"
}
// Results in: https://app.budpay.com/pay/summer-sale-2024

Overview Overview