Get payment link details
curl -X GET "https://test-api.kashier.io/v2/payment-link/string"{ "message": "Payment links retrieved successfully", "data": { "_id": "67a3647454cfd700129b9424", "description": "", "paymentStatus": "paid", "dueDate": "2030-01-01 00:00:00+00:00", "isSuspendedPayment": false, "currency": "EGP", "paymentLinkId": "PL-2348668602", "merchantId": "MID-XXXXX-XXX", "paymentType": "simple", "totalAmount": 100, "state": "submitted", "customerName": "John Doe", "paymentRequestId": "PR-2348668602", "creationDate": "2025-02-05 13:15:32.949000+00:00", "merchantInfo": { "storeName": "demo" }, "extraFees": [ { "name": "shipping", "flatFee": 60, "rate": 0 }, { "name": "tax", "flatFee": 0, "rate": 14 } ], "invoiceItems": [], "isDeleted": false, "referenceId": "123ss456", "totalAmountWithoutFees": 200, "customer": null, "virtualAmount": null, "virtualCurrency": null, "virtualExchangeRate": null, "virtualRateRecordedAt": null }, "exchangeRateServiceAvailable": true, "history": { "records": [ { "event": "MARKED_AS_PAID", "metadata": { "timestamp": "2025-02-06 11:25:38.642000+00:00", "transactionInfoId": "TX-2348668602", "amount": 100, "currency": "EGP", "status": "SUCCESS", "customerName": "John Doe" }, "stateChanges": { "updated": { "paymentStatus": { "from": "unpaid", "to": "paid" } } } }, { "event": "CREATED", "metadata": { "timestamp": "2025-02-05 13:15:32.962000+00:00", "source": "API", "channel": "payment_link", "createdVia": "web" } } ] }}Retrieves a single payment link, including its extra fees, invoice items, and the full audit history of the link (creation, edits, shares, and payments).
Authorization
secretKey Merchant secret key used to identify the merchant, obtained from Kashier's dashboard. Pass the raw secret key value in the Authorization header (NOT a "Bearer" token).
In: header
Path Parameters
The payment link identifier. Example: PL-2348668602
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
Get payment link statistics GET
Returns aggregate statistics across the merchant's payment links (counts and amounts broken down by payment status). Accepts the same optional filters as listPaymentLinks, so the totals match the l…
Delete a payment link DELETE
Deletes a payment link. The link is soft-deleted (isDeleted becomes true) and stops being payable.