Skip to main content
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"
}

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

​
Parâmetros de rota

​
id
string
required
ID da programação.

​
Campos em data

CampoDescrição
idID cancelado
cancelledtrue 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

​
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 cancelada.

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