curl -X DELETE 'https://api.goatpay.com.br/v1/transfer-scheduled/cancel/clx_sched_01' \
-H 'X-API-Key: gp_live_SUA_CHAVE'
{
"success": true,
"message": "Programação cancelada",
"data": {
"id": "clx_sched_01",
"cancelled": true
},
"requestId": "req_abc123"
}
{
"success": false,
"message": "Programação não encontrada",
"requestId": "req_err404"
}
Programadas
Cancelar programação
Encerra uma programação de transferência.
DELETE
/
transfer-scheduled
/
cancel
/
{id}
curl -X DELETE 'https://api.goatpay.com.br/v1/transfer-scheduled/cancel/clx_sched_01' \
-H 'X-API-Key: gp_live_SUA_CHAVE'
{
"success": true,
"message": "Programação cancelada",
"data": {
"id": "clx_sched_01",
"cancelled": true
},
"requestId": "req_abc123"
}
{
"success": false,
"message": "Programação não encontrada",
"requestId": "req_err404"
}
curl -X DELETE 'https://api.goatpay.com.br/v1/transfer-scheduled/cancel/clx_sched_01' \
-H 'X-API-Key: gp_live_SUA_CHAVE'
{
"success": true,
"message": "Programação cancelada",
"data": {
"id": "clx_sched_01",
"cancelled": 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.
Campos em data
| Campo | Descrição |
|---|---|
id | ID cancelado |
cancelled | true quando o cancelamento foi aceito |
Após cancelar, a programação deixa de aparecer em
GET /transfer-scheduled/list e não executa novamente.Authorizations
Chave gp_live_... criada em Integrações → Chaves de API no dashboard.
Path Parameters
ID do recurso (transação, cobrança, webhook, etc.)