Payment Links
Receive Funds with our Payment Links API.
The Payment Links API allows you to create, update, activate and deactivate payment links. Payment Links provides a shareable URL to accept Payment from your customers.
Payment Link Slug
A payment link are shareable link. The shareable link is created by appending the slug in the JSON response to this URL -
https://pay.veendhq.com/p/ For example,https://pay.veendhq.com/p/{{SLUG}}post
{{BASE_URL}}
/v1/paymentlinks?accountId={{ACCOUNT_ID}}
Create a new payment link
Parameters
Query
accountId*
Account Id
Header
Authorization*
Bearer Access Token
x-tag*
sandbox
Specify the environments
Body
name*
Name of the payment link
description*
Description of the Payment Link
amount*
2000
Amount to charge customer
Responses
200: OK
Payment Link Created Successfully
Payment Links are ACTIVE by default
Newly created payment links are
ACTIVE by default. patch
{{BASE_URL}}
/v1/paymentlinks/{{PAYMENT_LINK_ID}}/activate?accountId={{ACCOUNT_ID}}
Activate a Payment Link
Parameters
Query
accountId*
Account Id
Header
Responses
200: OK
patch
{{BASE_URL}}
/v1/paymentlinks/{{PAYMENT_LINK_ID}}/activate?accountId={{ACCOUNT_ID}}
Deactivate a Payment Link
Parameters
No parameters
Responses
patch
{{BASE_URL}}
/v1/paymentlinks/{{PAYMENT_LINK_ID}}?accountId={{ACCOUNT_ID}}
Edit a Payment Link
Parameters
No parameters
Responses
200: OK
get
{{BASE_URL}}
/v1/paymentlinks/{{PAYMENT_LINK_ID}}/activate?accountId={{ACCOUNT_ID}}
Get a Payment Link
Parameters
No parameters
Responses
get
{{BASE_URL}}
/v1/paymentlinks/{{PAYMENT_LINK_ID}}?accountId={{ACCOUNT_ID}}
Get all Payment Links
Returns a list all a payment links
Parameters
Query
accountId*
ACCOUNT_ID
populate
product
returns more information about payment link
Responses
delete
{{BASE_URL}}
/v1/paymentlinks/{{PAYMENT_LINK_ID}}?accountId={{ACCOUNT_ID}}
Delete a Payment Link
Delete a payment link by ID
Parameters
Path
{{PAYMENT_LINK_ID}}
Query
accountId*
Responses
get
{{BASE_URL}}
/v1/paymentlinks/{{PAYMENT_LINK_ID}}/transactions?accountId={{ACCOUNT_ID}}
Get transactions for a payment link
Parameters
No parameters
Responses
200: OK
get
{{BASE_URL}}
/v1/accounts/{{ACCOUNT_ID}}/paymentlinkTransactions?accountId={{accountId}}
Get all payment links transactions
Parameters
No parameters
Responses
200: OK
Last modified 7mo ago