Get All Payin Requests

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/payinRequests",
    {
      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.

payinSourceId

string

Filter by payinSourceId.

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

count

integer

The total number of items returned.

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.

items

object[]

items.amount

number

Amount to collect from the customer’s Payin Source. Must be an integer.

items.amountCollected

number

Amount collected by Payin Request. Starts at 0 and changes on status change to "approved" or "partial".

items.createdAt

string

ISO string indicating when the payin request was created.

items.customerDetails

object

Details about the customer who owns the Payin Source from which the Payin Request was created.

items.customerId

string

Reference to customer who owns the Payin Source from which the Payin Request was created.

items.fee

number

Fee charged for the transaction. This fee will be subtracted from amountCollected at settlement time.

items.id

string

Unique identifier for this Payin Request.

items.payinSourceDetails

object

Details about the Payin Source from which the Payin Request was created.

items.payinSourceId

string

Reference to Payin Source from which the Payin Request was created.

items.reference

string

Reference sent in by merchant to identify Payin Request.

items.status

enum<string>

Status of the Payin Request.

Available options:

processing,

approved,

partial,

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

string

Reference to Merchant Account. Safe to ignore if Merchant Accounts are not being used.

items.updatedAt

string

ISO string indicating when the payin request was last updated.

Introduction

API Documentation

Webhooks

Get All Payin Requests

Authorizations

Query Parameters

Response