0

ListPayoutEntries

by
Published Oct 17, 2025

Retrieves a list of all payout entries for a specific payout. To call this endpoint, set `PAYOUTS_READ` for the OAuth scope.

Script square Verified

The script

Submitted by hugo697 Bun
Verified 235 days ago
1
//native
2
type Square = {
3
  token: string;
4
};
5
/**
6
 * ListPayoutEntries
7
 * Retrieves a list of all payout entries for a specific payout.
8
To call this endpoint, set `PAYOUTS_READ` for the OAuth scope.
9
 */
10
export async function main(
11
  auth: Square,
12
  payout_id: string,
13
  sort_order: "DESC" | "ASC" | undefined,
14
  cursor: string | undefined,
15
  limit: string | undefined,
16
) {
17
  const url = new URL(
18
    `https://connect.squareup.com/v2/payouts/${payout_id}/payout-entries`,
19
  );
20
  for (const [k, v] of [
21
    ["sort_order", sort_order],
22
    ["cursor", cursor],
23
    ["limit", limit],
24
  ]) {
25
    if (v !== undefined && v !== "" && k !== undefined) {
26
      url.searchParams.append(k, v);
27
    }
28
  }
29
  const response = await fetch(url, {
30
    method: "GET",
31
    headers: {
32
      Authorization: "Bearer " + auth.token,
33
    },
34
    body: undefined,
35
  });
36
  if (!response.ok) {
37
    const text = await response.text();
38
    throw new Error(`${response.status} ${text}`);
39
  }
40
  return await response.json();
41
}
42