Get All Payout Targets

This endpoint is paginated to improve its performance. The example below shows how to fetch multiple pages.

import axios from "axios";

const getPage = async (input: { limit?: number; cursor?: string }) => {
  const response = await axios.get(
    "https://prod.api.palomma.com/v0/payoutTargets",
    {
      headers: {
        Authorization: "Bearer <token>",
      },
      params: {
        ...input,
      },
    }
  );
  if (!response.data) throw new Error();
  const { items, cursor, count } = response.data;
  return { items, cursor, count };
};

const getAll = async (input: { limit?: number }) => {
  let items: any[] = [];
  const firstPage = await getPage({ limit: input.limit });
  if (firstPage) {
    items = items.concat(firstPage.items);
    let currentCursor = firstPage.cursor;
    while (currentCursor !== null) {
      const nextPage = await getPage({
        limit: input.limit,
        cursor: currentCursor,
      });
      items = items.concat(nextPage.items);
      currentCursor = nextPage.cursor;
    }
  }
  return items;
};

Authorizations

Authorization · string · header · required

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

Query Parameters

reference · string

Filter by reference provided on creation.

customerId · string

Filter by customerId.

limit · integer

Number of records to return. Default is 20. Maximum is 100.

cursor · string

A cursor for use in pagination. The cursor indicates where to start fetching the results.

Response

200

application/json

List of payout targets successfully retrieved.

The response is of type object.