Get Payslip Links

curl --request GET \
  --url https://api.cadanapay.com/v1/payrolls/{payrollId}/payslip-links \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.cadanapay.com/v1/payrolls/{payrollId}/payslip-links"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.cadanapay.com/v1/payrolls/{payrollId}/payslip-links', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cadanapay.com/v1/payrolls/{payrollId}/payslip-links",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cadanapay.com/v1/payrolls/{payrollId}/payslip-links"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.cadanapay.com/v1/payrolls/{payrollId}/payslip-links")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "payrollId": "7c4f1d36-2b9a-4bca-91e7-2b1f1e6e7c11",
  "links": [
    {
      "personId": "04a8977d-5d99-4b28-8de4-8161401ca3fa",
      "personName": "Jane Doe",
      "paystubId": "1b2e3f4a-5c6d-7e8f-9012-345678901234",
      "url": "https://example-bucket.s3.amazonaws.com/payslips/04a8977d.pdf?X-Amz-Signature=...",
      "expiresAt": "2026-05-11T17:00:00Z"
    },
    {
      "personId": "11111111-2222-3333-4444-555555555555",
      "personName": "John Smith",
      "paystubId": "2c3d4e5f-6a7b-8c9d-0e1f-234567890123",
      "url": "https://example-bucket.s3.amazonaws.com/payslips/11111111.pdf?X-Amz-Signature=...",
      "expiresAt": "2026-05-11T17:00:00Z"
    }
  ],
  "notReady": [
    {
      "personId": "22222222-3333-4444-5555-666666666666",
      "status": "generating"
    }
  ]
}

Payrolls

Get Payslip Links

Retrieve presigned download links for a payroll’s payslips. Payslips exist only once the payroll is Completed; for payrolls that have not yet processed, entries appear under notReady with status not_found. Each link expires after a short window, so fetch and use them promptly.

Pass format=zip to receive a single presigned URL pointing to a bundled archive of all ready payslips instead of per-person links.

Payslips that are still being generated (or failed to generate) are returned under notReady with a status of generating or error. Retry the request after generation completes to receive their links.

In sandbox, a payroll saved with a past payrollDate completes immediately on approval — the fastest way to obtain payslips for testing.

GET

payrolls

{payrollId}

payslip-links

Get Payslip Links

curl --request GET \
  --url https://api.cadanapay.com/v1/payrolls/{payrollId}/payslip-links \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.cadanapay.com/v1/payrolls/{payrollId}/payslip-links"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.cadanapay.com/v1/payrolls/{payrollId}/payslip-links', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cadanapay.com/v1/payrolls/{payrollId}/payslip-links",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cadanapay.com/v1/payrolls/{payrollId}/payslip-links"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.cadanapay.com/v1/payrolls/{payrollId}/payslip-links")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "payrollId": "7c4f1d36-2b9a-4bca-91e7-2b1f1e6e7c11",
  "links": [
    {
      "personId": "04a8977d-5d99-4b28-8de4-8161401ca3fa",
      "personName": "Jane Doe",
      "paystubId": "1b2e3f4a-5c6d-7e8f-9012-345678901234",
      "url": "https://example-bucket.s3.amazonaws.com/payslips/04a8977d.pdf?X-Amz-Signature=...",
      "expiresAt": "2026-05-11T17:00:00Z"
    },
    {
      "personId": "11111111-2222-3333-4444-555555555555",
      "personName": "John Smith",
      "paystubId": "2c3d4e5f-6a7b-8c9d-0e1f-234567890123",
      "url": "https://example-bucket.s3.amazonaws.com/payslips/11111111.pdf?X-Amz-Signature=...",
      "expiresAt": "2026-05-11T17:00:00Z"
    }
  ],
  "notReady": [
    {
      "personId": "22222222-3333-4444-5555-666666666666",
      "status": "generating"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-MultiTenantKey

string

Required when using a Platform API token. The tenant key identifying which business to operate on.

Path Parameters

payrollId

string<uuid>

required

The unique identifier for the payroll

Query Parameters

format

enum<string>

When set to zip, ready payslips are bundled into a single archive and returned as one presigned URL via zipUrl. Omit for per-person links under links.

Available options:

zip

Response

Presigned download links for the payroll's payslips. Returns per-person links under links by default, or a single bundled archive under zipUrl when format=zip was requested. Payslips still generating (or failed) are listed under notReady.

payrollId

string<uuid>

Example:

"8ef9a712-cdae-4110-b1ea-9ba95abbee6e"

links

object[]

Per-person presigned download URLs. Returned when format is omitted. All links share the same expiresAt.

Show child attributes

zipUrl

string<uri>

Presigned URL pointing to a single archive containing all ready payslips. Returned only when format=zip was passed.

Example:

"https://example-bucket.s3.amazonaws.com/payslips/zips/7c4f1d36.zip?X-Amz-Signature=..."

expiresAt

string<date-time>

ISO-8601 expiry of zipUrl. Returned only when format=zip was passed.

Example:

"2026-05-11T17:00:00Z"

notReady

object[]

Payslips that could not be linked. not_found means the payslip does not exist yet (the payroll has not completed); generating means the PDF has not finished rendering yet; error means generation or link creation failed. Retry the request after the payroll completes and generation finishes.

Show child attributes

Approve

List

⌘I

Overview

Payments API

Wallets API

Workforce API

Tax API

Statutory Compliance API

Get Payslip Links

Authorizations

Headers

Path Parameters

Query Parameters

Response