Create a new payment link

POST

/api/v1/payment-links

Payment Links

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Header Params

Body Params application/json

Examples

Responses

🟢201Created

application/json

Payment link created successfully

Body

🟠400Bad Request

🟠401Unauthorized

🟠409409

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

cURL

sampleflexibleAmount

curl --location --request POST '/api/v1/payment-links' \
--header 'x-business-id;' \
--header 'Idempotency-Key;' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "title": "Premium Subscription",
    "description": "Monthly premium subscription with advanced features",
    "amount": 25000,
    "currency": "NGN",
    "slug": "premium-subscription",
    "expiresAt": "2025-12-31T23:59:59Z"
}'

Response Example

201 - sample

{
    "success": true,
    "message": "Payment link created successfully",
    "data": {
        "id": "pl_123456",
        "businessId": "biz_123",
        "title": "Premium Subscription",
        "description": "Monthly premium subscription with advanced features",
        "slug": "premium-subscription",
        "amount": "25000",
        "currency": "NGN",
        "status": "ACTIVE",
        "paymentUrl": "https://payment.rayswap.exchange/pay/premium-subscription",
        "isActive": true,
        "transactionCount": 0,
        "expiresAt": "2025-12-31T23:59:59Z",
        "createdAt": "2025-01-01T12:00:00Z",
        "updatedAt": "2025-01-01T12:00:00Z"
    }
}

Modified at 2025-09-04 20:35:45

Send invoice email to customer

Create subscription checkout session