Retrieve Payment Link by Order Reference

GET

https://api.plexypay.com/v1/payment-links/order-reference/{order_reference}

This endpoint retrieves a payment link based on the provided order reference. It returns the details of the payment link if found.

Request

Authorization

API Key

Add parameter in header

Authorization

Example:

Authorization: ********************

Path Params

Responses

🟢200OK

application/json

Payment link details successfully retrieved

Body

🟠400Bad Request

🟠404Not Found

🔴500Internal Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.plexypay.com/v1/payment-links/order-reference/"ORDER123"' \
--header 'Authorization: <api-key>'

Response Example

200 - Example 1

{
    "amount": 1000000,
    "autoClearing": true,
    "createdAt": "2025-03-01T12:00:00Z",
    "currency": "KZT",
    "customerId": "string",
    "description": "Payment for services",
    "expiresAt": "2025-03-14T00:00:00Z",
    "id": "pl_5e9f8f8f9d9e9e9d9e9f8f8f8f9d9e9f",
    "metadata": {
        "callbackUrl": "https://example.com/callback",
        "cancelUrl": "https://example.com/cancel",
        "failureUrl": "https://example.com/failure",
        "successUrl": "https://example.com/success"
    },
    "orderReference": "ORD123456",
    "status": "active",
    "updatedAt": "2025-03-01T12:30:00Z",
    "url": "https://checkout.plexypay.com/pl_5e9f8f8f9d9e9e9d9e9f8f8f8f9d9e9f",
    "validation": false,
    "createdBy": "string"
}

Modified at 2025-09-23 07:42:36

List Payment Links

Cancel Payment Link