@salesforce/b2c-tooling-sdk 0.0.1 → 0.0.3

package/data/script-api/dw.order.OrderPaymentInstrument.md

@@ -0,0 +1,231 @@
+<!-- prettier-ignore-start -->
+# Class OrderPaymentInstrument
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.object.PersistentObject](dw.object.PersistentObject.md)
+    - [dw.object.ExtensibleObject](dw.object.ExtensibleObject.md)
+      - [dw.customer.EncryptedObject](dw.customer.EncryptedObject.md)
+        - [dw.order.PaymentInstrument](dw.order.PaymentInstrument.md)
+          - [dw.order.OrderPaymentInstrument](dw.order.OrderPaymentInstrument.md)
+
+Represents any payment instrument used to pay orders, such as credit card
+or bank transfer. The object defines standard methods for credit card
+payment, and can be extended by attributes appropriate for other
+payment methods.
+
+
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [bankAccountDriversLicense](#bankaccountdriverslicense): [String](TopLevel.String.md) `(read-only)` | Returns the driver's license associated with a bank account if the calling  context meets the following criteria: <br/>  <ul>  <li>  If the method call happens in the context of a storefront request and  the current customer is identical to the customer related to the basket  or order, and the current protocol is HTTPS. |
+| [bankAccountNumber](#bankaccountnumber): [String](TopLevel.String.md) `(read-only)` | Returns the account number if the calling context meets  the following criteria: <br/>  <ul>  <li>  If the method call happens in the context of a storefront request and  the current customer is identical to the customer related to the basket  or order, and the current protocol is HTTPS. |
+| [capturedAmount](#capturedamount): [Money](dw.value.Money.md) `(read-only)` | Returns the sum of the captured amounts. |
+| [creditCardNumber](#creditcardnumber): [String](TopLevel.String.md) `(read-only)` | Returns the de-crypted creditcard number if the calling context meets  the following criteria: <br/>  <ul>  <li>  If the method call happens in the context of a storefront request and  the current authenticated customer is referenced by the basket or order, and the current protocol is HTTPS. |
+| [paymentTransaction](#paymenttransaction): [PaymentTransaction](dw.order.PaymentTransaction.md) `(read-only)` | Returns the Payment Transaction for this Payment Instrument or null. |
+| [refundedAmount](#refundedamount): [Money](dw.value.Money.md) `(read-only)` | Returns the sum of the refunded amounts. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [getBankAccountDriversLicense](dw.order.OrderPaymentInstrument.md#getbankaccountdriverslicense)() | Returns the driver's license associated with a bank account if the calling  context meets the following criteria: <br/>  <ul>  <li>  If the method call happens in the context of a storefront request and  the current customer is identical to the customer related to the basket  or order, and the current protocol is HTTPS. |
+| [getBankAccountNumber](dw.order.OrderPaymentInstrument.md#getbankaccountnumber)() | Returns the account number if the calling context meets  the following criteria: <br/>  <ul>  <li>  If the method call happens in the context of a storefront request and  the current customer is identical to the customer related to the basket  or order, and the current protocol is HTTPS. |
+| [getCapturedAmount](dw.order.OrderPaymentInstrument.md#getcapturedamount)() | Returns the sum of the captured amounts. |
+| [getCreditCardNumber](dw.order.OrderPaymentInstrument.md#getcreditcardnumber)() | Returns the de-crypted creditcard number if the calling context meets  the following criteria: <br/>  <ul>  <li>  If the method call happens in the context of a storefront request and  the current authenticated customer is referenced by the basket or order, and the current protocol is HTTPS. |
+| [getPaymentTransaction](dw.order.OrderPaymentInstrument.md#getpaymenttransaction)() | Returns the Payment Transaction for this Payment Instrument or null. |
+| [getRefundedAmount](dw.order.OrderPaymentInstrument.md#getrefundedamount)() | Returns the sum of the refunded amounts. |
+
+### Methods inherited from class PaymentInstrument
+
+[getBankAccountDriversLicense](dw.order.PaymentInstrument.md#getbankaccountdriverslicense), [getBankAccountDriversLicenseLastDigits](dw.order.PaymentInstrument.md#getbankaccountdriverslicenselastdigits), [getBankAccountDriversLicenseLastDigits](dw.order.PaymentInstrument.md#getbankaccountdriverslicenselastdigitsnumber), [getBankAccountDriversLicenseStateCode](dw.order.PaymentInstrument.md#getbankaccountdriverslicensestatecode), [getBankAccountHolder](dw.order.PaymentInstrument.md#getbankaccountholder), [getBankAccountNumber](dw.order.PaymentInstrument.md#getbankaccountnumber), [getBankAccountNumberLastDigits](dw.order.PaymentInstrument.md#getbankaccountnumberlastdigits), [getBankAccountNumberLastDigits](dw.order.PaymentInstrument.md#getbankaccountnumberlastdigitsnumber), [getBankRoutingNumber](dw.order.PaymentInstrument.md#getbankroutingnumber), [getCreditCardExpirationMonth](dw.order.PaymentInstrument.md#getcreditcardexpirationmonth), [getCreditCardExpirationYear](dw.order.PaymentInstrument.md#getcreditcardexpirationyear), [getCreditCardHolder](dw.order.PaymentInstrument.md#getcreditcardholder), [getCreditCardIssueNumber](dw.order.PaymentInstrument.md#getcreditcardissuenumber), [getCreditCardNumber](dw.order.PaymentInstrument.md#getcreditcardnumber), [getCreditCardNumberLastDigits](dw.order.PaymentInstrument.md#getcreditcardnumberlastdigits), [getCreditCardNumberLastDigits](dw.order.PaymentInstrument.md#getcreditcardnumberlastdigitsnumber), [getCreditCardToken](dw.order.PaymentInstrument.md#getcreditcardtoken), [getCreditCardType](dw.order.PaymentInstrument.md#getcreditcardtype), [getCreditCardValidFromMonth](dw.order.PaymentInstrument.md#getcreditcardvalidfrommonth), [getCreditCardValidFromYear](dw.order.PaymentInstrument.md#getcreditcardvalidfromyear), [getEncryptedBankAccountDriversLicense](dw.order.PaymentInstrument.md#getencryptedbankaccountdriverslicensestring-string), [getEncryptedBankAccountNumber](dw.order.PaymentInstrument.md#getencryptedbankaccountnumberstring-string), [getEncryptedCreditCardNumber](dw.order.PaymentInstrument.md#getencryptedcreditcardnumberstring-certificateref), [getEncryptedCreditCardNumber](dw.order.PaymentInstrument.md#getencryptedcreditcardnumberstring-string), [getGiftCertificateCode](dw.order.PaymentInstrument.md#getgiftcertificatecode), [getGiftCertificateID](dw.order.PaymentInstrument.md#getgiftcertificateid), [getMaskedBankAccountDriversLicense](dw.order.PaymentInstrument.md#getmaskedbankaccountdriverslicense), [getMaskedBankAccountDriversLicense](dw.order.PaymentInstrument.md#getmaskedbankaccountdriverslicensenumber), [getMaskedBankAccountNumber](dw.order.PaymentInstrument.md#getmaskedbankaccountnumber), [getMaskedBankAccountNumber](dw.order.PaymentInstrument.md#getmaskedbankaccountnumbernumber), [getMaskedCreditCardNumber](dw.order.PaymentInstrument.md#getmaskedcreditcardnumber), [getMaskedCreditCardNumber](dw.order.PaymentInstrument.md#getmaskedcreditcardnumbernumber), [getMaskedGiftCertificateCode](dw.order.PaymentInstrument.md#getmaskedgiftcertificatecode), [getMaskedGiftCertificateCode](dw.order.PaymentInstrument.md#getmaskedgiftcertificatecodenumber), [getPaymentMethod](dw.order.PaymentInstrument.md#getpaymentmethod), [isCreditCardExpired](dw.order.PaymentInstrument.md#iscreditcardexpired), [isPermanentlyMasked](dw.order.PaymentInstrument.md#ispermanentlymasked), [setBankAccountDriversLicense](dw.order.PaymentInstrument.md#setbankaccountdriverslicensestring), [setBankAccountDriversLicenseStateCode](dw.order.PaymentInstrument.md#setbankaccountdriverslicensestatecodestring), [setBankAccountHolder](dw.order.PaymentInstrument.md#setbankaccountholderstring), [setBankAccountNumber](dw.order.PaymentInstrument.md#setbankaccountnumberstring), [setBankRoutingNumber](dw.order.PaymentInstrument.md#setbankroutingnumberstring), [setCreditCardExpirationMonth](dw.order.PaymentInstrument.md#setcreditcardexpirationmonthnumber), [setCreditCardExpirationYear](dw.order.PaymentInstrument.md#setcreditcardexpirationyearnumber), [setCreditCardHolder](dw.order.PaymentInstrument.md#setcreditcardholderstring), [setCreditCardIssueNumber](dw.order.PaymentInstrument.md#setcreditcardissuenumberstring), [setCreditCardNumber](dw.order.PaymentInstrument.md#setcreditcardnumberstring), [setCreditCardToken](dw.order.PaymentInstrument.md#setcreditcardtokenstring), [setCreditCardType](dw.order.PaymentInstrument.md#setcreditcardtypestring), [setCreditCardValidFromMonth](dw.order.PaymentInstrument.md#setcreditcardvalidfrommonthnumber), [setCreditCardValidFromYear](dw.order.PaymentInstrument.md#setcreditcardvalidfromyearnumber), [setGiftCertificateCode](dw.order.PaymentInstrument.md#setgiftcertificatecodestring), [setGiftCertificateID](dw.order.PaymentInstrument.md#setgiftcertificateidstring)
+### Methods inherited from class ExtensibleObject
+
+[describe](dw.object.ExtensibleObject.md#describe), [getCustom](dw.object.ExtensibleObject.md#getcustom)
+### Methods inherited from class PersistentObject
+
+[getCreationDate](dw.object.PersistentObject.md#getcreationdate), [getLastModified](dw.object.PersistentObject.md#getlastmodified), [getUUID](dw.object.PersistentObject.md#getuuid)
+### Methods inherited from class Object
+
+[assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
+## Property Details
+
+### bankAccountDriversLicense
+- bankAccountDriversLicense: [String](TopLevel.String.md) `(read-only)`
+  - : Returns the driver's license associated with a bank account if the calling
+      context meets the following criteria: 
+      
+      
+      - If the method call happens in the context of a storefront request and  the current customer is identical to the customer related to the basket  or order, and the current protocol is HTTPS.  
+      - If the method call happens in the context of the business manager and the  current user has permission to the Orders module.  
+      
+      Otherwise, the method throws an exception.
+
+
+
+---
+
+### bankAccountNumber
+- bankAccountNumber: [String](TopLevel.String.md) `(read-only)`
+  - : Returns the account number if the calling context meets
+      the following criteria: 
+      
+      
+      - If the method call happens in the context of a storefront request and  the current customer is identical to the customer related to the basket  or order, and the current protocol is HTTPS.  
+      - If the method call happens in the context of the business manager and the  current user has permissions to the Orders module.  
+      
+      Otherwise, the method throws an exception.
+
+
+
+---
+
+### capturedAmount
+- capturedAmount: [Money](dw.value.Money.md) `(read-only)`
+  - : Returns the sum of the captured amounts. The captured amounts
+      are calculated on the fly. Associate a payment capture for an Payment Instrument with an Invoice
+      using Invoice method addCaptureTransaction.
+
+
+
+---
+
+### creditCardNumber
+- creditCardNumber: [String](TopLevel.String.md) `(read-only)`
+  - : Returns the de-crypted creditcard number if the calling context meets
+      the following criteria: 
+      
+      
+      - If the method call happens in the context of a storefront request and  the current authenticated customer is referenced by the basket or order, and the current protocol is HTTPS.  
+      - If the customer is anonymous, and the order references this customer, and the protocol is secure and  the order status is CREATED.  
+      - If the method call happens in the context of the business manager and the  current user has the permission to manage orders.  
+      - If the payment information has not been masked as a result of the data retention security policy  for the site.  
+      
+      Otherwise, the method returns the masked credit card number.
+
+
+
+---
+
+### paymentTransaction
+- paymentTransaction: [PaymentTransaction](dw.order.PaymentTransaction.md) `(read-only)`
+  - : Returns the Payment Transaction for this Payment Instrument or null.
+
+
+---
+
+### refundedAmount
+- refundedAmount: [Money](dw.value.Money.md) `(read-only)`
+  - : Returns the sum of the refunded amounts. The refunded amounts
+      are calculated on the fly. Associate a payment refund for an Payment Instrument with an Invoice
+      using Invoice method addRefundTransaction.
+
+
+
+---
+
+## Method Details
+
+### getBankAccountDriversLicense()
+- getBankAccountDriversLicense(): [String](TopLevel.String.md)
+  - : Returns the driver's license associated with a bank account if the calling
+      context meets the following criteria: 
+      
+      
+      - If the method call happens in the context of a storefront request and  the current customer is identical to the customer related to the basket  or order, and the current protocol is HTTPS.  
+      - If the method call happens in the context of the business manager and the  current user has permission to the Orders module.  
+      
+      Otherwise, the method throws an exception.
+
+
+    **Returns:**
+    - the driver's license number if the calling context meets the
+      necessary criteria.
+
+
+
+---
+
+### getBankAccountNumber()
+- getBankAccountNumber(): [String](TopLevel.String.md)
+  - : Returns the account number if the calling context meets
+      the following criteria: 
+      
+      
+      - If the method call happens in the context of a storefront request and  the current customer is identical to the customer related to the basket  or order, and the current protocol is HTTPS.  
+      - If the method call happens in the context of the business manager and the  current user has permissions to the Orders module.  
+      
+      Otherwise, the method throws an exception.
+
+
+    **Returns:**
+    - the account number if the calling context meets the
+      necessary criteria.
+
+
+
+---
+
+### getCapturedAmount()
+- getCapturedAmount(): [Money](dw.value.Money.md)
+  - : Returns the sum of the captured amounts. The captured amounts
+      are calculated on the fly. Associate a payment capture for an Payment Instrument with an Invoice
+      using Invoice method addCaptureTransaction.
+
+
+    **Returns:**
+    - sum of captured amounts
+
+
+---
+
+### getCreditCardNumber()
+- getCreditCardNumber(): [String](TopLevel.String.md)
+  - : Returns the de-crypted creditcard number if the calling context meets
+      the following criteria: 
+      
+      
+      - If the method call happens in the context of a storefront request and  the current authenticated customer is referenced by the basket or order, and the current protocol is HTTPS.  
+      - If the customer is anonymous, and the order references this customer, and the protocol is secure and  the order status is CREATED.  
+      - If the method call happens in the context of the business manager and the  current user has the permission to manage orders.  
+      - If the payment information has not been masked as a result of the data retention security policy  for the site.  
+      
+      Otherwise, the method returns the masked credit card number.
+
+
+    **Returns:**
+    - the de-crypted creditcard number if the calling context meets the
+      necessary criteria.
+
+
+
+---
+
+### getPaymentTransaction()
+- getPaymentTransaction(): [PaymentTransaction](dw.order.PaymentTransaction.md)
+  - : Returns the Payment Transaction for this Payment Instrument or null.
+
+    **Returns:**
+    - the Payment Transaction for this Payment Instrument or null.
+
+
+---
+
+### getRefundedAmount()
+- getRefundedAmount(): [Money](dw.value.Money.md)
+  - : Returns the sum of the refunded amounts. The refunded amounts
+      are calculated on the fly. Associate a payment refund for an Payment Instrument with an Invoice
+      using Invoice method addRefundTransaction.
+
+
+    **Returns:**
+    - sum of refunded amounts
+
+
+---
+
+<!-- prettier-ignore-end -->

package/data/script-api/dw.order.OrderProcessStatusCodes.md

@@ -0,0 +1,146 @@
+<!-- prettier-ignore-start -->
+# Class OrderProcessStatusCodes
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.order.OrderProcessStatusCodes](dw.order.OrderProcessStatusCodes.md)
+
+Contains constants representing different status codes
+for interacting with an order, such as cancelling
+or editing an order.
+
+
+
+## Constant Summary
+
+| Constant | Description |
+| --- | --- |
+| [COUPON_INVALID](#coupon_invalid): [String](TopLevel.String.md) = "COUPON_INVALID" | Indicates that a coupon in the order is not valid. |
+| [INVENTORY_RESERVATION_FAILED](#inventory_reservation_failed): [String](TopLevel.String.md) = "INVENTORY_RESERVATION_FAILED" | Indicates that no inventory could be reserved for the order. |
+| [ORDER_ALREADY_CANCELLED](#order_already_cancelled): [String](TopLevel.String.md) = "ORDER_CANCELLED" | Indicates that the order could not be used because  it has already been cancelled. |
+| [ORDER_ALREADY_EXPORTED](#order_already_exported): [String](TopLevel.String.md) = "ORDER_EXPORTED" | Indicates that the order could not be used because it  has already been exported. |
+| [ORDER_ALREADY_FAILED](#order_already_failed): [String](TopLevel.String.md) = "ORDER_FAILED" | Indicates that the order could not be used because  it has already been failed. |
+| [ORDER_ALREADY_REPLACED](#order_already_replaced): [String](TopLevel.String.md) = "ORDER_REPLACED" | Indicates that the order could not be used because  it has already been replaced. |
+| [ORDER_CONTAINS_GC](#order_contains_gc): [String](TopLevel.String.md) = "CANCEL_ORDER_GC" | Indicates that the order could not be used because it  contains gift certificates. |
+| [ORDER_NOT_CANCELLED](#order_not_cancelled): [String](TopLevel.String.md) = "ORDER_NOT_CANCELLED" | Indicates that the order could not be used because  it is not cancelled. |
+| [ORDER_NOT_FAILED](#order_not_failed): [String](TopLevel.String.md) = "ORDER_NOT_FAILED" | Indicates that the order could not be used because  it has not been failed. |
+| [ORDER_NOT_PLACED](#order_not_placed): [String](TopLevel.String.md) = "ORDER_NOT_PLACED" | Indicates that the order could not be used because  it has not been placed. |
+
+## Constructor Summary
+
+| Constructor | Description |
+| --- | --- |
+| [OrderProcessStatusCodes](#orderprocessstatuscodes)() |  |
+
+## Method Summary
+
+### Methods inherited from class Object
+
+[assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
+## Constant Details
+
+### COUPON_INVALID
+
+- COUPON_INVALID: [String](TopLevel.String.md) = "COUPON_INVALID"
+  - : Indicates that a coupon in the order is not valid.
+
+
+---
+
+### INVENTORY_RESERVATION_FAILED
+
+- INVENTORY_RESERVATION_FAILED: [String](TopLevel.String.md) = "INVENTORY_RESERVATION_FAILED"
+  - : Indicates that no inventory could be reserved for the order.
+
+
+---
+
+### ORDER_ALREADY_CANCELLED
+
+- ORDER_ALREADY_CANCELLED: [String](TopLevel.String.md) = "ORDER_CANCELLED"
+  - : Indicates that the order could not be used because
+      it has already been cancelled.
+
+
+
+---
+
+### ORDER_ALREADY_EXPORTED
+
+- ORDER_ALREADY_EXPORTED: [String](TopLevel.String.md) = "ORDER_EXPORTED"
+  - : Indicates that the order could not be used because it
+      has already been exported.
+
+
+
+---
+
+### ORDER_ALREADY_FAILED
+
+- ORDER_ALREADY_FAILED: [String](TopLevel.String.md) = "ORDER_FAILED"
+  - : Indicates that the order could not be used because
+      it has already been failed.
+
+
+
+---
+
+### ORDER_ALREADY_REPLACED
+
+- ORDER_ALREADY_REPLACED: [String](TopLevel.String.md) = "ORDER_REPLACED"
+  - : Indicates that the order could not be used because
+      it has already been replaced.
+
+
+
+---
+
+### ORDER_CONTAINS_GC
+
+- ORDER_CONTAINS_GC: [String](TopLevel.String.md) = "CANCEL_ORDER_GC"
+  - : Indicates that the order could not be used because it
+      contains gift certificates.
+
+
+
+---
+
+### ORDER_NOT_CANCELLED
+
+- ORDER_NOT_CANCELLED: [String](TopLevel.String.md) = "ORDER_NOT_CANCELLED"
+  - : Indicates that the order could not be used because
+      it is not cancelled.
+
+
+
+---
+
+### ORDER_NOT_FAILED
+
+- ORDER_NOT_FAILED: [String](TopLevel.String.md) = "ORDER_NOT_FAILED"
+  - : Indicates that the order could not be used because
+      it has not been failed.
+
+
+
+---
+
+### ORDER_NOT_PLACED
+
+- ORDER_NOT_PLACED: [String](TopLevel.String.md) = "ORDER_NOT_PLACED"
+  - : Indicates that the order could not be used because
+      it has not been placed.
+
+
+
+---
+
+## Constructor Details
+
+### OrderProcessStatusCodes()
+- OrderProcessStatusCodes()
+  - : 
+
+
+---
+
+<!-- prettier-ignore-end -->

package/data/script-api/dw.order.PaymentCard.md

@@ -0,0 +1,220 @@
+<!-- prettier-ignore-start -->
+# Class PaymentCard
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.object.PersistentObject](dw.object.PersistentObject.md)
+    - [dw.object.ExtensibleObject](dw.object.ExtensibleObject.md)
+      - [dw.order.PaymentCard](dw.order.PaymentCard.md)
+
+Represents payment cards and provides methods to access the payment card
+attributes and status.
+
+
+**Note:** this class handles sensitive financial and card holder data.
+Pay special attention to PCI DSS v3. requirements 1, 3, 7, and 9.
+
+
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [active](#active): [Boolean](TopLevel.Boolean.md) `(read-only)` | Returns 'true' if payment card is active (enabled), otherwise 'false' is returned. |
+| [cardType](#cardtype): [String](TopLevel.String.md) `(read-only)` | Returns the unique card type of the payment card. |
+| [description](#description): [MarkupText](dw.content.MarkupText.md) `(read-only)` | Returns the description of the payment card. |
+| [image](#image): [MediaFile](dw.content.MediaFile.md) `(read-only)` | Returns the reference to the payment card image. |
+| [name](#name): [String](TopLevel.String.md) `(read-only)` | Returns the name of the payment card. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [getCardType](dw.order.PaymentCard.md#getcardtype)() | Returns the unique card type of the payment card. |
+| [getDescription](dw.order.PaymentCard.md#getdescription)() | Returns the description of the payment card. |
+| [getImage](dw.order.PaymentCard.md#getimage)() | Returns the reference to the payment card image. |
+| [getName](dw.order.PaymentCard.md#getname)() | Returns the name of the payment card. |
+| [isActive](dw.order.PaymentCard.md#isactive)() | Returns 'true' if payment card is active (enabled), otherwise 'false' is returned. |
+| [isApplicable](dw.order.PaymentCard.md#isapplicablecustomer-string-number)([Customer](dw.customer.Customer.md), [String](TopLevel.String.md), [Number](TopLevel.Number.md)) | Returns 'true' if this payment card is applicable for the specified  customer, country and payment amount and the session currency. |
+| [verify](dw.order.PaymentCard.md#verifynumber-number-string)([Number](TopLevel.Number.md), [Number](TopLevel.Number.md), [String](TopLevel.String.md)) | Verify the card against the provided values. |
+| [verify](dw.order.PaymentCard.md#verifynumber-number-string-string)([Number](TopLevel.Number.md), [Number](TopLevel.Number.md), [String](TopLevel.String.md), [String](TopLevel.String.md)) | Verify the card against the provided values. |
+
+### Methods inherited from class ExtensibleObject
+
+[describe](dw.object.ExtensibleObject.md#describe), [getCustom](dw.object.ExtensibleObject.md#getcustom)
+### Methods inherited from class PersistentObject
+
+[getCreationDate](dw.object.PersistentObject.md#getcreationdate), [getLastModified](dw.object.PersistentObject.md#getlastmodified), [getUUID](dw.object.PersistentObject.md#getuuid)
+### Methods inherited from class Object
+
+[assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
+## Property Details
+
+### active
+- active: [Boolean](TopLevel.Boolean.md) `(read-only)`
+  - : Returns 'true' if payment card is active (enabled), otherwise 'false' is returned.
+
+
+---
+
+### cardType
+- cardType: [String](TopLevel.String.md) `(read-only)`
+  - : Returns the unique card type of the payment card.
+
+
+---
+
+### description
+- description: [MarkupText](dw.content.MarkupText.md) `(read-only)`
+  - : Returns the description of the payment card.
+
+
+---
+
+### image
+- image: [MediaFile](dw.content.MediaFile.md) `(read-only)`
+  - : Returns the reference to the payment card image.
+
+
+---
+
+### name
+- name: [String](TopLevel.String.md) `(read-only)`
+  - : Returns the name of the payment card.
+
+
+---
+
+## Method Details
+
+### getCardType()
+- getCardType(): [String](TopLevel.String.md)
+  - : Returns the unique card type of the payment card.
+
+    **Returns:**
+    - cardType of the payment card.
+
+
+---
+
+### getDescription()
+- getDescription(): [MarkupText](dw.content.MarkupText.md)
+  - : Returns the description of the payment card.
+
+    **Returns:**
+    - Description of the payment card.
+
+
+---
+
+### getImage()
+- getImage(): [MediaFile](dw.content.MediaFile.md)
+  - : Returns the reference to the payment card image.
+
+    **Returns:**
+    - Image of the payment card.
+
+
+---
+
+### getName()
+- getName(): [String](TopLevel.String.md)
+  - : Returns the name of the payment card.
+
+    **Returns:**
+    - Name of the payment card.
+
+
+---
+
+### isActive()
+- isActive(): [Boolean](TopLevel.Boolean.md)
+  - : Returns 'true' if payment card is active (enabled), otherwise 'false' is returned.
+
+    **Returns:**
+    - true if payment card is active, otherwise false.
+
+
+---
+
+### isApplicable(Customer, String, Number)
+- isApplicable(customer: [Customer](dw.customer.Customer.md), countryCode: [String](TopLevel.String.md), paymentAmount: [Number](TopLevel.Number.md)): [Boolean](TopLevel.Boolean.md)
+  - : Returns 'true' if this payment card is applicable for the specified
+      customer, country and payment amount and the session currency.
+      
+      
+      
+      The payment card is applicable if
+      
+      - the card is restricted by customer group, and at least one of the  groups of the specified customer is assigned to the card
+      - the card is restricted by billing country, and the specified country  code is assigned to the card
+      - the method is restricted by payment amount for the session currency,  and the specified payment amount is within the limits of the min/max  payment amount defined for the method and the session currency
+      - the method is restricted by session currency, and the session  currency code is assigned to the method
+      
+      
+      All parameters are optional, and if not specified, the respective
+      restriction won't be validated. For example, if a card is restricted by
+      billing country, but no country code is specified, this card will be
+      returned, unless it is filtered out by customer group or payment amount.
+
+
+    **Parameters:**
+    - customer - Customer or null
+    - countryCode - Billing country code or null
+    - paymentAmount - Payment amount or null
+
+    **Returns:**
+    - true if payment card is applicable, false otherwise
+
+
+---
+
+### verify(Number, Number, String)
+- verify(expiresMonth: [Number](TopLevel.Number.md), expiresYear: [Number](TopLevel.Number.md), cardNumber: [String](TopLevel.String.md)): [Status](dw.system.Status.md)
+  - : Verify the card against the provided values. This method is equivalent to
+      [verify(Number, Number, String, String)](dw.order.PaymentCard.md#verifynumber-number-string-string) but omits verification of the
+      card security code. If the verification fails the resulting
+      [Status](dw.system.Status.md) will hold up to 2 error items each with a code:
+      
+      
+      - [PaymentStatusCodes.CREDITCARD_INVALID_EXPIRATION_DATE](dw.order.PaymentStatusCodes.md#creditcard_invalid_expiration_date)- the expiresMonth and expiresYear do not describe a  month in the future, or describe an invalid month outside the range 1-12.
+      - [PaymentStatusCodes.CREDITCARD_INVALID_CARD_NUMBER](dw.order.PaymentStatusCodes.md#creditcard_invalid_card_number)- the cardNumber does not verify against one or more configured  checks, which may include the Luhn checksum, accepted number lengths, or accepted number prefixes.
+
+
+    **Parameters:**
+    - expiresMonth - expiration month as integer, 1 (January) to 12 (December)
+    - expiresYear - expiration year as integer, e.g. 2025
+    - cardNumber - card number, a string containing digital characters
+
+    **Returns:**
+    - status indicating result
+
+
+---
+
+### verify(Number, Number, String, String)
+- verify(expiresMonth: [Number](TopLevel.Number.md), expiresYear: [Number](TopLevel.Number.md), cardNumber: [String](TopLevel.String.md), csc: [String](TopLevel.String.md)): [Status](dw.system.Status.md)
+  - : Verify the card against the provided values. If the verification fails the resulting
+      [Status](dw.system.Status.md) will hold up to 3 error items with these codes:
+      
+      
+      - [PaymentStatusCodes.CREDITCARD_INVALID_EXPIRATION_DATE](dw.order.PaymentStatusCodes.md#creditcard_invalid_expiration_date)- the expiresMonth and expiresYear do not describe a  month in the future, or describe an invalid month outside the range 1-12.
+      - [PaymentStatusCodes.CREDITCARD_INVALID_CARD_NUMBER](dw.order.PaymentStatusCodes.md#creditcard_invalid_card_number)- the cardNumber does not verify against one or more configured  checks, which may include the Luhn checksum, accepted number lengths, or accepted number prefixes.
+      - [PaymentStatusCodes.CREDITCARD_INVALID_SECURITY_CODE](dw.order.PaymentStatusCodes.md#creditcard_invalid_security_code)- the card security code does not verify against the configured  accepted length.
+
+
+    **Parameters:**
+    - expiresMonth - expiration month as integer, 1 (January) to 12 (December)
+    - expiresYear - expiration year as integer, e.g. 2025
+    - cardNumber - card number, a string containing digital characters
+    - csc - card security code, a string containing digital characters
+
+    **Returns:**
+    - status indicating result
+
+
+---
+
+<!-- prettier-ignore-end -->