FailureReasonCode (Java API for ISO 20022 - Payments business domain)

java.lang.Object
- com.tools20022.metamodel.MMCode
- - com.tools20022.repository.codeset.FailureReasonCode

All Implemented Interfaces:

GeneratedMetamodelBean, MMModelEntity, MMRepositoryConcept
```
public class FailureReasonCode
extends MMCode
```
List of incidents happening during the transaction.
Constant fields:
- code =
- dataDictionary = GeneratedRepository.mmdataDict
- example =
  - "CUCL"
- registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.REGISTERED
- name = "FailureReasonCode"
- definition = "List of incidents happening during the transaction."

Field Summary

Fields
Modifier and Type	Field and Description
`static FailureReasonCode`	`CardCaptured` ATM manager has requested to capture the card.
`static FailureReasonCode`	`CardDeclined` Integrated circuit card declines the transaction before or after the authorisation.
`static FailureReasonCode`	`CardError` Unable to complete transaction with the card.
`static FailureReasonCode`	`CardRetained` Card has been retained by the ATM or the terminal.
`static FailureReasonCode`	`Compromised` Key is compromised.
`static FailureReasonCode`	`CustomerCancel` Customer cancellation, for example removing the card before the end of the transaction.
`static FailureReasonCode`	`CustomerDecline` Customer has declined additional fees or a lower amount, transaction fails.
`static FailureReasonCode`	`CustomerTimeOut` Customer has not been performed in time an action.
`static FailureReasonCode`	`Expired` Key has expired.
`static FailureReasonCode`	`ForgottenCard` Customer has left the card in the ATM or a motorised card reader.
`static FailureReasonCode`	`FullfilmentError` Unable to fulfil, for instance dispensing the cash.
`static FailureReasonCode`	`Hardware` Hardware error on the device.
`static FailureReasonCode`	`InvalidKCV` Key check value is incorrect.
`static FailureReasonCode`	`KeyLoadError` Error during the key download in the security device.
`static FailureReasonCode`	`Malfunction` Suspected malfunction.
`static FailureReasonCode`	`OfflineDeclined` Offline authorisation declined the transaction.
`static FailureReasonCode`	`OnLineDeclined` Online authorisation declined the transaction.
`static FailureReasonCode`	`OutOfCustomerService` ATM manager has requested to the ATM to stop customer services.
`static FailureReasonCode`	`Partial` Completed partially.
`static FailureReasonCode`	`Security` General security error.
`static FailureReasonCode`	`SecurityError` Security error has occurred in the authorisation response message sent by the acquirer.
`static FailureReasonCode`	`SuspectedFraud` Card payment transaction fails because the merchant suspect a fraud.
`static FailureReasonCode`	`TimeOut` Timeout while waiting for a response to a request message, or no response was received (for example connection release before receiving the response).
`static FailureReasonCode`	`TooLateResponse` Response to the previous message was received too late.
`static FailureReasonCode`	`UnableToCapture` Unable to capture the card as requested.
`static FailureReasonCode`	`UnableToComplete` Unable to complete the transaction after the authorisation response.
`static FailureReasonCode`	`UnableToSend` Unable to deliver the request message to the recipient party.

Fields inherited from class com.tools20022.metamodel.MMCode
codeNameAttribute, ownerAttribute

Fields inherited from interface com.tools20022.metamodel.MMRepositoryConcept
checkNameFirstLetterUppercase, checkRemovalDateRegistrationStatus, constraintAttribute, definitionAttribute, docletAttribute, exampleAttribute, nameAttribute, registrationStatusAttribute, removalDateAttribute, semanticMarkupAttribute

