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"
}
{
"success": false,
"message": "Saldo insuficiente para executar a programação",
"requestId": "req_err400"
}
Programadas
Executar agora
Dispara manualmente uma programação de transferência.
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"
}
{
"success": false,
"message": "Saldo insuficiente para executar a programação",
"requestId": "req_err400"
}
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"
}
{
"success": false,
"message": "Saldo insuficiente para executar a programação",
"requestId": "req_err400"
}
Parâmetros de rota
string
required
ID da programação.
Comportamento
- Dispara a transferência configurada no
payloadimediatamente. - Atualiza
lastRunAt,runCountenextRunAt(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
Chave gp_live_... criada em Integrações → Chaves de API no dashboard.
Path Parameters
ID do recurso (transação, cobrança, webhook, etc.)