Enkash Developer Portal
Home
Home
Login
  1. Payment Links
  • Back to home
  • Payment Gateway APIs
  • Authorisation
    • Get Authorization Token
  • Order
    • Create Order
    • Get Order Status
    • Get Order By Merchant Order Id
    • Get BNPL Payment Methods
    • Get Dynamic UPI QR
    • UPI Intent Links
  • Payment
    • Submit Payment Request
    • Get Transaction Status
    • Validate OTP
    • Resend OTP
    • Payment Notify Request
    • Get UPI Transaction Status
    • Verify UPI VPA
  • Refund
    • Refund
  • Settlement
    • Get Settlement Payout By ID
    • Search Settlement Payouts
  • Split Settlement
    • Create Split Settlement Account
    • Update Split Settlement Account
    • Get All Split Settlement Account
    • Deactivate Split Settlement Account
    • Activate Split Settlement Account
    • Submit Payment with Split Details
    • Edit Or Deferred Split Settlement
  • E-Commerce Plugins
  • UPI QR
    • Create UPI QR
    • Get UPI QR
    • Search UPI QR
    • Create Customer
    • Search Customer
    • Cancel UPI QR
  • UPI Autopay
    • Create UPI Mandate
    • Update UPI Mandate
    • Revoke UPI Mandate
    • Get UPI Mandate
    • UPI Mandate Callback
    • Mandate Pre-debit Notification
    • Execute Mandate Debit
    • Mandate Debit Callback
  • Payment Links
    • Payment Link APIs
    • Create Payment Link
      POST
    • Get Payment Link Details
      GET
    • Delete Payment Link
      DELETE
    • Webhook Request
      POST
  1. Payment Links

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
Authorization
string 
required
Bearer Authorization token generated using generate token API
Example:
Bearer ZW5rYXNoLWNsaWVudDplbmthc2gtc2VjcmV0
Body Params application/json
amount
number 
required
>= 1<= 99999999
createdBy
string 
optional
customerEmail
string 
optional
customerId
string 
optional
customerName
string 
optional
customerPhone
string 
optional
description
string 
optional
dueDate
string <date>
required
note
string 
optional
notifyEmail
boolean 
optional
notifyPhone
boolean 
optional
parentLegalName
string 
optional
postToTally
boolean 
optional
reference
string 
optional
sellerId
string 
required
Match pattern:
^CEK[A-Z0-9]{7}$
sendAutoReminder
boolean 
optional
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 samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
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
amount
number 
optional
createdBy
string 
optional
createdOn
string <date-time>
optional
customerEmail
string 
optional
customerId
string 
optional
customerLegalName
string 
optional
customerName
string 
optional
customerPhone
string 
optional
deleted
boolean 
optional
description
string 
optional
dueDate
string <date>
optional
error
string 
optional
modifiedBy
string 
optional
note
string 
optional
notifyEmail
boolean 
optional
notifyPhone
boolean 
optional
paymentLink
string 
optional
payoutDetails
array[object (PayoutDetailModel) {9}] 
optional
payoutAmount
number 
optional
payoutDate
string <date-time>
optional
payoutMode
string 
optional
payoutStatus
enum<string> 
optional
Allowed values:
FAILEDIMPS_CALL_MADEINITIN_PROGRESSNEFT_CALL_MADEON_HOLDPAIDPENDINGREINITIATESUCCESS
payoutTransferId
string 
optional
payoutTransferResponseReason
string 
optional
remarks
string 
optional
settlementPayoutId
string 
optional
utr
string 
optional
payoutStatus
object (EnumModel«string») 
optional
label
string 
optional
name
enum<string> 
optional
Allowed values:
PAIDPARTIAL_PAIDREJECTUNPAID
postToTally
boolean 
optional
quickCollectRequestId
string 
optional
receivableStatus
object (EnumModel«string») 
optional
reference
string 
optional
sendAutoReminder
boolean 
optional
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
Previous
Payment Link APIs
Next
Get Payment Link Details
Built with