Skip to main content
GET
/
api
/
v1
/
pads
/
{padId}
Get PAD Agreement
curl --request GET \
  --url https://www.{baseurl}.com/api/v1/pads/{padId} \
  --header 'x-client-id: <x-client-id>'
{
  "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
  "padLink": "/pad/a1b2c3d4-5678-90ab-cdef-1234567890ab",
  "amount": 250,
  "frequency": "Monthly",
  "status": "Active",
  "startDate": "2026-04-15",
  "endDate": "2027-04-15",
  "transactionsCount": 12,
  "createdAt": "2026-04-10T14:30:00Z",
  "lastModifiedAt": "2026-04-10T14:30:00Z",
  "payor": {
    "name": "Jane Doe",
    "email": "jane@example.com",
    "type": "Individual",
    "institutionCode": "001",
    "transitNumber": "12345",
    "accountNumber": "1234567"
  },
  "payee": {
    "name": "Acme Corp",
    "email": "billing@acme.com",
    "address": {
      "addressLine1": "123 Main St",
      "addressLine2": "Suite 100",
      "addressLine3": "H2E 2E2"
    }
  }
}
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 a Pre-Authorized Debit (PAD) agreement by its ID. Use this endpoint to obtain the padLink URL after creating a DEBIT transaction. When you create a DEBIT transaction via POST /api/v1/transactions, the response includes a padId in each schedule object. Use that padId with this endpoint to retrieve the full PAD details, including the padLink. The padLink is a URL you present to your end user so they can review and sign the PAD agreement before the payment is processed.

​
Typical Flow

  1. Create a DEBIT transaction — returns padId in the schedule response
  2. Get PAD agreement (this endpoint) — returns padLink
  3. Present padLink to the end user for PAD signing

Headers

​
x-client-id
string
required

Your API key provided during onboarding.

Path Parameters

​
padId
string<uuid>
required

The unique identifier of the PAD agreement.

Response

PAD agreement retrieved successfully

​
id
string<uuid>

Unique PAD agreement identifier.

Example:

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

​
padLink
string<uri>

URL for the end user to review and sign the PAD agreement.

Example:

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

​
amount
number<double>

Payment amount.

Example:

250

​
frequency
enum<string>

Payment frequency.

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

"Monthly"

​
status
string

Current PAD status.

Example:

"Active"

​
startDate
string<date>

When the PAD becomes effective.

Example:

"2026-04-15"

​
endDate
string<date>

When the PAD expires.

Example:

"2027-04-15"

​
transactionsCount
integer

Total number of scheduled payments.

Example:

12

​
createdAt
string<date-time> | null

Creation timestamp.

​
lastModifiedAt
string<date-time>

Last update timestamp.

​
payor
object
​
payee
object