APICenter
DocsBuildLearn
APIs & SDKs/APICenter REST API/List Payment Records

List Payment Records

GEThttps://api.apicenter.itsandbox.site/api/v1/payments/records

Perform List Payment Records operation on APICenter platform.

TShttps://api.apicenter.itsandbox.site/api/v1/payments/records
const paymentApiKey = process.env.APICENTER_PAYMENT_API_KEY;
if (!paymentApiKey) throw new Error("APICENTER_PAYMENT_API_KEY is required");

const response = await fetch("https://api.apicenter.itsandbox.site/api/v1/payments/records", {
  method: "GET",
  headers: {
    Authorization: "Bearer " + paymentApiKey
  }
});
if (!response.ok) throw new Error("APICenter request failed: " + response.status);
const data = await response.json();
console.log(data);
Response
No response example is supplied by this contract. See the documented response schema.

Authentication

AuthorizationAPICenterApiKey

Authorization: Bearer <PAYMENT_API_KEY>. Use the consumer's payment API key. or Registered APICenter service JWT with gateway-enforced scopes.

Query parameters

typestringOptional

Filter by type.

statusstringOptional

Filter by status.

createdAfterstringOptional

Inclusive ISO 8601 lower bound.

createdBeforestringOptional

Exclusive ISO 8601 upper bound.

limitintegerOptional

Filter by limit.

cursorstringOptional

Filter by cursor.

Response

200Project-scoped payment record page.
successbooleanRequired
dataobjectRequired

Errors

TShttps://api.apicenter.itsandbox.site/api/v1/payments/records
const paymentApiKey = process.env.APICENTER_PAYMENT_API_KEY;
if (!paymentApiKey) throw new Error("APICENTER_PAYMENT_API_KEY is required");

const response = await fetch("https://api.apicenter.itsandbox.site/api/v1/payments/records", {
  method: "GET",
  headers: {
    Authorization: "Bearer " + paymentApiKey
  }
});
if (!response.ok) throw new Error("APICenter request failed: " + response.status);
const data = await response.json();
console.log(data);
Response
No response example is supplied by this contract. See the documented response schema.