0

Show payout batch details

by
Published Apr 8, 2025

Shows the latest status of a batch payout. Includes the transaction status and other data for individual payout items.

Script paypal Verified

The script

Submitted by hugo697 Bun
Verified 428 days ago
1
//native
2
type Paypal = {
3
  clientId: string;
4
  clientSecret: string;
5
};
6

7
async function getToken(auth: Paypal): Promise<string> {
8
  const url = new URL(`https://api-m.paypal.com/v1/oauth2/token`);
9
  const response = await fetch(url, {
10
    method: "POST",
11
    headers: {
12
      Authorization: `Basic ${btoa(`${auth.clientId}:${auth.clientSecret}`)}`,
13
    },
14
    body: new URLSearchParams({
15
      grant_type: "client_credentials",
16
    }),
17
  });
18
  if (!response.ok) {
19
    const text = await response.text();
20
    throw new Error(`Could not get token: ${response.status} ${text}`);
21
  }
22
  const json = await response.json();
23
  return json.access_token;
24
}
25
/**
26
 * Show payout batch details
27
 * Shows the latest status of a batch payout. Includes the transaction status and other data for individual payout items.
28
 */
29
export async function main(
30
  auth: Paypal,
31
  id: string,
32
  fields: string | undefined,
33
  page: string | undefined,
34
  page_size: string | undefined,
35
  total_required: string | undefined,
36
) {
37
  const token = await getToken(auth);
38
  const url = new URL(`https://api-m.paypal.com/v1/payments/payouts/${id}`);
39
  for (const [k, v] of [
40
    ["fields", fields],
41
    ["page", page],
42
    ["page_size", page_size],
43
    ["total_required", total_required],
44
  ]) {
45
    if (v !== undefined && v !== "" && k !== undefined) {
46
      url.searchParams.append(k, v);
47
    }
48
  }
49
  const response = await fetch(url, {
50
    method: "GET",
51
    headers: {
52
      Authorization: "Bearer " + token,
53
    },
54
    body: undefined,
55
  });
56
  if (!response.ok) {
57
    const text = await response.text();
58
    throw new Error(`${response.status} ${text}`);
59
  }
60
  return await response.json();
61
}
62