Skip to main content
GET
/
transfer-scheduled
/
list
curl -X GET 'https://api.goatpay.com.br/v1/transfer-scheduled/list' \
  -H 'X-API-Key: gp_live_SUA_CHAVE'

{
  "success": true,
  "message": "Programações listadas",
  "data": {
    "items": [
      {
        "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
      },
      {
        "id": "clx_sched_02",
        "label": "Uma vez em 15/06/2026 às 14:00",
        "amount": 250,
        "method": "Interna",
        "destination": "parceiro@empresa.com",
        "triggerType": "once",
        "scheduleLabel": "Uma vez em 15/06/2026 às 14:00",
        "nextRunAt": "2026-06-15T17:00:00.000Z",
        "runCount": 0,
        "status": "active",
        "coverFee": true
      }
    ]
  },
  "requestId": "req_abc123"
}

curl -X GET 'https://api.goatpay.com.br/v1/transfer-scheduled/list' \
  -H 'X-API-Key: gp_live_SUA_CHAVE'

{
  "success": true,
  "message": "Programações listadas",
  "data": {
    "items": [
      {
        "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
      },
      {
        "id": "clx_sched_02",
        "label": "Uma vez em 15/06/2026 às 14:00",
        "amount": 250,
        "method": "Interna",
        "destination": "parceiro@empresa.com",
        "triggerType": "once",
        "scheduleLabel": "Uma vez em 15/06/2026 às 14:00",
        "nextRunAt": "2026-06-15T17:00:00.000Z",
        "runCount": 0,
        "status": "active",
        "coverFee": true
      }
    ]
  },
  "requestId": "req_abc123"
}

​
Resposta

Retorna data.items — array de programações da conta (exceto canceladas). Ordenação: status, próxima execução, data de criação.

​
Campos de cada item em items

CampoDescrição
idID da programação
labelRótulo ou descrição gerada
amountValor configurado
methodTipo legível
destinationDestino mascarado
triggerTypeonce, recurring ou balance_threshold
scheduleLabelRegra em texto legível
nextRunAtPróxima execução (ISO) ou — em regra por saldo
lastRunAtÚltima execução, se houver
runCountExecuções concluídas
statusactive, paused, completed ou failed
coverFeeTaxa absorvida pelo remetente
Não há paginação nesta rota. Use GET /transfer-scheduled/get/{id} para detalhe de um item específico.

Authorizations

​
X-API-Key
string
header
required

Chave gp_live_... criada em Integrações → Chaves de API no dashboard.

Response

Lista de programações de transferência.

​
success
boolean
required
​
message
string
required
​
data
object
required
​
requestId
string