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

# Buscar saque

> Permite que você recupere os detalhes de um payout específico usando o externalId.

Retorna os dados de um saque pelo seu `id`.

<Card horizontal>
  Requer a permissão `WITHDRAW:READ`.
</Card>

Use para verificar o `status` de um saque após criá-lo. Quando `status` for `COMPLETE`, o campo `receiptUrl` estará disponível com o comprovante.

**Valores de `status`:**

| Valor       | Significado                         |
| ----------- | ----------------------------------- |
| `PENDING`   | Aguardando processamento            |
| `COMPLETE`  | Concluído — `receiptUrl` disponível |
| `CANCELLED` | Cancelado                           |
| `REFUNDED`  | Reembolsado                         |


## OpenAPI

````yaml GET /payouts/get
openapi: 3.1.0
info:
  title: API AbacatePay
  description: API para gerenciamento de cobranças e pagamentos usando o AbacatePay.
  version: 1.0.0
servers:
  - url: https://api.abacatepay.com/v2
    description: Único servidor para os ambientes de produção e sandbox.
security: []
paths:
  /payouts/get:
    get:
      summary: Buscar payout
      description: >-
        Permite que você recupere os detalhes de um payout específico usando o
        externalId.
      parameters:
        - name: externalId
          in: query
          description: Identificador único do payout em seu sistema.
          required: true
          schema:
            type: string
            example: saque-123
      responses:
        '200':
          description: Detalhes do payout retornados com sucesso.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    description: Dados da transação de payout.
                    properties:
                      id:
                        type: string
                        description: Identificador único da transação.
                        example: txn_abc123xyz
                      status:
                        type: string
                        description: Status atual da transação.
                        enum:
                          - PENDING
                          - EXPIRED
                          - CANCELLED
                          - COMPLETE
                          - REFUNDED
                        example: COMPLETE
                      devMode:
                        type: boolean
                        description: >-
                          Indica se a transação foi criada em ambiente de
                          testes.
                        example: false
                      receiptUrl:
                        type: string
                        format: uri
                        nullable: true
                        description: URL do comprovante da transação.
                        example: https://app.abacatepay.com/receipt/txn_abc123xyz
                      amount:
                        type: number
                        description: Valor da transação em centavos.
                        example: 10000
                      platformFee:
                        type: number
                        description: Taxa da plataforma em centavos.
                        example: 100
                      externalId:
                        type: string
                        description: Identificador externo da transação.
                        example: saque-123
                      createdAt:
                        type: string
                        format: date-time
                        description: Data de criação da transação.
                        example: '2024-11-04T18:38:28.573Z'
                      updatedAt:
                        type: string
                        format: date-time
                        description: Data de atualização da transação.
                        example: '2024-11-04T19:15:42.123Z'
                  error:
                    type: string
                    nullable: true
                    example: null
                  success:
                    $ref: '#/components/schemas/Success'
        '401':
          description: Não autorizado. Falha na autenticação.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: >-
                      Mensagem de erro descrevendo o motivo da falha na
                      autenticação.
                    example: Token de autenticação inválido ou ausente.
        '404':
          description: Saque não encontrado.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: string
                    nullable: true
                    example: null
                  error:
                    type: string
                    description: Mensagem de erro indicando que o saque não foi encontrado.
                    example: Saque não encontrado com o externalId fornecido.
      security:
        - bearerAuth: []
components:
  schemas:
    Success:
      type: boolean
      description: Se a requisição obteve sucesso ou não.
      example: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Todas as requisições devem incluir sua chave de API no header
        Authorization usando o formato `Bearer <abacatepay-api-key>`. Sem esse
        header a requisição será rejeitada.


        Saiba mais sobre como criar e usar chaves de API na [documentação de
        autenticação](/pages/authentication).

````