ListPayouts

//native

type Square = {

  token: string;

};

/**

 * ListPayouts

 * Retrieves a list of all payouts for the default location.

You can filter payouts by location ID, status, time range, and order them in ascending or descending order.

To call this endpoint, set `PAYOUTS_READ` for the OAuth scope.

 */

export async function main(

  auth: Square,

  location_id: string | undefined,

  status: "SENT" | "FAILED" | "PAID" | undefined,

  begin_time: string | undefined,

  end_time: string | undefined,

  sort_order: "DESC" | "ASC" | undefined,

  cursor: string | undefined,

  limit: string | undefined,

) {

  const url = new URL(`https://connect.squareup.com/v2/payouts`);

  for (const [k, v] of [

    ["location_id", location_id],

    ["status", status],

    ["begin_time", begin_time],

    ["end_time", end_time],

    ["sort_order", sort_order],

    ["cursor", cursor],

    ["limit", limit],

  ]) {

    if (v !== undefined && v !== "" && k !== undefined) {

      url.searchParams.append(k, v);

    }

  }

  const response = await fetch(url, {

    method: "GET",

    headers: {

      Authorization: "Bearer " + auth.token,

    },

    body: undefined,

  });

  if (!response.ok) {

    const text = await response.text();

    throw new Error(`${response.status} ${text}`);

  }

  return await response.json();

}