# Create Payment Link

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /api/v0/quick-collect:
    post:
      summary: Create Payment Link
      deprecated: false
      description: >-

        :::highlight purple 📌

        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.

        :::
      tags:
        - Payment Gateway/APIs - Payment Gateway /Payment Links
      parameters:
        - name: Authorization
          in: header
          description: Bearer Authorization token generated using generate token API
          required: true
          example: Bearer ZW5rYXNoLWNsaWVudDplbmthc2gtc2VjcmV0
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                amount:
                  type: number
                  minimum: 1
                  maximum: 99999999
                createdBy:
                  type: string
                customerEmail:
                  type: string
                customerId:
                  type: string
                customerName:
                  type: string
                customerPhone:
                  type: string
                description:
                  type: string
                dueDate:
                  type: string
                  format: date
                note:
                  type: string
                notifyEmail:
                  type: boolean
                notifyPhone:
                  type: boolean
                parentLegalName:
                  type: string
                postToTally:
                  type: boolean
                reference:
                  type: string
                sellerId:
                  type: string
                  pattern: ^CEK[A-Z0-9]{7}$
                sendAutoReminder:
                  type: boolean
              x-apidog-orders:
                - 01JQDK815Y3BDCQFR65978Q5ZX
              required:
                - amount
                - dueDate
                - sellerId
              x-apidog-refs:
                01JQDK815Y3BDCQFR65978Q5ZX:
                  $ref: '#/components/schemas/QuickCollectCreateRequest'
              x-apidog-ignore-properties:
                - amount
                - createdBy
                - customerEmail
                - customerId
                - customerName
                - customerPhone
                - description
                - dueDate
                - note
                - notifyEmail
                - notifyPhone
                - parentLegalName
                - postToTally
                - reference
                - sellerId
                - sendAutoReminder
            examples: {}
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QuickCollectResponse'
          headers: {}
          x-apidog-name: Success
      security: []
      x-apidog-folder: Payment Gateway/APIs - Payment Gateway /Payment Links
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/616243/apis/api-11988705-run
components:
  schemas:
    QuickCollectCreateRequest:
      type: object
      required:
        - amount
        - dueDate
        - sellerId
      properties:
        amount:
          type: number
          minimum: 1
          maximum: 99999999
        createdBy:
          type: string
        customerEmail:
          type: string
        customerId:
          type: string
        customerName:
          type: string
        customerPhone:
          type: string
        description:
          type: string
        dueDate:
          type: string
          format: date
        note:
          type: string
        notifyEmail:
          type: boolean
        notifyPhone:
          type: boolean
        parentLegalName:
          type: string
        postToTally:
          type: boolean
        reference:
          type: string
        sellerId:
          type: string
          pattern: ^CEK[A-Z0-9]{7}$
        sendAutoReminder:
          type: boolean
      title: QuickCollectCreateRequest
      x-apidog-orders:
        - amount
        - createdBy
        - customerEmail
        - customerId
        - customerName
        - customerPhone
        - description
        - dueDate
        - note
        - notifyEmail
        - notifyPhone
        - parentLegalName
        - postToTally
        - reference
        - sellerId
        - sendAutoReminder
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    QuickCollectResponse:
      type: object
      properties:
        amount:
          type: number
        createdBy:
          type: string
        createdOn:
          type: string
          format: date-time
        customerEmail:
          type: string
        customerId:
          type: string
        customerLegalName:
          type: string
        customerName:
          type: string
        customerPhone:
          type: string
        deleted:
          type: boolean
        description:
          type: string
        dueDate:
          type: string
          format: date
        error:
          type: string
        modifiedBy:
          type: string
        note:
          type: string
        notifyEmail:
          type: boolean
        notifyPhone:
          type: boolean
        paymentLink:
          type: string
        payoutDetails:
          type: array
          uniqueItems: true
          items:
            $ref: '#/components/schemas/PayoutDetailModel'
        payoutStatus: &ref_0
          $ref: '#/components/schemas/EnumModel%C2%ABstring%C2%BB'
        postToTally:
          type: boolean
        quickCollectRequestId:
          type: string
        receivableStatus: *ref_0
        reference:
          type: string
        sendAutoReminder:
          type: boolean
      title: QuickCollectResponse
      x-apidog-orders:
        - amount
        - createdBy
        - createdOn
        - customerEmail
        - customerId
        - customerLegalName
        - customerName
        - customerPhone
        - deleted
        - description
        - dueDate
        - error
        - modifiedBy
        - note
        - notifyEmail
        - notifyPhone
        - paymentLink
        - payoutDetails
        - payoutStatus
        - postToTally
        - quickCollectRequestId
        - receivableStatus
        - reference
        - sendAutoReminder
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    EnumModel«string»:
      type: object
      properties:
        label:
          type: string
        name:
          type: string
          enum:
            - PAID
            - PARTIAL_PAID
            - REJECT
            - UNPAID
      title: EnumModel«string»
      x-apidog-orders:
        - label
        - name
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    PayoutDetailModel:
      type: object
      properties:
        payoutAmount:
          type: number
        payoutDate:
          type: string
          format: date-time
        payoutMode:
          type: string
        payoutStatus:
          type: string
          enum:
            - FAILED
            - IMPS_CALL_MADE
            - INIT
            - IN_PROGRESS
            - NEFT_CALL_MADE
            - ON_HOLD
            - PAID
            - PENDING
            - REINITIATE
            - SUCCESS
        payoutTransferId:
          type: string
        payoutTransferResponseReason:
          type: string
        remarks:
          type: string
        settlementPayoutId:
          type: string
        utr:
          type: string
      title: PayoutDetailModel
      x-apidog-orders:
        - payoutAmount
        - payoutDate
        - payoutMode
        - payoutStatus
        - payoutTransferId
        - payoutTransferResponseReason
        - remarks
        - settlementPayoutId
        - utr
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
  securitySchemes: {}
servers:
  - url: https://ekpayout-uat.enkash.in
    description: Testing Env
security: []

```