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
Invoice Slug
Invoices are shareable link. The shareable link is created by appending the slug in the JSON response to this URL - https://pay.veendhq.com/p/
https://pay.veendhq.com/p/{{SLUG}}
Create a new invoice
POST
{{BASE_URL}}/v1/paymentlinks?accountId={{ACCOUNT_ID}}
Query Parameters
Name | Type | Description |
---|---|---|
accountId* | Account Id |
Headers
Name | Type | Description |
---|---|---|
Authorization* | Bearer Access Token | |
x-tag* | sandbox | Specify the environments |
Request Body
Name | Type | Description |
---|---|---|
name* | String | Name of the payment link |
amount* | Amount to charge customer | |
description* | String | Description of the Payment Link |
paymentType* | invoice | Link |
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
Name | Type | Description |
---|---|---|
accountId* | String | Account Id |
Headers
Name | Type | Description |
---|---|---|
String |
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
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
accountId | String | |
String |
Last updated