Fields inherited from interface com.tools20022.metamodel.MMModelEntity
nextVersionsAttribute, objectIdentifierAttribute, previousVersionAttribute

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static MMCodeSet`	`mmObject()`
`static FailureReasonCode`	`valueOf(String codeName)`
`static FailureReasonCode[]`	`values()`

Methods inherited from class com.tools20022.metamodel.MMCode
getCodeName, getConstraint, getContainer, getDefinition, getDoclet, getExample, getMetamodel, getName, getNextVersions, getObjectIdentifier, getOwner, getPreviousVersion, getRegistrationStatus, getRemovalDate, getSemanticMarkup, metaType

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CustomerCancel
```
public static final FailureReasonCode CustomerCancel
```
    Customer cancellation, for example removing the card before the end of the transaction.
    Constant fields:
    - owner = FailureReasonCode
    - codeName = "CUCL"
    - registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.REGISTERED
    - name = "CustomerCancel"
    - definition = "Customer cancellation, for example removing the card before the end of the transaction."
  - Malfunction
```
public static final FailureReasonCode Malfunction
```
    Suspected malfunction.
    Constant fields:
    - owner = FailureReasonCode
    - codeName = "MALF"
    - registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.REGISTERED
    - name = "Malfunction"
    - definition = "Suspected malfunction."
  - Partial
```
public static final FailureReasonCode Partial
```
    Completed partially.
    Constant fields:
    - owner = FailureReasonCode
    - codeName = "PART"
    - registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.REGISTERED
    - name = "Partial"
    - definition = "Completed partially."
  - TooLateResponse
```
public static final FailureReasonCode TooLateResponse
```
    Response to the previous message was received too late.
    Constant fields:
    - owner = FailureReasonCode
    - codeName = "LATE"
    - registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.REGISTERED
    - name = "TooLateResponse"
    - definition = "Response to the previous message was received too late."
  - UnableToComplete
```
public static final FailureReasonCode UnableToComplete
```
    Unable to complete the transaction after the authorisation response.
    Constant fields:
    - owner = FailureReasonCode
    - codeName = "UCMP"
    - registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.REGISTERED
    - name = "UnableToComplete"
    - definition = "Unable to complete the transaction after the authorisation response."
  - UnableToSend
```
public static final FailureReasonCode UnableToSend
```
    Unable to deliver the request message to the recipient party.
    Constant fields:
    - owner = FailureReasonCode
    - codeName = "USND"
    - registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.REGISTERED
    - name = "UnableToSend"
    - definition = "Unable to deliver the request message to the recipient party."
  - TimeOut
```
public static final FailureReasonCode TimeOut
```
    Timeout while waiting for a response to a request message, or no response was received (for example connection release before receiving the response).
    Constant fields:
    - owner = FailureReasonCode
    - codeName = "TIMO"
    - registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.REGISTERED
    - name = "TimeOut"
    - definition = "Timeout while waiting for a response to a request message, or no response was received (for example connection release before receiving the response)."
  - CardDeclined
```
public static final FailureReasonCode CardDeclined
```
    Integrated circuit card declines the transaction before or after the authorisation.
    Constant fields:
    - owner = FailureReasonCode
    - codeName = "CDCL"
    - registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.REGISTERED
    - name = "CardDeclined"
    - definition = "Integrated circuit card declines the transaction before or after the authorisation."
  - OnLineDeclined
```
public static final FailureReasonCode OnLineDeclined
```
    Online authorisation declined the transaction.
    Constant fields:
    - owner = FailureReasonCode
    - codeName = "NDCL"
    - registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.REGISTERED
    - name = "OnLineDeclined"
    - definition = "Online authorisation declined the transaction."
  - OfflineDeclined
```
public static final FailureReasonCode OfflineDeclined
```
    Offline authorisation declined the transaction.
    Constant fields:
    - owner = FailureReasonCode
    - codeName = "FDCL"
    - registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.REGISTERED
    - name = "OfflineDeclined"
    - definition = "Offline authorisation declined the transaction."
  - SuspectedFraud
```
public static final FailureReasonCode SuspectedFraud
```
    Card payment transaction fails because the merchant suspect a fraud.
    Constant fields:
    - owner = FailureReasonCode
    - codeName = "SFRD"
    - registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.REGISTERED
    - name = "SuspectedFraud"
    - definition = "Card payment transaction fails because the merchant suspect a fraud."
  - SecurityError
```
public static final FailureReasonCode SecurityError
```
    Security error has occurred in the authorisation response message sent by the acquirer.
    Constant fields:
    - owner = FailureReasonCode
    - codeName = "SECU"
    - registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.PROVISIONALLY_REGISTERED
    - name = "SecurityError"
    - definition = "Security error has occurred in the authorisation response message sent by the acquirer."
  - CardCaptured
```
public static final FailureReasonCode CardCaptured
```
    ATM manager has requested to capture the card.
    Constant fields:
    - owner = FailureReasonCode
    - codeName = "CDCP"
    - registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.PROVISIONALLY_REGISTERED
    - name = "CardCaptured"
    - definition = "ATM manager has requested to capture the card."
  - CardError
```
public static final FailureReasonCode CardError
```
    Unable to complete transaction with the card.
    Constant fields:
    - owner = FailureReasonCode
    - codeName = "CDER"
    - registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.PROVISIONALLY_REGISTERED
    - name = "CardError"
    - definition = "Unable to complete transaction with the card."
  - CustomerDecline
```
public static final FailureReasonCode CustomerDecline
```
    Customer has declined additional fees or a lower amount, transaction fails.
    Constant fields:
    - owner = FailureReasonCode
    - codeName = "CUDC"
    - registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.PROVISIONALLY_REGISTERED
    - name = "CustomerDecline"
    - definition = "Customer has declined additional fees or a lower amount, transaction fails."
  - ForgottenCard
```
public static final FailureReasonCode ForgottenCard
```
    Customer has left the card in the ATM or a motorised card reader.
    Constant fields:
    - owner = FailureReasonCode
    - codeName = "CDFG"
    - registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.PROVISIONALLY_REGISTERED
    - name = "ForgottenCard"
    - definition = "Customer has left the card in the ATM or a motorised card reader."
  - FullfilmentError
```
public static final FailureReasonCode FullfilmentError
```
    Unable to fulfil, for instance dispensing the cash.
    Constant fields:
    - owner = FailureReasonCode
    - codeName = "FILL"
    - registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.PROVISIONALLY_REGISTERED
    - name = "FullfilmentError"
    - definition = "Unable to fulfil, for instance dispensing the cash."
  - OutOfCustomerService
```
public static final FailureReasonCode OutOfCustomerService
```
    ATM manager has requested to the ATM to stop customer services.
    Constant fields:
    - owner = FailureReasonCode
    - codeName = "CSRV"
    - registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.PROVISIONALLY_REGISTERED
    - name = "OutOfCustomerService"
    - definition = "ATM manager has requested to the ATM to stop customer services."
  - UnableToCapture
```
public static final FailureReasonCode UnableToCapture
```
    Unable to capture the card as requested.
    Constant fields:
    - owner = FailureReasonCode
    - codeName = "UCPT"
    - registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.PROVISIONALLY_REGISTERED
    - name = "UnableToCapture"
    - definition = "Unable to capture the card as requested."
  - Security
```
public static final FailureReasonCode Security
```
    General security error.
    Constant fields:
    - owner = FailureReasonCode
    - codeName = "SECR"
    - registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.PROVISIONALLY_REGISTERED
    - name = "Security"
    - definition = "General security error."
  - Hardware
```
public static final FailureReasonCode Hardware
```
    Hardware error on the device.
    Constant fields:
    - owner = FailureReasonCode
    - codeName = "HRDW"
    - registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.PROVISIONALLY_REGISTERED
    - name = "Hardware"
    - definition = "Hardware error on the device."
  - Compromised
```
public static final FailureReasonCode Compromised
```
    Key is compromised.
    Constant fields:
    - owner = FailureReasonCode
    - codeName = "CMPR"
    - registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.PROVISIONALLY_REGISTERED
    - name = "Compromised"
    - definition = "Key is compromised."
  - Expired
```
public static final FailureReasonCode Expired
```
    Key has expired.
    Constant fields:
    - owner = FailureReasonCode
    - codeName = "EXPR"
    - registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.PROVISIONALLY_REGISTERED
    - name = "Expired"
    - definition = "Key has expired."
  - InvalidKCV
```
public static final FailureReasonCode InvalidKCV
```
    Key check value is incorrect.
    Constant fields:
    - owner = FailureReasonCode
    - codeName = "KCVE"
    - registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.PROVISIONALLY_REGISTERED
    - name = "InvalidKCV"
    - definition = "Key check value is incorrect."
  - KeyLoadError
```
public static final FailureReasonCode KeyLoadError
```
    Error during the key download in the security device.
    Constant fields:
    - owner = FailureReasonCode
    - codeName = "KLOD"
    - registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.PROVISIONALLY_REGISTERED
    - name = "KeyLoadError"
    - definition = "Error during the key download in the security device."
  - CardRetained
```
public static final FailureReasonCode CardRetained
```
    Card has been retained by the ATM or the terminal.
    Constant fields:
    - owner = FailureReasonCode
    - codeName = "CDRT"
    - registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.PROVISIONALLY_REGISTERED
    - name = "CardRetained"
    - definition = "Card has been retained by the ATM or the terminal."
  - CustomerTimeOut
```
public static final FailureReasonCode CustomerTimeOut
```
    Customer has not been performed in time an action.
    Constant fields:
    - owner = FailureReasonCode
    - codeName = "CUTO"
    - registrationStatus = com.tools20022.metamodel.MMRegistrationStatus.PROVISIONALLY_REGISTERED
    - name = "CustomerTimeOut"
    - definition = "Customer has not been performed in time an action."
- Method Detail
  - mmObject
```
public static final MMCodeSet mmObject()
```
  - valueOf
```
public static FailureReasonCode valueOf(String codeName)
```
  - values
```
public static FailureReasonCode[] values()
```

Class FailureReasonCode

Field Summary

Fields inherited from class com.tools20022.metamodel.MMCode

Fields inherited from interface com.tools20022.metamodel.MMRepositoryConcept

Fields inherited from interface com.tools20022.metamodel.MMModelEntity

Method Summary

Methods inherited from class com.tools20022.metamodel.MMCode

Methods inherited from class java.lang.Object

Field Detail

CustomerCancel

Malfunction

Partial

TooLateResponse

UnableToComplete

UnableToSend

TimeOut

CardDeclined

OnLineDeclined

OfflineDeclined

SuspectedFraud

SecurityError

CardCaptured

CardError

CustomerDecline

ForgottenCard

FullfilmentError

OutOfCustomerService

UnableToCapture

Security

Hardware

Compromised

Expired

InvalidKCV

KeyLoadError

CardRetained

CustomerTimeOut

Method Detail

mmObject

valueOf

values