Invoices
Receive Funds with our Payment Links API.
Invoices make use of the Payment Links API to create, update, activate and deactivate invoices. Invoices provides a shareable URL to accept Payment from your customers.
Create An Invoice Link
Create a new invoice
POST
{{BASE_URL}}/v1/paymentlinks?accountId={{ACCOUNT_ID}}
Query Parameters
accountId*
Account Id
Headers
Authorization*
Bearer Access Token
x-tag*
sandbox
Specify the environments
Request Body
name*
String
Name of the payment link
amount*
Amount to charge customer
description*
String
Description of the Payment Link
paymentType*
invoice
Link
{
"status": "success",
"data": {
"isActive": true,
"type": "oneTime",
"additionalInfoToCollect": [],
"paymentType": "invoice",
"tags": [],
"_id": "63c5699311a93b0016f3709c",
"name": "Gucci bag 2",
"description": "An original gucci bag that's affordable",
"account": "63bfcc902f650e001389f3f2",
"image": "https://res.cloudinary.com/jimrid/image/upload/v1637149484/avatar_dlxd4x.png",
"product": "63c5699311a93b0016f3709b",
"dueDate": "2022-01-20T00:00:00.000Z",
"otherAdditionalData": {
"businessDetails": {
"businessLogo": "https://res.cloudinary.com/jimrid/image/upload/v1637149484/avatar_dlxd4x.png",
"businessName": "Bino supermarket",
"businessEmail": "[email protected]",
"businessBillingAddress": "Ikaja mall",
"country": "Nigeria",
"state": "Lagos"
},
"customerDetails": {
"customerLogo": "logo here",
"customerName": "Ebbey Emma",
"customerEmail": "[email protected]",
"addressState": "Lagos",
"customerPhonenumber": "09779270026"
},
"itemDetails": [
{
"description": "Item 1",
"quantity": 1,
"price": 2700
}
]
},
"slug": "YxkZO3s1as",
"createdAt": "2023-01-16T15:13:23.539Z",
"model": "Paymentlinks",
"__v": 0
}
}
Invoices are ACTIVE by default
Newly created payment links are active
by default.
Activate an Invoice Link
Activate a Payment Link
PATCH
{{BASE_URL}}/v1/paymentlinks/{{PAYMENT_LINK_ID}}/activate?accountId={{ACCOUNT_ID}}
Query Parameters
accountId*
String
Account Id
Headers
String
{
// Response
}
Deactivate an Invoice Link
Deactivate a Payment Link
PATCH
{{BASE_URL}}/v1/paymentlinks/{{PAYMENT_LINK_ID}}/activate?accountId={{ACCOUNT_ID}}
Get a Invoice Link
Get a Payment Link
GET
{{BASE_URL}}/v1/paymentlinks/{{PAYMENT_LINK_ID}}/activate?accountId={{ACCOUNT_ID}}
Get All Invoices
Get all Invoice Links
GET
{{BASE_URL}}/v1/paymentlinks/{{PAYMENT_LINK_ID}}?accountId={{ACCOUNT_ID}}
Returns a list all a payment links
Query Parameters
accountId*
ACCOUNT_ID
populate
product
returns more information about payment link
Delete an Invoice Link
Delete an Invoice Link
DELETE
{{BASE_URL}}/v1/paymentlinks/{{PAYMENT_LINK_ID}}?accountId={{ACCOUNT_ID}}
Query Parameters
accountId
String
String
Last updated