Create Payment Link - Enkash APIs

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

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
}