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

{
  "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"
}

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

{
  "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"
}

​
Parâmetros de rota

​
id
string
required
ID da programação retornado em POST /transfer-scheduled/create ou em GET /transfer-scheduled/list.

​
Campos principais em data

CampoDescrição
idID da programação
labelRótulo ou descrição gerada
amountValor configurado
methodTipo legível (PIX Padrão, Interna, Cripto…)
destinationDestino mascarado
triggerTypeonce, recurring ou balance_threshold
scheduleLabelRegra em texto legível
nextRunAtPróxima execução (ISO) ou —
lastRunAtÚltima execução, se houver
runCountExecuções concluídas
statusactive, paused, completed ou failed
coverFeeTaxa absorvida pelo remetente

Authorizations

​
X-API-Key
string
header
required

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

Path Parameters

​
id
string
required

ID do recurso (transação, cobrança, webhook, etc.)

Response

Programação de transferência criada, consultada ou atualizada.

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