Get PaymentMethod entities.

GETRequest

import { RecranetApiClient } from "@recranet/sdk";

const client = new RecranetApiClient({ apiKey: process.env.RECRANET_API_KEY! });

const result = await client.paymentMethods.list({
  organization: 0,
});

Responses

200400

Response 200

Successful response

application/json

Example responseGenerated from schema

[
  {
    "id": 0,
    "created": "created",
    "paymentMethodSpecification": {},
    "displayName": "displayName",
    "name": "name",
    "description": "description",
    "reference": "reference",
    "paymentChargePercentage": "0",
    "paymentChargePrice": "0",
    "position": 0,
    "public": false,
    "dashboard": false,
    "modified": "modified",
    "archived": "archived"
  }
]

Response 400

Bad request

application/json

Example 1

{
  "statusCode": 400,
  "description": "Bad request",
  "errors": [
    "Bad request"
  ]
}

Query parameters

• countrystringoptional
• dashboardbooleanoptional
• manualbooleanoptional
• terminalbooleanoptional
• typestringoptional
• transactionProviderstringoptional
• dateFromstringoptional
• archivedbooleanoptional
• publicbooleanoptional
• settingsbooleanoptional
• organizationnumberrequired

Returns

Array of PaymentMethod

Schema shown for 200 · application/json

• idnumber
• namestringoptional
• descriptionstringoptional
• referencestringoptional
• paymentChargePercentagestringoptional
  Default: "0"
• paymentChargePricestringoptional
  Default: "0"
• positionnumberoptional
  Default: 0
• publicbooleanoptional
  Default: false
• dashboardbooleanoptional
  Default: false
• createdstring
• modifiedstringoptional
• archivedstringoptional
• paymentMethodSpecificationPaymentMethodSpecification
• displayNamestring