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

# Consultar programação

> Retorna uma programação de transferência por id.

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET 'https://api.goatpay.com.br/v1/transfer-scheduled/get/clx_sched_01' \
    -H 'X-API-Key: gp_live_SUA_CHAVE'
  ```
</RequestExample>

<ResponseExample>
  ```json Success theme={null}
  {
    "success": true,
    "message": "Programação encontrada",
    "data": {
      "id": "clx_sched_01",
      "label": "Repasse mensal",
      "amount": 500,
      "method": "PIX Padrão",
      "destination": "123.456.789-09",
      "triggerType": "recurring",
      "scheduleLabel": "Todo dia 5 às 09:00",
      "nextRunAt": "2026-07-05T12:00:00.000Z",
      "lastRunAt": "2026-06-05T12:00:00.000Z",
      "runCount": 2,
      "status": "active",
      "coverFee": true
    },
    "requestId": "req_abc123"
  }
  ```

  ```json Error — não encontrada theme={null}
  {
    "success": false,
    "message": "Programação não encontrada",
    "requestId": "req_err404"
  }
  ```
</ResponseExample>

### Parâmetros de rota

<ParamField path="id" type="string" required>
  ID da programação retornado em `POST /transfer-scheduled/create` ou em `GET /transfer-scheduled/list`.
</ParamField>

### Campos principais em `data`

| Campo           | Descrição                                   |
| --------------- | ------------------------------------------- |
| `id`            | ID da programação                           |
| `label`         | Rótulo ou descrição gerada                  |
| `amount`        | Valor configurado                           |
| `method`        | Tipo legível (PIX Padrão, Interna, Cripto…) |
| `destination`   | Destino mascarado                           |
| `triggerType`   | `once`, `recurring` ou `balance_threshold`  |
| `scheduleLabel` | Regra em texto legível                      |
| `nextRunAt`     | Próxima execução (ISO) ou `—`               |
| `lastRunAt`     | Última execução, se houver                  |
| `runCount`      | Execuções concluídas                        |
| `status`        | `active`, `paused`, `completed` ou `failed` |
| `coverFee`      | Taxa absorvida pelo remetente               |


## OpenAPI

````yaml GET /transfer-scheduled/get/{id}
openapi: 3.1.0
info:
  title: GoatPay API
  description: >
    API pública merchant da GoatPay. Autenticação via header `X-API-Key:
    gp_live_...`.

    Respostas de sucesso usam o envelope `{ success, message, data, requestId
    }`.

    Campos internos (`accountId`, `metadata`, histórico de entregas de webhook,
    etc.) não são expostos.

    `providerTransactionId` aparece como `referenceId`; `providerInfractionId`
    como `infractionId`.

    Rate limit global: 100 requisições por minuto por API key (HTTP 429). Sem
    chave, limite por IP.
  version: 1.0.0
servers:
  - url: https://api.goatpay.com.br/v1
    description: Produção
security:
  - apiKeyAuth: []
tags:
  - name: pix
    description: >-
      Cobranças PIX (receber), reembolsos de depósito recebido e transferências
      PIX (enviar). Alias legado em payouts/* para envios.
  - name: transfer-internal
    description: Transferências entre contas GoatPay
  - name: transfer-scheduled
    description: Transferências programadas (agendar, repetir ou por saldo)
  - name: crypto
    description: Depósitos e transferências em criptomoeda
  - name: billings
    description: >-
      Cobranças avulsas (pagamento único) — boleto, cartão ou PIX na Conta
      Padrão (PF ou PJ)
  - name: subscriptions
    description: >-
      Assinaturas recorrentes com ciclo fixo — boleto, cartão ou PIX na Conta
      Padrão (PF ou PJ)
  - name: account
    description: Saldo e extrato
  - name: subaccount
    description: Subcontas merchant (carteiras lógicas sob a conta principal)
  - name: meds
    description: Disputas MED
  - name: webhooks
    description: Endpoints de webhook de saída
  - name: payouts
    description: Alias de transfer-pix para saques PIX
  - name: customers
    description: Clientes da loja (CRM)
  - name: products
    description: Produtos e entregas digitais
  - name: coupons
    description: Cupons de desconto para links
  - name: payment-links
    description: Links de pagamento e checkout hospedado
paths:
  /transfer-scheduled/get/{id}:
    get:
      tags:
        - transfer-scheduled
      summary: Consultar programação
      operationId: getTransferScheduled
      parameters:
        - $ref: '#/components/parameters/ResourceId'
      responses:
        '200':
          $ref: '#/components/responses/ScheduledTransferSuccess'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    ResourceId:
      name: id
      in: path
      required: true
      schema:
        type: string
      description: ID do recurso (transação, cobrança, webhook, etc.)
  responses:
    ScheduledTransferSuccess:
      description: Programação de transferência criada, consultada ou atualizada.
      content:
        application/json:
          schema:
            type: object
            required:
              - success
              - message
              - data
            properties:
              success:
                type: boolean
              message:
                type: string
              data:
                $ref: '#/components/schemas/PublicScheduledTransfer'
              requestId:
                type: string
    NotFound:
      description: Recurso não encontrado.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  schemas:
    PublicScheduledTransfer:
      type: object
      properties:
        id:
          type: string
        label:
          type: string
        amount:
          type: number
        method:
          type: string
        destination:
          type: string
        triggerType:
          type: string
          enum:
            - once
            - recurring
            - balance_threshold
        scheduleLabel:
          type: string
        nextRunAt:
          type: string
        lastRunAt:
          type: string
        runCount:
          type: integer
        status:
          type: string
          enum:
            - active
            - paused
            - completed
            - failed
        coverFee:
          type: boolean
    ErrorEnvelope:
      type: object
      required:
        - success
        - message
        - error
      properties:
        success:
          type: boolean
          example: false
        message:
          type: string
          example: Subconta inativa
        error:
          type: object
          properties:
            code:
              type: string
              example: Bad Request
            statusCode:
              type: integer
              example: 400
        requestId:
          type: string
          example: req_abc123
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Chave `gp_live_...` criada em Integrações → Chaves de API no dashboard.

````