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

headerrequired

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

items

object[]

Show child attributes

items.id

string

Unique identifier for this Payout Target.

items.reference

string

Reference sent in by merchant to identify Payout Target.

items.description

string

An extra metadata field that can be included for visibility.

items.customerId

string

Reference to customer who owns this Payout Target.

items.customerDetails

object

Details about the customer who owns this Payout Target.

Show child attributes

items.customerDetails.reference

string

An optional reference provided by the merchant to identify the customer.

items.customerDetails.name

string

First and last name for a natural person, and company name for a juridical person.

items.customerDetails.documentType

enum<string>

Colombian ID type for customer.

Available options:

cc,

ce,

nit

items.customerDetails.documentNumber

string

Colombian ID number for customer.

items.customerDetails.email

string

Customer’s email.

items.customerDetails.phoneNumber

string

Customer’s phone number.

items.status

enum<string>

Status of the Payout Target.

Available options:

active,

cancelled

items.statusMessage

enum<string>

Additional detail on the status. Only present when status is "cancelled".

Available options:

AUTHENTICATION_FAILED,

CUSTOMER_CANCELLATION,

DECLINED_BY_BANK,

EXPIRED,

INVALID_ACCOUNT,

NOT_ENOUGH_FUNDS,

ERROR

items.authUrl

string

URL where the customer should be redirected to complete the Payout Target verification.

items.redirectUrl

string

URL where the customer will be redirected after completing the Payout Target verification.

items.type

enum<string>

Type of Payout Target created.

Available options:

bankAccount

items.createdAt

string

ISO string indicating when the Payout Target was created.

items.updatedAt

string

ISO string indicating when the Payout Target was last updated.

cursor

string | null

A cursor for use in pagination. Provide this value in the cursor parameter to retrieve the next set of results. When there are no more results, the cursor will be null.

count

integer

The total number of items returned.