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

# Solicitar devolução

> Solicita devolução parcial ou total de uma cobrança paga. Exige `refunds:write` e `Idempotency-Key`. Depende de suporte do provedor da cobrança. Sem suporte, responde 503 `refund_unavailable` antes de criar a devolução ou reservar saldo. A integração atual do provedor de pagamentos não oferece devolução Pix por esta API.



## OpenAPI

````yaml /openapi.json post /v1/payment-intents/{id}/refunds
openapi: 3.1.0
info:
  title: MingoPay API
  version: 1.0.0
  description: >-
    API pública para cobranças Pix, subcontas, devoluções e consulta de saldo.
    Valores monetários em centavos; ambientes e saldos são isolados.
servers:
  - url: https://api.mingopay.com.br
    description: API MingoPay
security:
  - bearerAuth: []
tags:
  - name: Cobranças
    description: Criação, consulta e reconciliação de cobranças Pix.
  - name: Devoluções
    description: Devoluções parciais ou totais de cobranças pagas.
  - name: Saldo
    description: Saldo disponível calculado pelo ledger da organização.
  - name: Sandbox
    description: Simulações disponíveis somente para chaves mp_test_.
  - name: Subcontas
    description: >-
      Subcontas administradas pela sua organização, com cobranças e saldos
      separados.
paths:
  /v1/payment-intents/{id}/refunds:
    post:
      tags:
        - Devoluções
      summary: Solicitar devolução
      description: >-
        Solicita devolução parcial ou total de uma cobrança paga. Exige
        `refunds:write` e `Idempotency-Key`. Depende de suporte do provedor da
        cobrança. Sem suporte, responde 503 `refund_unavailable` antes de criar
        a devolução ou reservar saldo. A integração atual do provedor de
        pagamentos não oferece devolução Pix por esta API.
      operationId: createRefund
      parameters:
        - $ref: '#/components/parameters/PaymentIntentId'
        - $ref: '#/components/parameters/RefundIdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateRefundRequest'
            example:
              amountCents: 14990
              reason: Cancelamento do pedido
      responses:
        '201':
          description: Devolução concluída.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Refund'
        '202':
          description: Devolução aceita e ainda em processamento.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Refund'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        '429':
          $ref: '#/components/responses/RateLimited'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
components:
  parameters:
    PaymentIntentId:
      name: id
      in: path
      required: true
      description: UUID da cobrança.
      schema:
        type: string
        format: uuid
    RefundIdempotencyKey:
      name: Idempotency-Key
      in: header
      required: true
      description: Chave única de 8 a 100 caracteres para a devolução.
      schema:
        type: string
        minLength: 8
        maxLength: 100
        example: pedido-1024-devolucao-001
  schemas:
    CreateRefundRequest:
      type: object
      additionalProperties: false
      required:
        - amountCents
      properties:
        amountCents:
          type: integer
          minimum: 1
          maximum: 100000000
        reason:
          type: string
          minLength: 3
          maxLength: 280
    Refund:
      type: object
      required:
        - id
        - status
      properties:
        id:
          type: string
          format: uuid
        status:
          type: string
          enum:
            - pending
            - processing
            - succeeded
            - failed
        providerReference:
          type:
            - string
            - 'null'
    ApiError:
      type: object
      required:
        - error
        - message
        - requestId
      properties:
        error:
          type: string
        message:
          type: string
        requestId:
          type: string
        details:
          type: array
          items:
            type: object
            required:
              - path
              - message
            properties:
              path:
                type: string
              message:
                type: string
  responses:
    BadRequest:
      description: Requisição inválida.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Unauthorized:
      description: Chave ausente ou inválida.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Forbidden:
      description: >-
        Ambiente, organização ou escopo não autorizado. Organizações suspensas
        (restricted) ou encerradas (closed) retornam organization_not_active em
        sandbox e produção.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    NotFound:
      description: Recurso não encontrado.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Conflict:
      description: Conflito de estado ou idempotência.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    UnprocessableEntity:
      description: Operação válida, mas incompatível com os valores ou o estado atual.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    RateLimited:
      description: Limite de requisições excedido.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    ServiceUnavailable:
      description: Provedor ou operação temporariamente indisponível.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Chave de API MingoPay com prefixo mp_test_ ou mp_live_.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.