Skip to main content
POST
/
transfer-scheduled
/
run-now
/
{id}
curl -X POST 'https://api.goatpay.com.br/v1/transfer-scheduled/run-now/clx_sched_01' \
  -H 'X-API-Key: gp_live_SUA_CHAVE'

{
  "success": true,
  "message": "Execução manual solicitada",
  "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-08-05T12:00:00.000Z",
    "lastRunAt": "2026-06-06T14:30:00.000Z",
    "runCount": 3,
    "status": "active",
    "coverFee": true
  },
  "requestId": "req_abc123"
}

curl -X POST 'https://api.goatpay.com.br/v1/transfer-scheduled/run-now/clx_sched_01' \
  -H 'X-API-Key: gp_live_SUA_CHAVE'

{
  "success": true,
  "message": "Execução manual solicitada",
  "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-08-05T12:00:00.000Z",
    "lastRunAt": "2026-06-06T14:30:00.000Z",
    "runCount": 3,
    "status": "active",
    "coverFee": true
  },
  "requestId": "req_abc123"
}

​
Parâmetros de rota

​
id
string
required
ID da programação.

​
Comportamento

  • Dispara a transferência configurada no payload imediatamente.
  • Atualiza lastRunAt, runCount e nextRunAt (em recorrências).
  • A transferência em si segue o fluxo normal (PIX, interna ou cripto) e pode gerar webhooks (transfer.created, transfer.completed, etc.).

​
Campos principais em data

Mesma estrutura de Consultar programação, com runCount e lastRunAt atualizados após execução bem-sucedida.
Para regras BALANCE_THRESHOLD, a execução manual só ocorre se o saldo disponível atingir o balanceThreshold configurado.

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 de transferência criada, consultada ou atualizada.

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