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

# Create refund

> Refund all or part of a succeeded payment. Optionally provide an `X-Idempotency-Key` header so retries with the same key and request return the existing refund.

<Info>
  Slash Payment Processing is in beta and not enabled for all accounts. Contact
  [support@joinslash.com](mailto:support@joinslash.com) to get access.
</Info>


## OpenAPI

````yaml post /refund
openapi: 3.1.0
info:
  title: Slash Public API
  description: API description
  version: 0.0.1
  contact: {}
servers:
  - url: https://api.slash.com
    description: production
security:
  - api_key: []
  - partner_api_key: []
  - bearer: []
  - developer_application: []
paths:
  /refund:
    post:
      description: >-
        Refund all or part of a succeeded payment. Optionally provide an
        `X-Idempotency-Key` header so retries with the same key and request
        return the existing refund.
      parameters:
        - name: X-Idempotency-Key
          description: >-
            An optional unique key for this refund. Retrying the same request
            with the same key returns the previously created refund.
          in: header
          required: false
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                paymentIntentId:
                  type: string
                  description: The payment intent to refund.
                amount:
                  type: integer
                  minimum: 1
                  description: Required amount to refund in cents.
              required:
                - paymentIntentId
                - amount
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  refund:
                    $ref: '#/components/schemas/Refund'
                    x-entrypoint:
                      virtualPath: schemas/Refund
                      sourcePath: schemas/Refund.yaml
                      title: Refund
                      origin: ./src/publicApi
                required:
                  - refund
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: TooManyRequests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - api_key: []
        - bearer: []
components:
  schemas:
    Refund:
      type: object
      description: A refund returns all or part of a succeeded payment to the buyer.
      properties:
        id:
          type: string
          description: Unique identifier for the refund.
        status:
          type: string
          description: Current refund processing status.
          enum:
            - pending
            - processing
            - succeeded
            - failed
        amount:
          type: integer
          description: Refund amount in cents.
        currency:
          type: string
          description: ISO currency code for the refund. Only `usd` is currently supported.
          enum:
            - usd
        paymentIntentId:
          type: string
          description: The payment intent being refunded.
        createdAt:
          type: string
          format: date-time
          description: ISO-8601 timestamp the refund was created at.
        updatedAt:
          type: string
          format: date-time
          description: ISO-8601 timestamp the refund last changed status.
      required:
        - id
        - status
        - amount
        - currency
        - paymentIntentId
        - createdAt
        - updatedAt
      x-entrypoint:
        virtualPath: schemas/Refund
        sourcePath: schemas/Refund.yaml
        title: Refund
        origin: ./src/publicApi
      title: Refund
    Error:
      type: object
      properties:
        message:
          type: string
        name:
          type: string
        identifier:
          type: string
        rawStatus:
          type: number
        meta:
          type: object
          additionalProperties: true
      required:
        - message
        - name
        - identifier
        - rawStatus
      x-entrypoint:
        origin: ./src/publicApi
        sourcePath: ./src/publicApi/main.yaml
        title: Error
        virtualPath: components/Error
      title: Error
  securitySchemes:
    api_key:
      type: apiKey
      description: |
        API key authentication for public API requests.

        Keys come in two flavors:

        - *Legal-entity-scoped keys* are pinned to a single legal entity.
          Minted via the dashboard under a specific entity; every request
          acts on that entity.
        - *User-scoped keys* are pinned to a user and span every legal
          entity that user has access to. Every request made with a
          user-scoped key (except `GET /legal-entity`, which lists the
          legal entities the user can access) must include an
          `x-legal-entity` header naming the legal entity the request is
          operating on. Requests without the header are rejected with
          `400`. The authenticated user must have an active permission
          role on the supplied legal entity, otherwise the request is
          rejected with `403`.
      name: X-API-Key
      in: header
    partner_api_key:
      type: apiKey
      description: |
        Partner-program API key authentication.

        Keys are minted in the partner dashboard (Developers → API Keys),
        are scoped to a single partner program, and are prefixed with
        `sk_partner_`. Partner keys are only accepted by routes that
        declare this scheme; they are rejected by `api_key` routes and
        vice versa.
      name: X-API-Key
      in: header
    bearer:
      type: http
      scheme: bearer
    developer_application:
      type: http
      scheme: basic

````