Abicart API

# PaymentMethod

An object representing a payment method.

# Properties

Property Type Description
uid integer The unique identifier of the payment method.
active boolean Whether the payment method is active.
name object The name of the payment method, by language.
description object The description of the payment method, by language.
position integer The position of the payment method, how it's sorted.
fee object The fee when using the payment method, by currency.
type string Which type of payment method this is.
disableDeliveryAddress boolean Whether a delivery address other than the billing address can be set with this payment method.
mailOnChange boolean Whether to send en email when a payment's status has been changed.
limitToCurrencies array Array of currencies that the payment method is available for.
orderCostRange OrderCostRange When the payment method is available based on the order cost.
orderStatus integer Which order status is set when the payment is confirmed.
params object Settings for the payment method.

# OrderCostRange

Property Type Description
mode string E.g. all, zero, nonzero, or interval.
intervals object The intervals of when the payment method is available, by currency.

# Methods

# get

Fetches information about a payment method.

# Parameters

Parameter Description
uid The unique identifier of the payment method.
query Which info to return. See Query language.

# Example

PaymentMethod.get(342615)

# getSchema

Fetches the JSON Schema which can be used for client-side validation.

# Parameters

The unique identifier of an existing payment method or null for a new instance.

# list

# Example

PaymentMethod.list([
  "uid",
  "type"
], true)