Corpo da requisição
Nome da programação, até 120 caracteres.
ONCE, RECURRING ou BALANCE_THRESHOLD.
Dados do envio: method (pix_padrao ou interna), amount e destino.
scheduledAtstringData e hora ISO futuras. Obrigatório em ONCE.
recurrenceRuleobjectRegra para RECURRING. Use o fuso America/Sao_Paulo.
balanceThresholdnumberSaldo disponível mínimo para BALANCE_THRESHOLD.
maxRunsintegerLimite opcional de execuções, entre 1 e 10.000.
Headers
Identificador único de até 128 caracteres. Preserve a chave e o corpo ao repetir a operação.
Autorização
Chave VibeCash com permissão para esta operação.
Resposta
Indica se a operação foi concluída pela API.
Mensagem da operação.
Dados retornados pela operação.
requestIdstringIdentificador da requisição.
Execução e estados
Programações dependem do serviço de execução ativo e de dois fatores habilitado na conta. Estados: active, paused, processing, completed, failed e canceled.
Recorrências aceitam daily, weekly, monthly e custom_days, no fuso America/Sao_Paulo. Em custom_days, informe customDays como lista dos dias da semana: 0 (domingo) a 6 (sábado).
Erros
As falhas retornam o envelope com success: false. Consulte erros e códigos HTTP para interpretar validação, permissão, conflito e saldo insuficiente.
curl --request POST \
--url 'https://seu-dominio/v1/transfer-scheduled/create' \
--header 'X-API-Key: tp_live_SUA_CHAVE' \
--header 'Idempotency-Key: operacao-unica-123' \
--header 'Content-Type: application/json' \
--data '{"label":"Pagamento programado","triggerType":"ONCE","scheduledAt":"2030-12-01T15:00:00.000Z","payload":{"method":"pix_padrao","amount":5,"coverFee":true,"pixKey":"[email protected]","pixKeyType":"EMAIL"}}'{
"success": true,
"message": "Operação concluída",
"data": {
"id": "schedule_exemplo",
"label": "Pagamento programado",
"amount": 5,
"method": "PIX",
"destination": "[email protected]",
"status": "active",
"triggerType": "once",
"nextRunAt": "2030-12-01T15:00:00.000Z",
"lastRunAt": null,
"runCount": 0,
"maxRuns": null,
"lastError": null
},
"requestId": "req_exemplo"
}