Skip to main content
POST/transfer-scheduled/create

Corpo da requisição

labelstringrequired

Nome da programação, até 120 caracteres.

triggerTypestringrequired

ONCE, RECURRING ou BALANCE_THRESHOLD.

payloadobjectrequired

Dados do envio: method (pix_padrao ou interna), amount e destino.

Data e hora ISO futuras. Obrigatório em ONCE.

Regra para RECURRING. Use o fuso America/Sao_Paulo.

Saldo disponível mínimo para BALANCE_THRESHOLD.

maxRunsinteger

Limite opcional de execuções, entre 1 e 10.000.

Headers

Idempotency-Keystringrequired

Identificador único de até 128 caracteres. Preserve a chave e o corpo ao repetir a operação.

Autorização

X-API-Keystringrequired

Chave VibeCash com permissão para esta operação.

Resposta

201 application/json
successbooleanrequired

Indica se a operação foi concluída pela API.

messagestringrequired

Mensagem da operação.

dataobjectrequired

Dados retornados pela operação.

Show child attributes
idstring

Identificador da programação.

statusstring

Situação atual da programação.

runCountinteger

Quantidade de execuções registradas.

nextRunAtstring | null

Data da próxima execução.

requestIdstring

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

Pesquisar documentação

POST

Criar programação

Programe uma transferência única, recorrente ou condicionada ao saldo.

Authorization
Body
Expand 4 optional fields