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"
}
{
"success": false,
"message": "Programação não encontrada",
"requestId": "req_err404"
}
Programadas
Consultar programação
Retorna uma programação de transferência por id.
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"
}
{
"success": false,
"message": "Programação não encontrada",
"requestId": "req_err404"
}
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"
}
{
"success": false,
"message": "Programação não encontrada",
"requestId": "req_err404"
}
Parâmetros de rota
string
required
ID da programação retornado em
POST /transfer-scheduled/create ou em GET /transfer-scheduled/list.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 |
Authorizations
Chave gp_live_... criada em Integrações → Chaves de API no dashboard.
Path Parameters
ID do recurso (transação, cobrança, webhook, etc.)