curl -X PATCH 'https://api.goatpay.com.br/v1/transfer-scheduled/update/clx_sched_01' \
-H 'X-API-Key: gp_live_SUA_CHAVE' \
-H 'Content-Type: application/json' \
-d '{ "status": "PAUSED" }'
{
"success": true,
"message": "Programação atualizada",
"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": "paused",
"coverFee": true
},
"requestId": "req_abc123"
}
{
"success": false,
"message": "Programação encerrada não pode ser editada",
"requestId": "req_err400"
}
Programadas
Atualizar programação
Pausar, retomar ou alterar data, recorrência e limiares.
PATCH
/
transfer-scheduled
/
update
/
{id}
curl -X PATCH 'https://api.goatpay.com.br/v1/transfer-scheduled/update/clx_sched_01' \
-H 'X-API-Key: gp_live_SUA_CHAVE' \
-H 'Content-Type: application/json' \
-d '{ "status": "PAUSED" }'
{
"success": true,
"message": "Programação atualizada",
"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": "paused",
"coverFee": true
},
"requestId": "req_abc123"
}
{
"success": false,
"message": "Programação encerrada não pode ser editada",
"requestId": "req_err400"
}
curl -X PATCH 'https://api.goatpay.com.br/v1/transfer-scheduled/update/clx_sched_01' \
-H 'X-API-Key: gp_live_SUA_CHAVE' \
-H 'Content-Type: application/json' \
-d '{ "status": "PAUSED" }'
{
"success": true,
"message": "Programação atualizada",
"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": "paused",
"coverFee": true
},
"requestId": "req_abc123"
}
{
"success": false,
"message": "Programação encerrada não pode ser editada",
"requestId": "req_err400"
}
Parâmetros de rota
string
required
ID da programação.
Corpo da requisição
Envie ao menos um campo. Não é possível alterarpayload nem triggerType após a criação.
string
ACTIVE (retomar) ou PAUSED (pausar).string
Nova data/hora ISO 8601 (agendamento único
ONCE).object
Nova regra de recorrência (
interval, time, timezone, dayOfWeek, dayOfMonth, customDays).number
Novo saldo mínimo em reais (regra
BALANCE_THRESHOLD).integer
Novo limite de execuções (1–9999).
string
Novo rótulo (máx. 120 caracteres).
Campos principais em data
Mesma estrutura de Consultar programação. O status na resposta reflete active ou paused conforme ACTIVE/PAUSED enviado.Authorizations
Chave gp_live_... criada em Integrações → Chaves de API no dashboard.
Path Parameters
ID do recurso (transação, cobrança, webhook, etc.)
Body
application/json