# Class PaymentProcessor

- [TopLevel.Object](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md)
  - [dw.object.PersistentObject](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.object.PersistentObject.md)
    - [dw.object.ExtensibleObject](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.object.ExtensibleObject.md)
      - [dw.order.PaymentProcessor](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.PaymentProcessor.md)

A PaymentProcessor represents an entity that processes payments of one or more types. In the B2C Commerce system, a
payment processor is just a container for configuration values, which describe, for example, the parameters (URL,
merchant ID, password, etc) required for connecting to a payment gateway.

The system has several built in PaymentProcessors. These are:

- BASIC_CREDIT
- BASIC_GIFT_CERTIFICATE
- CYBERSOURCE_CREDIT
- CYBERSOURCE_BML
- PAYPAL_CREDIT
- PAYPAL_EXPRESS
- VERISIGN_CREDIT

The first two of these are merely placeholders with no associated preference values. The remaining system payment
processors define preference values which are maintained in the Business Manager and are used in conjunction with
built-in B2C Commerce payment integrations. Preferences of system PaymentProcessors are not intended to be read
programmatically.

Merchants may also define custom payment processors. This is done by defining a payment processor with an arbitrary
ID in the Business Manager, and then configuring an attribute group with the same ID on the
[SitePreferences](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.system.SitePreferences.md) system object. Attributes added to the group will be considered preferences of the
payment processor and will be readable through [getPreferenceValue(String)](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.PaymentProcessor.md#getpreferencevaluestring). Merchants can design their
checkout process to read these preferences at run time for connecting to their payment gateways.

Every [PaymentMethod](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.PaymentMethod.md) in the system is associated with at most one PaymentProcessor. This basically
represents the physical payment gateway which processes the (logical) payment method. Each payment processor may be
associated with an arbitrary number of payment methods. Also, each payment transaction has one PaymentProcessor which
is set by custom code during the checkout process.

## Property Summary

| Property                                                                                                    | Description                         |
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------- |
| [ID](#id): [String](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md) `(read-only)` | Returns the 'ID' of this processor. |

## Constructor Summary

This class does not have a constructor, so you cannot create it directly.

## Method Summary

| Method                                                                                                                                                                                                                | Description                                                               |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| [getID](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.PaymentProcessor.md#getid)()                                                                                                                   | Returns the 'ID' of this processor.                                       |
| [getPreferenceValue](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.order.PaymentProcessor.md#getpreferencevaluestring)([String](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md)) | Returns the value of the specified preference for this payment processor. |

### Methods inherited from class ExtensibleObject

[describe](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.object.ExtensibleObject.md#describe), [getCustom](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.object.ExtensibleObject.md#getcustom)

### Methods inherited from class PersistentObject

[getCreationDate](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.object.PersistentObject.md#getcreationdate), [getLastModified](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.object.PersistentObject.md#getlastmodified), [getUUID](/docs/commerce/b2c-commerce/references/b2c-script-api/dw.object.PersistentObject.md#getuuid)

### Methods inherited from class Object

[assign](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#assignobject-object), [create](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#createobject), [create](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#createobject-object), [defineProperties](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#definepropertiesobject-object), [defineProperty](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#definepropertyobject-object-object), [entries](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#entriesobject), [freeze](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#freezeobject), [fromEntries](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#hasownpropertystring), [is](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#isobject-object), [isExtensible](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#isextensibleobject), [isFrozen](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#isfrozenobject), [isPrototypeOf](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#isprototypeofobject), [isSealed](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#issealedobject), [keys](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#keysobject), [preventExtensions](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#propertyisenumerablestring), [seal](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#sealobject), [setPrototypeOf](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#tolocalestring), [toString](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#tostring), [valueOf](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#valueof), [values](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md#valuesobject)

## Property Details

### ID

- ID: [String](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md) `(read-only)`
  - : Returns the 'ID' of this processor.

***

## Method Details

### getID()

- getID(): [String](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md)
  - : Returns the 'ID' of this processor.

    **Returns:**

    - the 'ID' of this processor, e.g. "BASIC_CREDIT".

***

### getPreferenceValue(String)

- getPreferenceValue(name: [String](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.String.md)): [Object](/docs/commerce/b2c-commerce/references/b2c-script-api/TopLevel.Object.md)
  - : Returns the value of the specified preference for this payment processor.
    If the preference name is invalid (or null) or no preference value is
    defined for this payment processor, null is returned.

    **Parameters:**

    - name - preference name. Typically an attribute defined on             SitePreferences contained in an attribute group whose name is             the same as this.ID.

    **Returns:**

    - preference value, or null.

***