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

# Create refund

> Refunds a completed payment, fully or partially.



## OpenAPI

````yaml /openapi.yaml post /v1/refunds
openapi: 3.0.3
info:
  title: Quentli REST API
  version: 1.0.0
  description: OpenAPI spec for Quentli REST endpoints.
servers:
  - url: https://api.quentli.com
    description: Production API
  - url: https://api.staging.quentli.com
    description: Staging API for production-like validation
security:
  - organizationApiKey: []
tags:
  - name: Auth
  - name: Billing
  - name: Catalog
  - name: Customers
  - name: Invoices
  - name: Payment Methods
  - name: Payment Sessions
  - name: Payments
  - name: Subscriptions
  - name: Tax Invoices
  - name: Webhooks
paths:
  /v1/refunds:
    post:
      tags:
        - Payments
      summary: Create refund
      description: Refunds a completed payment, fully or partially.
      operationId: refunds_create
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateRefundArgs'
      responses:
        '200':
          description: Refund created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateRefundPayload'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserError'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserError'
        '403':
          description: Permission denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserError'
        '404':
          description: Payment not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserError'
components:
  schemas:
    CreateRefundArgs:
      type: object
      properties:
        input:
          type: object
          properties:
            paymentId:
              type: string
              description: Identifier of the payment to refund.
              example: p_1234567890abcdefghij
            amount:
              type: number
              minimum: 0
              exclusiveMinimum: true
              description: Refund amount in minor currency units.
              example: 150000
            customRefundReason:
              type: string
              nullable: true
              description: Optional reason for the refund.
              example: null
          required:
            - paymentId
            - amount
      required:
        - input
      description: Request body for creating a refund.
    CreateRefundPayload:
      type: object
      properties:
        payment:
          $ref: '#/components/schemas/Payment'
        refund:
          $ref: '#/components/schemas/Refund'
      required:
        - payment
        - refund
      description: Created refund and its payment.
    UserError:
      type: object
      properties:
        error:
          type: object
          properties:
            message:
              type: string
          required:
            - message
      required:
        - error
      additionalProperties: false
      description: Standard user-facing error response envelope.
    Payment:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier of the payment.
          example: p_1234567890abcdefghij
        createdAt:
          type: string
          format: date-time
          description: When the payment record was created.
          example: '2025-01-15T18:30:00.000Z'
        updatedAt:
          type: string
          format: date-time
          description: When the payment was last updated.
          example: '2025-01-15T18:30:00.000Z'
        amount:
          type: number
          description: Payment amount in minor currency units.
          example: 150000
        currency:
          type: string
          description: ISO 4217 currency code.
          example: MXN
        description:
          type: string
          nullable: true
          description: Human-readable description of the payment.
          example: Colegiatura Enero 2025
        type:
          type: string
          nullable: true
          enum:
            - TRANSFER
            - CARD
            - OXXO
            - OTHER
            - CASH
            - DIRECT_DEBIT
            - null
          description: Payment type.
          example: CARD
        status:
          type: string
          nullable: true
          enum:
            - INCOMPLETE
            - COMPLETE
            - CANCELED
            - INITIATED
            - REFUNDED
            - DISPUTED
            - REVERTED
            - null
          description: Current payment status.
          example: COMPLETE
        isCompleted:
          type: boolean
          description: Whether the payment has been fully settled.
          example: true
        paymentTime:
          type: string
          nullable: true
          format: date-time
          description: Date and time when the payment was completed.
          example: '2025-01-15T18:30:00.000Z'
        customerId:
          type: string
          description: Identifier of the customer who made the payment.
          example: cus_1234567890abcdefghij
        paymentIntentId:
          type: string
          nullable: true
          description: Payment processor intent identifier, if any.
          example: null
        paymentMethodId:
          type: string
          nullable: true
          description: Identifier of the payment method used, if any.
          example: pm_1234567890abcdefghij
        organizationId:
          type: string
          description: Identifier of the owning organization.
          example: org_1234567890abcdefghij
        skipTaxInvoice:
          type: boolean
          description: Whether tax invoice generation is skipped for this payment.
          example: false
        monthlyInstallments:
          type: integer
          nullable: true
          description: Number of monthly installments, if any.
          example: null
        processor:
          type: string
          nullable: true
          enum:
            - FISERV
            - KUSHKI
            - QUENTLI
            - SANTANDER
            - STRIPE
            - TAPI
            - null
          description: Processor that handled the payment, if any.
          example: null
        processorFee:
          type: integer
          nullable: true
          description: Processor fee in minor currency units, if known.
          example: null
        processorFeeTax:
          type: integer
          nullable: true
          description: Tax on the processor fee in minor currency units, if known.
          example: null
        installmentsFee:
          type: integer
          nullable: true
          description: Installments fee in minor currency units, if any.
          example: null
        installmentsFeeTax:
          type: integer
          nullable: true
          description: Tax on the installments fee in minor currency units, if any.
          example: null
        externalPaymentTypeId:
          type: string
          nullable: true
          description: External payment type identifier when type is OTHER.
          example: null
        sessionId:
          type: string
          nullable: true
          description: Payment session identifier associated with this payment, if any.
          example: null
        metadata:
          type: array
          nullable: true
          items:
            type: object
            properties:
              key:
                type: string
              value:
                type: string
            required:
              - key
              - value
            additionalProperties: false
          description: Structured metadata entries.
          example: null
        meta:
          type: object
          nullable: true
          additionalProperties:
            type: string
          description: Flattened metadata key-value map.
          example: null
      required:
        - id
        - createdAt
        - updatedAt
        - amount
        - currency
        - description
        - type
        - status
        - isCompleted
        - paymentTime
        - customerId
        - paymentIntentId
        - organizationId
        - skipTaxInvoice
        - monthlyInstallments
        - processor
        - processorFee
        - processorFeeTax
        - installmentsFee
        - installmentsFeeTax
        - externalPaymentTypeId
        - sessionId
      description: A payment record for a completed or pending transaction.
    Refund:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier of the refund.
          example: ref_1234567890abcdefghij
        createdAt:
          type: string
          format: date-time
          description: When the refund was created.
          example: '2025-01-15T18:30:00.000Z'
        updatedAt:
          type: string
          format: date-time
          description: When the refund was last updated.
          example: '2025-01-15T18:30:00.000Z'
        amount:
          type: integer
          description: Refund amount in minor currency units.
          example: 150000
        currency:
          type: string
          description: ISO 4217 currency code.
          example: MXN
        status:
          type: string
          enum:
            - REQUESTED
            - APPROVED
            - DECLINED
          description: Current refund status.
          example: REQUESTED
        statusUpdatedAt:
          type: string
          format: date-time
          description: When the refund status was last updated.
          example: '2025-01-15T18:30:00.000Z'
        paymentId:
          type: string
          description: Identifier of the refunded payment.
          example: p_1234567890abcdefghij
        madeById:
          type: string
          description: Identifier of the user who created the refund.
          example: u_1234567890abcdefghij
        payoutId:
          type: string
          nullable: true
          description: Identifier of the related payout, if any.
          example: null
        customRefundReason:
          type: string
          nullable: true
          description: Optional reason for the refund.
          example: null
      required:
        - id
        - createdAt
        - updatedAt
        - amount
        - currency
        - status
        - statusUpdatedAt
        - paymentId
        - madeById
        - payoutId
        - customRefundReason
      description: A refund created for a payment.
  securitySchemes:
    organizationApiKey:
      type: http
      scheme: bearer
      description: 'Organization API key using `Authorization: Bearer sk_...`.'

````