> ## Documentation Index
> Fetch the complete documentation index at: https://docs.dollarpe.xyz/llms.txt
> Use this file to discover all available pages before exploring further.

# Create Payin

> Initiates a payin order against a valid, unexpired quotation, starting the on-ramp flow.

<Prompt description="Create Payin" actions={["cursor"]}>
  Integrate the DollarPe Create Payin endpoint into my application.

  Endpoint: POST /payin/initiate
  Base URL: [https://api.dollarpe.in](https://api.dollarpe.in) (production) | [https://sandbox.dollarpe.in](https://sandbox.dollarpe.in) (sandbox)

  Auth headers required on every request:

  * X-API-KEY: your API key
  * X-TIMESTAMP: current Unix time in seconds
  * X-SIGNATURE: Base64(HMAC-SHA256(X-API-KEY + X-TIMESTAMP + sortedJSONBody, apiSecret))

  Payin flow:

  1. POST /payin/quotation → get quotation\_id and locked rate
  2. POST /payin/initiate → create the order (link to quotation\_id)
  3. Customer transfers fiat using the returned bank details
  4. Poll GET /payin/{payin_id} or listen to webhooks for status updates

  Task: Write a typed function that:

  1. Accepts quotation\_id, customer\_id, client\_reference\_id, and bank account details
  2. Builds the signed auth headers
  3. Calls POST /payin/initiate
  4. Returns payin\_id and initial status
  5. Handles 400 errors (expired/duplicate quotation, customer mismatch)

  Language: TypeScript
</Prompt>

## Error Codes and Messages

| API Status Code | Response                                      | Reason                                                           |
| --------------- | --------------------------------------------- | ---------------------------------------------------------------- |
| 400             | UTR is already linked to another payin        | UTR already linked to another payin                              |
| 400             | Client Reference ID already exists            | Client Reference ID already exists                               |
| 400             | Invalid UTR format                            | UTR length is not equal to 12 characters                         |
| 400             | Quotation is not found                        | Quotation does not exist or does not belong to this organization |
| 400             | Customer ID does not match with the quotation | Customer ID mismatch between payin order and quotation           |
| 400             | Quotation has expired                         | Quotation has expired                                            |
| 400             | Quotation is already linked to another payin  | Quotation is already linked to another payin                     |
| 500             | Internal Server Error                         | Internal Server Error                                            |


## OpenAPI

````yaml POST /payin/initiate
openapi: 3.1.0
info:
  title: DollarPe API
  description: API for DollarPe - Customer, Payout, and Webhook services
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://sandbox.dollarpe.xyz/pos/api/v1
    description: Payout API Base URL
    variables:
      base_url:
        default: https://sandbox.dollarpe.xyz
  - url: https://sandbox.dollarpe.xyz/cms/api/v1
    description: Customer API Base URL
    variables:
      base_url:
        default: https://sandbox.dollarpe.xyz
security:
  - ApiKeyAuth: []
    TimestampAuth: []
    SignatureAuth: []
tags:
  - name: Customer
    description: Customer related operations
    x-displayName: Customer
    x-traitTag: true
  - name: Payout
    description: Payout related operations
  - name: Webhooks
    description: Webhook related operations
  - name: Widget
    description: Hosted buy/sell widget session initialization
paths:
  /payin/initiate:
    post:
      tags:
        - Payin
      description: Create a new payin using a quotation
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - quotation_id
                - customer_id
                - utr
              properties:
                quotation_id:
                  type: string
                  format: uuid
                  description: The unique identifier of the quotation
                  example: 2e104290-07c8-49f1-a5ca-0d27f0078f8a
                customer_id:
                  type: string
                  format: uuid
                  description: The unique identifier of the customer
                  example: def8b740-99f9-4cba-bc9e-99de57e927b4
                client_reference_id:
                  type: string
                  description: Optional client reference ID for tracking
                  example: testUser123
                utr:
                  type: string
                  description: UTR of the bank transaction
                  example: RATN0329SJDH0
      responses:
        '201':
          description: Payin created successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: Success
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                        example: 5b75096f-de8d-44b4-9230-d94e6948abb6
                      quotation_id:
                        type: string
                        format: uuid
                        example: 2e104290-07c8-49f1-a5ca-0d27f0078f8a
                      customer_id:
                        type: string
                        format: uuid
                        example: def8b740-99f9-4cba-bc9e-99de57e927b4
                      client_reference_id:
                        type: string
                        example: testUser123
                      bank_id:
                        type: string
                        format: uuid
                        example: e75f62f0-db9e-4904-8103-d6f14f67f5dc
                      asset:
                        type: string
                        example: USDT
                      fiat:
                        type: string
                        example: INR
                      payment_method:
                        type: string
                        example: IMPS
                      rate:
                        type: number
                        format: float
                        example: 82.5
                      sending_amount:
                        type: number
                        format: float
                        example: 51
                      receiving_amount:
                        type: number
                        format: float
                        example: 4144.6
                      fees:
                        type: object
                        properties:
                          client_fee_fiat:
                            type: number
                            format: float
                            example: 450
                          client_fee_crypto:
                            type: number
                            format: float
                            example: 5
                          dollarpe_fee:
                            type: number
                            format: float
                            example: 450
                          pg_fee:
                            type: number
                            format: float
                            example: 18
                          client_gst_fiat:
                            type: number
                            format: float
                            example: 81
                          client_gst_crypto:
                            type: number
                            format: float
                            example: 0.9
                          dollarpe_gst:
                            type: number
                            format: float
                            example: 81
                          pg_gst:
                            type: number
                            format: float
                            example: 81
                          tds:
                            type: number
                            format: float
                            example: 889.17
                          gross_effective_exchange_rate:
                            type: number
                            format: float
                            example: 88.92
                      deposit_instructions:
                        type: object
                        properties:
                          account_number:
                            type: string
                            example: '1234567890'
                          ifsc:
                            type: string
                            example: '1234567890'
                          account_name:
                            type: string
                            example: Sandbox Technologies Pvt Ltd
                      utr:
                        type: string
                        example: RATN0329SJDH0
                      created_at:
                        type: string
                        format: date-time
                        example: '2025-03-08T07:31:24.770179Z'
                      status:
                        type: string
                        example: PROCESSING
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: Bad Request
                  err_code:
                    type: string
                    example: REQ_FIELD_MISSING
                  errors:
                    type: object
                    properties:
                      quotation_id:
                        type: array
                        items:
                          type: string
                        example:
                          - This field is required.
                  data:
                    type: 'null'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: Internal Server Error
                  err_code:
                    type: string
                    example: SYS_INTERNAL_ERROR
                  errors:
                    type: string
                    example: Unexpected error occurred. Please try again later.
                  data:
                    type: 'null'
      servers:
        - url: https://sandbox.dollarpe.xyz/pis/api/v1
          description: Payin API Base URL
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY
      description: API Key for authentication
    TimestampAuth:
      type: apiKey
      in: header
      name: X-TIMESTAMP
      description: Current timestamp in seconds since epoch
    SignatureAuth:
      type: apiKey
      in: header
      name: X-SIGNATURE
      description: HMAC SHA256 signature of the request encoded in Base64

````