Create Payment Link

POST

/api/v0/quick-collect

📌

Use this API to generate a payment link with Olympus directly from your backend. This enables you to create payment links programmatically and collect payments seamlessly, without requiring manual link creation or front-end dependency.

Request

Header Params

Body Params application/json

Example

{
    "amount": 1,
    "createdBy": "string",
    "customerEmail": "string",
    "customerId": "string",
    "customerName": "string",
    "customerPhone": "string",
    "description": "string",
    "dueDate": "2019-08-24",
    "note": "string",
    "notifyEmail": true,
    "notifyPhone": true,
    "parentLegalName": "string",
    "postToTally": true,
    "reference": "string",
    "sellerId": "string",
    "sendAutoReminder": true
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api/v0/quick-collect' \
--header 'Authorization: Bearer ZW5rYXNoLWNsaWVudDplbmthc2gtc2VjcmV0' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amount": 1,
    "createdBy": "string",
    "customerEmail": "string",
    "customerId": "string",
    "customerName": "string",
    "customerPhone": "string",
    "description": "string",
    "dueDate": "2019-08-24",
    "note": "string",
    "notifyEmail": true,
    "notifyPhone": true,
    "parentLegalName": "string",
    "postToTally": true,
    "reference": "string",
    "sellerId": "string",
    "sendAutoReminder": true
}'

Responses

🟢200Success

application/json

Body

Example

{
    "amount": 0,
    "createdBy": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "customerEmail": "string",
    "customerId": "string",
    "customerLegalName": "string",
    "customerName": "string",
    "customerPhone": "string",
    "deleted": true,
    "description": "string",
    "dueDate": "2019-08-24",
    "error": "string",
    "modifiedBy": "string",
    "note": "string",
    "notifyEmail": true,
    "notifyPhone": true,
    "paymentLink": "string",
    "payoutDetails": [
        {
            "payoutAmount": 0,
            "payoutDate": "2019-08-24T14:15:22Z",
            "payoutMode": "string",
            "payoutStatus": "FAILED",
            "payoutTransferId": "string",
            "payoutTransferResponseReason": "string",
            "remarks": "string",
            "settlementPayoutId": "string",
            "utr": "string"
        }
    ],
    "payoutStatus": {
        "label": "string",
        "name": "PAID"
    },
    "postToTally": true,
    "quickCollectRequestId": "string",
    "receivableStatus": {
        "label": "string",
        "name": "PAID"
    },
    "reference": "string",
    "sendAutoReminder": true
}

Modified at 2025-07-05 14:42:22

Payment Link APIs

Get Payment Link Details