Skip to main content
POST
/
v1
/
scheduled-transfers
Create a schedule
curl --request POST \
  --url https://api.getsly.ai/v1/v1/scheduled-transfers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fromAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amount": 123,
  "startDate": "2023-11-07T05:31:56Z",
  "toAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "toPaymentMethodId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "currency": "USDC",
  "intervalValue": 1,
  "dayOfMonth": 16,
  "dayOfWeek": 3,
  "cronExpression": "<string>",
  "timezone": "UTC",
  "endDate": "2023-11-07T05:31:56Z",
  "maxOccurrences": 123,
  "retryEnabled": true,
  "maxRetryAttempts": 3,
  "retryWindowDays": 14,
  "description": "<string>"
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "fromAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "amount": "<string>",
    "currency": "<string>",
    "startDate": "2023-11-07T05:31:56Z",
    "executions_completed": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "toAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "toPaymentMethodId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "intervalValue": 1,
    "dayOfMonth": 16,
    "dayOfWeek": 3,
    "cronExpression": "<string>",
    "timezone": "UTC",
    "endDate": "2023-11-07T05:31:56Z",
    "maxOccurrences": 123,
    "retryEnabled": true,
    "maxRetryAttempts": 3,
    "retryWindowDays": 14,
    "next_execution_at": "2023-11-07T05:31:56Z",
    "last_execution_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

API key (pk_test_* or pk_live_), JWT session, agent token (agent_), Ed25519 session (sess_), or portal token (portal_).

Body

application/json
​
fromAccountId
string<uuid>
required
​
amount
number
required
​
frequency
enum<string>
required
Available options:
daily,
weekly,
biweekly,
monthly,
custom
​
startDate
string<date-time>
required
​
toAccountId
string<uuid>
​
toPaymentMethodId
string<uuid>
​
currency
string
default:USDC
​
intervalValue
integer
default:1
​
dayOfMonth
integer
Required range: 1 <= x <= 31
​
dayOfWeek
integer
Required range: 0 <= x <= 6
​
cronExpression
string
​
timezone
string
default:UTC
​
endDate
string<date-time>
​
maxOccurrences
integer
​
retryEnabled
boolean
default:true
​
maxRetryAttempts
integer
default:3
Required range: 0 <= x <= 10
​
retryWindowDays
integer
default:14
Required range: 1 <= x <= 60
​
description
string
Maximum string length: 500

Response

Schedule created

​
data
object
required