Create Payment Link

POST

https://api.plexypay.com/v1/payment-links

This endpoint allows merchants to create a payment link that can be shared with customers for making payments. The payment link contains details such as the amount, currency, description, and optional metadata. It can also be customized with URLs for success, failure, and cancellation scenarios. The payment link is valid until the specified expiration date and can be used for one-time or recurring payments depending on the provided settings.

Request

Authorization

API Key

Add parameter in header

Authorization

Example:

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

Body Params application/json

Examples

Responses

🟢201Created

application/json

Payment link successfully created

Body

🟠400Bad Request

🟠404Not Found

🔴500Internal Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.plexypay.com/v1/payment-links' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amount": 5000,
    "currency": "KZT",
    "description": "Test Payment",
    "expiresAt": "2026-12-14T00:00:00Z",
    "metadata": {
        "callbackUrl": "https://insecure-spear.net",
        "cancelUrl": "https://deafening-slime.name",
        "failureUrl": "https://tangible-forager.com/",
        "successUrl": "https://sophisticated-dredger.com"
    },
    "orderReference": "icDA7Co8W1WtMbdWszDvk",
    "validation": false,
    "autoClearing": true
}'

Response Example

201 - 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",
    "lineItems": {
        "lineItems": [
            {
                "name": "string",
                "price": "string",
                "vat": "string",
                "quantity": "string"
            }
        ]
    }
}

Modified at 2025-12-19 10:49:51

Payment Links

List Payment Links