List Payment Links

The List Payment Links API allows partners to list all Payment Links for a given merchant ID.

Get all Payment Links associated with the merchant account

GET https://<PayEngine-host>/api/merchant/:merchant_id/payment-link

Path Parameters

Name	Type	Description
merchant_id*	string	PayEngine merchant ID

Query Parameters

Name	Type	Description
page	string	Page number requested (default: 1). Results are sorted by creation date in descending order
limit	string	Number of items per page. Default and minimum is 10; max=500

200: OK

Field Definitions

This API will return an array of the following object.

Field Name	Type	Description	Required?
payment_link_id	string	PayEngine system ID for the Payment Link	Required
payment_link_url	string	Payment Link URL	Required
qr_code_url	string	Payment Link QR Code URL	Required
payment_link_status	string	ACTIVE, INACTIVE, COMPLETED, CANCELLED	Required
merchant_id	string	Merchant ID	Required
start_date	string	Start date of Payment Link	optional
end_date	string	End date of Payment Link	Optional
amount	string	Amount charged at every transaction	Required
currency_code	string	ISO Currency code If not provided it defaults to US Dollar (USD)	Optional
payment_methods	string	Accepted values - CC_DC, ACH	Required
sales_tax	string	Sales tax included in the amount	Optional
order_number	string	Order or Invoice number. Alphanumeric (a-z A-Z 0-9) maximum 20 characters	Optional
description	string	Description of Payment Link	Optional
created_at	timestamp	Payment Link creation date	Required
updated_at	timestamp	Payment Link updated at	Required
internal_transaction_id	string	Internal Transaction ID if provided during creation or update	Optional
metadata	Object	Return all the metadata sent in the request	Optional

Pagination meta data is provided in the response to support lazy loading and pagination.

"meta": {
    "total": 12,
    "current_page": 1,
    "total_pages": 6
}

Sample Request

curl --location --request GET '<API_HOST>/api/merchant/1cc7b594-b80f-4227-a0fa-299c4c6ce8ab/payment-link?page=1&limit=2' \
--header 'Authorization: Basic <API_KEY>'

Sample Response

{
    "data": [
        {
            "merchant_id": "1cc7b594-b80f-4227-a0fa-299c4c6ce8ab",
            "one_time_only": true,
            "amount": "1270.22",
            "currency_code": "USD",
            "payment_methods": ["CC_DC","ACH"],
            "sales_tax": "0.00",
            "order_number": null,
            "description": "A coffee cup in the morning",
            "start_date": null,
            "end_date": null,
            "created_at": "2022-09-11T02:30:12.618Z",
            "updated_at": "2022-09-11T02:30:12.618Z",
            "merchant_name": "Test Business",
            "payment_link_id": "41ke9",
            "payment_link_status": "ACTIVE",
            "payment_link_url": "https://staging-sandbox.payengine.dev/payment-link/41ke9",
            "qr_code_url": "https://staging-sandbox.payengine.dev/payment-link/41ke9/qr",
            "metadata": {
                 "customer_id": "123",
                 "email" : "[email protected]"
             }
        },
        {
            "merchant_id": "1cc7b594-b80f-4227-a0fa-299c4c6ce8ab",
            "one_time_only": true,
            "amount": "1270.22",
            "currency_code": "USD",
            "payment_methods": ["CC_DC","ACH"],
            "sales_tax": "0.00",
            "order_number": null,
            "payer_id": "1234",
            "payer_email": null,
            "description": "A coffee cup in the morning",
            "start_date": null,
            "end_date": null,
            "created_at": "2022-09-11T02:30:12.618Z",
            "updated_at": "2022-09-11T02:30:12.618Z",
            "merchant_name": "Test Business",
            "payment_link_id": "dtvxs",
            "payment_link_status": "ACTIVE",
            "payment_link_url": "https://staging-sandbox.payengine.dev/payment-link/dtvxs",
            "qr_code_url": "https://staging-sandbox.payengine.dev/payment-link/dtvxs/qr",
            "metadata": {
                 "customer_id": "123",
                 "email" : "[email protected]"
             }
        }
    ],
    "meta": {
        "total": 12,
        "current_page": 1,
        "total_pages": 6
    }
}