Skip to main content
GET/transfer-scheduled/list

Autorização

X-API-Keystringrequired

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

Resposta

200 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
itemsarray

Itens da consulta.

totalinteger

Quantidade de itens, quando a rota oferece paginação.

pageinteger

Página atual.

pageSizeinteger

Itens por página.

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 GET \
  --url 'https://seu-dominio/v1/transfer-scheduled/list' \
  --header 'X-API-Key: tp_live_SUA_CHAVE'
{
  "success": true,
  "message": "Operação concluída",
  "data": {
    "items": [
      {
        "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

GET

Listar programações

Consulte as programações da sua carteira.

Authorization