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.

Create New Payment Link

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}}

Create a new payment link

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*	2000	Amount to charge customer
description*	String	Description of the Payment Link

200: OK Payment Link Created Successfully

{
    "status": "success",
    "data": {
        "isActive": false,
        "type": "oneTime",
        "additionalInfoToCollect": [
            "mobile_number",
            "home_address"
        ],
        "tags": [],
        "_id": "639c8f77d62c230013cafb42",
        "name": "Gucci bag 2",
        "description": "An original gucci bag that's affordable",
        "account": "62bffdf5270d0600135de473",
        "product": "639c8f77d62c230013cafb41",
        "slug": "urbkVFD01E",
        "createdAt": "2022-12-16T15:32:07.914Z",
        "model": "Paymentlinks",
        "__v": 0
    }
}

Payment Links are ACTIVE by default

Newly created payment links are ACTIVE by default.

Activate a Payment 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

200: OK

{
    // Response
}

Deactivate a Payment Link

Deactivate a Payment Link

PATCH {{BASE_URL}}/v1/paymentlinks/{{PAYMENT_LINK_ID}}/activate?accountId={{ACCOUNT_ID}}

Edit a Payment Link

Edit a Payment Link

PATCH {{BASE_URL}}/v1/paymentlinks/{{PAYMENT_LINK_ID}}?accountId={{ACCOUNT_ID}}

200: OK

{
    "name": "Gucci bag 3"
}

Get a Payment Link

Get a Payment Link

GET {{BASE_URL}}/v1/paymentlinks/{{PAYMENT_LINK_ID}}/activate?accountId={{ACCOUNT_ID}}

Get All Payment Link

Get all Payment 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 a Payment Link

Delete a Payment Link

DELETE {{BASE_URL}}/v1/paymentlinks/{{PAYMENT_LINK_ID}}?accountId={{ACCOUNT_ID}}

Delete a payment link by ID

Path Parameters

Name	Type	Description
{{PAYMENT_LINK_ID}}	String

Query Parameters

Name	Type	Description
accountId*	String
	String

Get Transactions for a Payment Link

Get transactions for a payment link

GET {{BASE_URL}}/v1/paymentlinks/{{PAYMENT_LINK_ID}}/transactions?accountId={{ACCOUNT_ID}}

200: OK

{
    // Response
}

Get All Payment Links Transactions

Get all payment links transactions

GET {{BASE_URL}}/v1/accounts/{{ACCOUNT_ID}}/paymentlinkTransactions?accountId={{accountId}}

200: OK

{
    "status": "success",
    "data": [
        {
            "frontendStatus": "pending",
            "veendFee": 0,
            "otherFees": 1500,
            "purchaseReference": "uniq_ref_131223123455u7766",
            "cost": 1500,
            "merchantFee": 150,
            "customerFee": 0,
            "cashback": 37.5,
            "referralCommission": 0,
            "totalCost": 1500,
            "description": "NGN1500 - Golden Chance Lotto - uniq_ref_131223123455u7766",
            "currency": "NGN",
            "status": "pending",
            "paid": false,
            "delivered": false,
            "settled": false,
            "canRefund": false,
            "product": "63968a8377f4c0001357cbbe",
            "productsDetails": {
                "owner": "62bffdf5270d0600135de473",
                "amount": 1500,
                "currency": "NGN",
                "createdBy": "62bffdf5270d0600135de473",
                "payViaLink": true,
                "purchaseReference": "uniq_ref_131223123455u7766"
            },
            "ipAddress": "::ffff:192.168.32.85",
            "account": "62bffdf5270d0600135de473",
            "deliveryLog": null,
            "settlementLog": null,
            "refundLog": null,
            "validationDetails": null,
            "batch": null,
            "payment": null,
            "feeCalculationData": {
                "__v": 0,
                "_id": "63968a8377f4c0001357cbbe",
                "fee": 10,
                "name": "Golden Chance Lotto",
                "tags": [
                    "Golden",
                    "Chance",
                    "Lotto"
                ],
                "type": "oneTime",
                "model": "Products",
                "owner": "62bffdf5270d0600135de473",
                "amount": 1500,
                "isSync": false,
                "status": "default",
                "account": "62bffdf5270d0600135de473",
                "dueDate": "2022-12-12T01:57:23.319Z",
                "enabled": true,
                "feeType": "percentage",
                "cashback": 25,
                "currency": "NGN",
                "featured": false,
                "runCount": 0,
                "canRefund": false,
                "createdAt": "2022-12-12T01:57:23.319Z",
                "createdBy": "62bffdf5270d0600135de473",
                "updatedAt": "2022-12-12T02:00:01.370Z",
                "cashbackType": "percentage",
                "disableRetry": false,
                "additionalFee": 0,
                "hasValidation": true,
                "hasVariations": false,
                "convinienceFee": 0,
                "recurringCount": 0,
                "customerBearsFee": false,
                "hasSubVariations": false,
                "recurringInterval": "none",
                "convinienceFeeType": "percentage",
                "referralCommission": 25,
                "recurringIntervalCount": 1,
                "referralCommissionType": "percentage"
            },
            "retryCount": 0,
            "owner": "62bffdf5270d0600135de473",
            "createdBy": "62bffdf5270d0600135de473",
            "client": null,
            "developer": null,
            "tags": null,
            "_id": 268,
            "createdAt": "2022-12-12T02:07:24.000Z",
            "updatedAt": "2022-12-12T02:07:24.000Z"
        },
    ]
}