transfer-pix/create a cada execução. O painel e a API usam o mesmo modelo.
Permissões: transfer-scheduled/create, get, list, update, cancel, run-now.
Tipos de disparo (triggerType)
| Valor | Uso | Campos obrigatórios |
|---|---|---|
ONCE | Uma vez em data/hora | scheduledAt (ISO 8601, futuro) |
RECURRING | Repetição | recurrenceRule |
BALANCE_THRESHOLD | Ao atingir saldo | balanceThreshold (reais) |
Payload da transferência
O objetopayload descreve o que enviar (igual ao formulário Transferir do dashboard):
method | Destino |
|---|---|
pix_padrao / pix_livre | pixKey, pixKeyType, opcional subaccountId |
interna | recipientEmail (conta GoatPay) |
cripto | address, payCurrency, opcional extraId |
amount e, se quiser, description e coverFee.
Recorrência (recurrenceRule)
| Campo | Descrição |
|---|---|
interval | daily, weekly, monthly, custom_days |
time | Horário local, ex. 09:00 |
timezone | Padrão America/Sao_Paulo |
dayOfWeek | 0–6 (semanal) |
dayOfMonth | 1–31 (mensal) |
customDays | Intervalo em dias |
maxRuns limita quantas vezes a recorrência executa.
Fluxo recomendado
1. Criar programação
POST /transfer-scheduled/create com triggerType, payload e parâmetros de agenda.Criar programação3. Gerenciar
Campos na resposta (data)
Cada programação retorna:
| Campo | Descrição |
|---|---|
id | ID da programação |
label | Rótulo ou texto gerado |
amount | Valor do payload |
method | Tipo legível (PIX Padrão, Interna, Cripto…) |
destination | Destino mascarado |
triggerType | once, recurring ou balance_threshold |
scheduleLabel | Regra em linguagem natural |
nextRunAt | Próxima execução (ISO) ou — |
lastRunAt | Última execução, se houver |
runCount | Execuções já realizadas |
status | active, paused, completed, failed |
coverFee | Taxa absorvida pelo remetente |
GET /transfer-scheduled/list retorna { items: [...] } em data.
Endpoints
Criar
Agendar, repetir ou regra por saldo.
Listar
Todas as programações da conta.
Consultar
Por
id.Atualizar
Pausar, retomar ou alterar agenda.
Cancelar
Encerrar programação.
Executar agora
Disparo manual.
Limite de 20 programações ativas por conta. Transferências imediatas continuam em
POST /transfer-pix/create (ou interna/cripto).