Payment Link Details

---

description: This API allows partners to retrieve details of a payment link given its ID.

Payment Link Details

Retrieve details for a Payment Link given its ID

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

Request

Path Parameters

Name	Type	Description
id*	string	Payment Link ID

200

Field Definitions

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
payment_methods	array	Accepted values - CC_DC, ACH	Optional
use_same_amount	boolean	True | False	Required
amount	string	Amount charged at every transaction	Required only when use_same_amount is True
cc_amount	string	Payment Link amount for Credit Card users	Required only when use_same_amount is false
cc_amount_note	string	A note or explanation for the payment amount specific to Credit Card users if provided	Optional
ach_amount	string	Payment Link amount for ACH users	Required only when use_same_amount is false
ach_amount_note	string	A note or explanation for the payment amount specific to ACH users if provided	Optional
save_card_consent	boolean	True | False	Required
one_time_only	boolean	True | False	Required
currency_code	string	ISO Currency code If not provided it defaults to US Dollar (USD)	Optional
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
enable_captcha	boolean	True | False	Required
slug_id	string	Slug text for the generated payment page URL. By default, it is auto-generated. This slug text has to be unique in PayEngine environment	Optional
created_at	timestamp	Payment Link creation date	Required
updated_at	timestamp	Payment Link updated at	Required
internal_transaction_id	string	Internal Transaction ID provided during creation	Optional
metadata	object	Return all the metadata sent in the request	Optional

Sample Request

curl --location --request GET '<API_HOST>/api/payment-link/r1hzy' \
--header 'Authorization: Basic <API_KEY>'

Sample Response

{
    "data": {
        "payment_link_id": "wlx57",
        "merchant_id": "1cc7b594-b80f-4227-a0fa-299c4c6ce8ab",
        "amount": "12.50",
        "currency_code": "USD",
        "payment_methods": ["CC_DC","ACH"],
        "sales_tax": "2.50",
        "order_number": "A350",
        "description": "A coffee cup in the morning",
        "start_date": "2022-05-10T00:00:00.000Z",
        "end_date": "2022-11-15T00:00:00.000Z",
        "created_at": "2022-09-11T03:36:42.113Z",
        "updated_at": "2022-09-11T03:36:42.113Z",        
        "payment_link_status": "ACTIVE",
        "payment_link_url": "<Payment URL>",
        "qr_code_url": "<QRCode Image URL>",
        "metadata": {
            "customerId": "123",
            "email" : "[email protected]"
        }
    }
}