Skip to main content
GET
/
api
/
v1
/
schedules
/
{scheduleId}
Get Schedule
curl --request GET \
  --url https://www.{baseurl}.com/api/v1/schedules/{scheduleId} \
  --header 'x-client-id: <x-client-id>'
{
  "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
  "amount": 250,
  "startDate": "2026-04-15",
  "endDate": "2027-04-15",
  "transactionsCount": 12,
  "paymentFrequency": "Monthly",
  "paymentDirection": "DEBIT",
  "paymentType": "EFT",
  "status": "Active",
  "padId": "b2c3d4e5-6789-01bc-defg-2345678901bc",
  "crossReferenceNumber": "INV-1001",
  "createdAt": "2026-04-10T14:30:00Z",
  "lastModifiedAt": "2026-04-10T14:30:00Z"
}
Work in progressThis section is currently under active development as part of improvements planned for 2026. Content may change as we expand product capabilities.If you’re interested in early access or want to learn more about what’s coming, feel free to reach out to the team.
Retrieve the details of a payment schedule, including the associated PAD agreement identifier.

​
PAD Availability

The padId field is null immediately after creating a transaction. Once the system generates the PAD agreement, padId is populated and you can use it to retrieve the PAD link. For the full flow from contact to PAD link, see the EFT PAD Signing guide.

Headers

​
x-client-id
string
required

Your API key provided during onboarding.

Path Parameters

​
scheduleId
string<uuid>
required

The schedule identifier returned when creating a transaction.

Response

Schedule retrieved successfully

​
id
string<uuid>

Unique schedule identifier.

Example:

"a1b2c3d4-5678-90ab-cdef-1234567890ab"

​
amount
number<double>

Payment amount.

Example:

250

​
startDate
string<date>

Schedule start date.

Example:

"2026-04-15"

​
endDate
string<date>

Schedule end date.

Example:

"2027-04-15"

​
transactionsCount
integer

Total number of scheduled payments.

Example:

12

​
paymentFrequency
enum<string>

Payment frequency.

Available options:
OneTime,
Weekly,
Biweekly,
Monthly
Example:

"Monthly"

​
paymentDirection
enum<string>

Payment direction.

Available options:
DEBIT,
CREDIT
Example:

"DEBIT"

​
paymentType
string

Payment type.

Example:

"EFT"

​
status
string

Current schedule status.

Example:

"Active"

​
padId
string<uuid> | null

Associated PAD agreement identifier. null until the PAD has been generated.

Example:

"b2c3d4e5-6789-01bc-defg-2345678901bc"

​
crossReferenceNumber
string | null

Your reference identifier.

Example:

"INV-1001"

​
createdAt
string<date-time> | null

Creation timestamp.

​
lastModifiedAt
string<date-time>

Last update timestamp.