Invoice
Create Invoice
Creating A New Invoice
Base URL: https://api.budpay.com/api/v2
Endpoint: create_invoice
Method: POST
Post Parameters
| Param | Type | Required? | Decription |
|---|---|---|---|
| title | string | Yes | This is the title of the invoice |
| duedate | string | Yes | This is the due date of the invoice eg "YYYY-MM-DD" |
| currency | string | Yes | NGN |
| invoicenumber | string | no | This is the invoice reference number |
| reminder | string | no | This is a random string |
| string | Yes | Payer's Email | |
| first_name | string | optional but neccessary | Payer's first name |
| last_name | string | optional but neccessary | Payer's last name |
| billing_address | string | yes | Invoice Address. eg: "12, Wales Street, Mark Boulevard" |
| billing_city | string | yes | Invoice Billing City. eg "Ikeja" |
| billing_state | string | yes | Invoice Billing State. eg "Lagos" |
| billing_country | string | yes | Invoice Billing Country. eg "Nigeria" |
| billing_zip_code | string | yes | Invoice Billing Country. eg "Nigeria" |
| billing_zip_code | string | yes | Invoice Billing Zip Code. eg "234" |
| items | array | yes | An array of objects containing the invoice items |
Sample Request
https://api.budpay.com/api/v2/create_invoice
-X POST
{
"title":"Test Invoice",
"duedate":"2023-12-30",
"currency":"NGN",
"invoicenumber":"", // optional
"reminder":"", // optional
"email":"toluxsys@live.come",
"first_name":"Tolu", // optional but neccessary
"last_name":"Oye", // optional but neccessary
"billing_address":"Carlton Gate estate, Akobo",
"billing_city":"Ibadan",
"billing_state":"Oyo",
"billing_country":"Nigeria",
"billing_zipcode":"234",
"items":[
{
"description":"This is a test invoice created",
"quantity":"1",
"unit_price":"1000",
"meta_data":""
}
]
}
Sample Response
{
"success”:true,
"message":"Invoice created successfully",
"data”:[
{
“invoice_id”:1,
“ref_id”:”ovgsfdsfvsd”,
“paycode”:"2542jkdhdsioewewew",
“redirect_link”:”https://…..”
}
]
}