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

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

​
Parâmetros de rota

​
id
string
required
ID da programação.

​
Corpo da requisição

Envie ao menos um campo. Não é possível alterar payload nem triggerType após a criação.
​
status
string
ACTIVE (retomar) ou PAUSED (pausar).
​
scheduledAt
string
Nova data/hora ISO 8601 (agendamento único ONCE).
​
recurrenceRule
object
Nova regra de recorrência (interval, time, timezone, dayOfWeek, dayOfMonth, customDays).
​
balanceThreshold
number
Novo saldo mínimo em reais (regra BALANCE_THRESHOLD).
​
maxRuns
integer
Novo limite de execuções (1–9999).
​
label
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

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

Body

application/json
​
label
string
Maximum string length: 120
​
status
enum<string>
Available options:
ACTIVE,
PAUSED
​
scheduledAt
string<date-time>
​
recurrenceRule
object
​
balanceThreshold
number
Required range: x >= 0
​
maxRuns
integer
Required range: 1 <= x <= 9999

Response

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

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