List all payin links

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/payinLinks",
    {
      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 the Payin Link.

items.reference

string

An optional reference provided by the merchant to identify the Payin Link.

items.description

string

Description of the Payin Link.

items.customerId

string

The ID of the customer for whom the Payin Link is created.

items.customerDetails

object

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>

The current status of the Payin Link.

Available options:

pending,

processing,

approved,

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.paymentUrl

string

URL to which the customer can go to complete the payment.

items.redirectUrl

string

URL to which the customer will be redirected after the payment process.

items.amount

number

The total amount to be paid in COP.

items.amountCollected

number

The amount that has been collected in COP.

items.fee

number

Any fee associated with the Payin Link.

items.type

enum<string>

The type of Payin Link

Available options:

general,

pse,

bancolombiaButton,

nequiButton,

card,

bancolombiaCollect

items.expiration

string

Datetime when link will expire in YYYY-MM-DDTHH:mm:ss format. By default, expiration is at the end of the day after the link creation. Minimum expiration is the current date and maximum expiration is at the end of the 7th day from creation. Links expire shortly after the specified datetime has passed.

items.targetMerchantAccountId

string

Account ID of the target merchant account for this Payin Link.

items.createdAt

string

ISO string representing when the Payin Link was created.

items.updatedAt

string

ISO string representing when the Payin Link 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.