[Solution] Detailed other's error message

Document Status

CLOSED

Document Owner(s)

@de Sousa Santos, Rodrigo

Reviewers

@Raphael Ferreira Gomes
@Szekely, Szabolcs
@Augusto Romao, Vinicius
@Garozzo de Sobral, Wellington
@Capovilla, Evandro
@Felipe Rooke

 

Context

Iberia proposes the inclusion of new error messages in the error detailing flow, following the established processes in stories:

The objective is to enhance error communication between the backend and frontend.

image-20241009-123944.png

 

Proposed Solution

To address these issues, we propose the creation of new error classes in the backend that will be sent to the frontend. This implementation will include specific error codes for different scenarios, such as payment cancellations, instead of using generic codes. This change will allow the frontend to display more informative and contextualized error messages, improving clarity and the overall user experience.

Backend

After the solution approval, will need to update the below documents with new classes, code errors, and any important things.

Description errors

QTD

Payment method

Paycomet Code

Public Message (Logs/Amplitude)

Error Code

Lokalise key


description error modal: error.payment.X.XXX

title error modal: error.payment.X.XXX.title

label button modal: error.payment.X.XXX.cta

Severity

Class Error

Parent class

Documentation

1

Card

100

Expired credit card

PAYMENT.2.100.003

error.payment.2.100.103

error.payment.2.100.103.tilte

error.payment.2.100.103.cta

2

ExpiredCardError

CardError2

Represents an error when the card has expired

2

Card

105

Insufficient funds

PAYMENT.2.100.004

error.payment.2.100.104

error.payment.2.100.104.title

error.payment.2.100.104.cta

2

NoFundsCardError

CardError2

Represents an error when the card does not have enough funds in order to perform the payment

3

Card

127

Invalid parameter

PAYMENT.4.009

error.payment.4.009

error.payment.4.009.title

error.payment.4.009.cta

4

DataExternalValidationError

ExternalValidationError2

Represents an error when there is an invalid parameter

4

Card

137

Credit card not valid

PAYMENT.2.100.006

error.payment.2.100.106

error.payment.2.100.106.title

error.payment.2.100.106.cta

2

DeclinedCardError

CardError2

Represents an error when the card declined for various reasons

5

Card

141

Invalid amount

PAYMENT.2.100.007

error.payment.2.100.107

error.payment.2.100.107.title

error.payment.2.100.107.cta

2

InvalidAmountError

NoFundsCardError

Represents an error when the amount is zero or not valid

6

Card

143

Authentification error

PAYMENT.4.001.001

error.payment.4.001.001

error.payment.4.001.001.title

error.payment.4.001.001.cta

4

AuthenticationError

AuthSecurityError2

Represents errors related to security and authentication within the payment system.
Invalid access tokens, and other related security and authentication problems.

7

Card

195

Requires SCA authentication

PAYMENT.4.001.002

error.payment.4.001.002

error.payment.4.001.002.title

error.payment.4.001.002.cta

4

ScaAuthenticationError

AuthSecurityError2

Represents an error a Strong Customer Authentication error.

SCA (Strong Customer Authentication) is a requirement of the European directive PSD2 (Revised Payment Services Directive) aimed at enhancing the security of online financial transactions

8

Card

500

General external error

PAYMENT.4.006

error.payment.4.006

error.payment.4.006.title

error.payment.4.006.cta

4

ExternalError2

PspError2

General, unspecified payment error.

9

Card

506

Confirmation data not valid

PAYMENT.4.006.001

error.payment.4.006.001

error.payment.4.006.001.title

error.payment.4.006.00.cta

4

ConfirmationDataNotValidError

ExternalError2

Represents an error when confirmation data is not valid

10

Card

510

Refund is not possible

PAYMENT.4.010.001

error.payment.4.010.001

error.payment.4.010.001.title

error.payment.4.010.001.cta

4

RefundNotPossibleError

OperationDeniedError

Represents an error when the refund is not possible

11

Card

513

General external error

PAYMENT.4.006

error.payment.4.006

error.payment.4.006.title

error.payment.4.006.cta

4

ExternalError2

PspError2

General, unspecified payment error.

12

Card

514

General external error

PAYMENT.4.006

error.payment.4.006

error.payment.4.006.title

error.payment.4.006.cta

4

ExternalError2

PspError2

General, unspecified payment error.

13

Card

515

General external error

PAYMENT.4.006

error.payment.4.006

error.payment.4.006.title

error.payment.4.006.cta

4

ExternalError2

PspError2

General, unspecified payment error.

14

Card

516

General external error

PAYMENT.4.006

error.payment.4.006

error.payment.4.006.title

error.payment.4.006.cta

4

ExternalError2

PspError2

General, unspecified payment error.

15

Card

517

General external error

PAYMENT.4.006

error.payment.4.006

error.payment.4.006.title

error.payment.4.006.cta

4

ExternalError2

PspError2

General, unspecified payment error.

16

Card

518

General external error

PAYMENT.4.006

error.payment.4.006

error.payment.4.006.title

error.payment.4.006.cta

4

ExternalError2

PspError2

General, unspecified payment error.

17

Card

519

General external error

PAYMENT.4.006

error.payment.4.006

error.payment.4.006.title

error.payment.4.006.cta

4

ExternalError2

PspError2

General, unspecified payment error.

18

Card

520

General external error

PAYMENT.4.006

error.payment.4.006

error.payment.4.006.title

error.payment.4.006.cta

4

ExternalError2

PspError2

General, unspecified payment error.

19

Card

521

General external error

PAYMENT.4.006

error.payment.4.006

error.payment.4.006.title

error.payment.4.006.cta

4

ExternalError2

PspError2

General, unspecified payment error.

20

Card

522

General external error

PAYMENT.4.006

error.payment.4.006

error.payment.4.006.title

error.payment.4.006.cta

4

ExternalError2

PspError2

General, unspecified payment error.

21

Card

523

General external error

PAYMENT.4.006

error.payment.4.006

error.payment.4.006.title

error.payment.4.006.cta

4

ExternalError2

PspError2

General, unspecified payment error.

22

Card

535

General external error

PAYMENT.4.006

error.payment.4.006

error.payment.4.006.title

error.payment.4.006.cta

4

ExternalError2

PspError2

General, unspecified payment error.

23

Card

524

General external error

PAYMENT.4.006

error.payment.4.006

error.payment.4.006.title

error.payment.4.006.cta

4

ExternalError2

PspError2

General, unspecified payment error.

24

Card

525

General external error

PAYMENT.4.006

error.payment.4.006

error.payment.4.006.title

error.payment.4.006.cta

4

ExternalError2

PspError2

General, unspecified payment error.

25

Card

526

General external error

PAYMENT.4.006

error.payment.4.006

error.payment.4.006.title

error.payment.4.006.cta

4

ExternalError2

PspError2

General, unspecified payment error.

26

Card

549

General external error

PAYMENT.4.006

error.payment.4.006

error.payment.4.006.title

error.payment.4.006.cta

4

ExternalError2

PspError2

General, unspecified payment error.

27

Card

555

Could not find the previous operation

PAYMENT.4.009.001

error.payment.4.009.001

error.payment.4.009.001.title

error.payment.4.009.001.cta

4

CouldNotFindPreviousOperationError

DataExternalValidationError

Represents an error when could not find the previous operation

28

Card

569

Denied operation

PAYMENT.4.010

error.payment.4.010

error.payment.4.010.title

error.payment.4.010.cta

4

OperationDeniedError

ExternalValidationError2

Represents an error when the operation cannot be performed

29

Card

1019

Operation timeout exceeded

PAYMENT.4.011

error.payment.4.011

error.payment.4.011.title

error.payment.4.011.cta

4

TimeOutConnectionError

ConnectionError2

Represents an error when there is a timeout

30

Card

1026

Duplicated external reference

PAYMENT.4.006.002

error.payment.4.006.002

error.payment.4.006.002.title

error.payment.4.006.002.cta

4

DuplicatedExternalReferenceError

ExternalError2

Represents an error when there is a duplicated external reference

31

Card

1038

Field DS_MERCHANT_AMOUNT incorrect

PAYMENT.4.009

error.payment.4.009

error.payment.4.009.title

error.payment.4.009.cta

4

DataExternalValidationError

ExternalValidationError2

Represents an error when the field DS_MERCHANT_AMOUNT is incorrect

32

Card

1099

General external error

PAYMENT.4.006

error.payment.4.006

error.payment.4.006.title

error.payment.4.006.cta

4

ExternalError2

PspError2

General, unspecified payment error.

33

Card

1185

Minimun limit not allowed

PAYMENT.2.102.004

error.payment.2.102.004

error.payment.2.102.004.title

error.payment.2.102.004.cta

2

CardLimitExceededError

PaymentRestrictionError2

Represents an error when the Minimun limit not allowed

34

Card

1186

Maximum limit not allowed

PAYMENT.2.102.004

error.payment.2.102.004

error.payment.2.102.004.title

error.payment.2.102.004.cta

2

CardLimitExceededError

PaymentRestrictionError2

Represents an error when the card amount/number of transaction limit has been exceeded

35

Card

1187

Daily limit not allowed

PAYMENT.2.102.004

error.payment.2.102.004

error.payment.2.102.004.title

error.payment.2.102.004.cta

2

CardLimitExceededError

PaymentRestrictionError2

Represents an error when the Daily limit not allowed

36

Card

1188

Monthly limit not allowed

PAYMENT.2.102.004

error.payment.2.102.004

error.payment.2.102.004.title

error.payment.2.102.004.cta

2

CardLimitExceededError

PaymentRestrictionError2

Represents an error when the Monthly limit not allowed

37

Card

1189

Max amount (same card / last 24 h.) not allowed

PAYMENT.2.102.004

error.payment.2.102.004

error.payment.2.102.004.title

error.payment.2.102.004.cta

2

CardLimitExceededError

PaymentRestrictionError2

Represents an error when the Max amount (same card / last 24 h.) not allowed

38

Card

1190

Max amount (same card / last 24 h. / same IP address) not allowed

PAYMENT.2.102.004

error.payment.2.102.004

error.payment.2.102.004.title

error.payment.2.102.004.cta

2

CardLimitExceededError

PaymentRestrictionError2

Represents an error when the Max amount (same card / last 24 h. / same IP address) not allowed

39

Card

1191

Day / IP address limit (all cards) not allowed

PAYMENT.2.102.004

error.payment.2.102.004

error.payment.2.102.004.title

error.payment.2.102.004.cta

2

CardLimitExceededError

PaymentRestrictionError2

Represents an error when the card amount/number of transaction limit has been exceeded

40

Card

1194

Card brands not allowed

PAYMENT.2.100.002

error.payment.2.100.002

error.payment.2.100.002.title

error.payment.2.100.002.cta

2

CardTypeNotAllowedError

CardError2

Represents an error when the card type (type/brand/etc.) is not allowed for this transaction

41

Card

1197

Card country issuer not allowed

PAYMENT.2.102.005

error.payment.2.102.005

error.payment.2.102.005.title

error.payment.2.102.005.cta

2

CardCountryNotAllowed

PaymentRestrictionError2

Represents an error when the card / issuing bank country is not allowed for the transaction

42

Card

1254

Commerce with secure cardholder and cardholder without secure purchase key

PAYMENT.4.001.003

error.payment.4.001.003

error.payment.4.001.003.title

error.payment.4.001.003.cta

4

CardholderSecurePurchaseKeyError

AuthSecurityError2

Represents an error when there is a commerce with secure cardholder and cardholder without secure purchase key

43

Card

1326

Denial by security controls on the processor

PAYMENT.2.002

error.payment.2.002

error.payment.2.002.title

error.payment.2.002.cta

2

FraudError

ExternalError2

Represents errors generated when a transaction is suspected of being fraudulent. This class extends `ExternalError` to encapsulate fraud-related issues, including abnormal user behavior, suspicious transaction patterns, and other indicators of potential fraud. It is designed to aid in the identification and management of transactions that may pose a risk to the payment system

44

Card

1327

3DS authentication process error

PAYMENT.2.101.003

error.payment.2.101.003

error.payment.2.101.003.title

error.payment.2.101.003.cta

2

ThreeDsChallengeFailedError

PaymentProcessingError2

Represents an error when the 3DS Challenge failed

45

Payment Link

1417

PayPal - The instrument presented has been declined. Please select another one.

PAYMENT.2.100.005

error.payment.2.100.105

error.payment.2.100.105.title

error.payment.2.100.105.cta

2

DeclinedCardError

CardError2

Represents an error when the card declined for various reasons

Created classes:

  1. AuthSecurityError

  2. ExternalError

  3. FraudError

  4. PspError

  5. ExternalValidationError

Classes will be created:

  1. InvalidAmountError

  2. AuthenticationError

  3. CardCountryNotAllowed

  4. CardLimitExceededError

  5. DeclinedCardError

  6. CardTypeNotAllowedError

  7. CardholderSecurePurchaseKeyError

  8. ConfirmationDataNotValidError

  9. CouldNotFindPreviousOperationError

  10. DataExternalValidationError

  11. DeclinedCardError

  12. DuplicatedExternalReferenceError

  13. ExpiredCardError

  14. NoFundsCardError

  15. OperationDeniedError

  16. RefundNotPossibleError

  17. ScaAuthenticationError

  18. TimeOutConnectionError

  19. ThreeDsChallengeFailedError

 

intl-packages

  • Rename the class:

    • From: OperationCancelledError

    • To: OperationCancelledFailedError

 

  • Will be created new classes in the path:

    • intl-packages/packages/psp-base/src/errors/psp-error-2/

import { HttpStatus } from '@nestjs/common'; import { RbiPaymentErrorCodes, TPspError2 } from '../psp-error-2'; import { NoFundsCardError } from './no-founds-card-error'; export class InvalidAmountError extends NoFundsCardError { /** * Represents an error when the amount is zero or not valid. * * @param params - The error parameters. * @param [params.httpStatus] - The HTTP status code to be returned in the response. * @param [params.message] - A human-readable message that provides details about the payment processing issue. * @param [params.metadata] - Optional metadata that may include additional context or details about the error. * @param [params.originalError] - The original error that caused this error. */ constructor(params?: TPspError2) { const { httpStatus = HttpStatus.UNPROCESSABLE_ENTITY, metadata, rbiErrorCode = RbiPaymentErrorCodes.INVALID_AMOUNT_ERROR, } = params ?? {}; super({ ...params, httpStatus, metadata, rbiErrorCode }); } }
import { HttpStatus } from '@nestjs/common'; import { AuthSecurityError2, RbiPaymentErrorCodes, TPspError2 } from '../psp-error-2'; export class AuthenticationError extends AuthSecurityError2 { /** * Represents an error when the user cannot be authenticated. * * @param params - The error parameters. * @param [params.httpStatus] - The HTTP status code to be returned in the response. * @param [params.message] - A human-readable message that provides details about the payment processing issue. * @param [params.metadata] - Optional metadata that may include additional context or details about the error. * @param [params.originalError] - The original error that caused this error. */ constructor(params?: TPspError2) { const { httpStatus = HttpStatus.UNPROCESSABLE_ENTITY, metadata, rbiErrorCode = RbiPaymentErrorCodes.AUTHENTICATION_ERROR, } = params ?? {}; super({ ...params, httpStatus, metadata, rbiErrorCode }); } }
import { HttpStatus } from '@nestjs/common'; import { PaymentRestrictionError2, RbiPaymentErrorCodes, TPspError2 } from '../psp-error-2'; export class CardCountryNotAllowed extends PaymentRestrictionError2 { /** * Represents an error when the card / issuing bank country is not allowed for the transaction. * * @param params - The error parameters. * @param [params.httpStatus] - The HTTP status code to be returned in the response. * @param [params.message] - A human-readable message that provides details about the payment processing issue. * @param [params.metadata] - Optional metadata that may include additional context or details about the error. * @param [params.originalError] - The original error that caused this error. */ constructor(params?: TPspError2) { const { httpStatus = HttpStatus.UNPROCESSABLE_ENTITY, metadata, rbiErrorCode = RbiPaymentErrorCodes.CARD_COUNTRY_NOT_ALLOWED_ERROR, } = params ?? {}; super({ ...params, httpStatus, metadata, rbiErrorCode }); } }

 

  • Export the classes:

    • path: intl-packages/packages/psp-base/src/errors/psp-error-2/index.ts

  • Will create the new error codes:

    • path: intl-packages/packages/psp-base/src/errors/psp-error-2/psp-error-2.ts

      • Code Errors:

intl-psp-paycomet-service

  • We will need to map the error code:

    • path: intl-psp-paycomet-service/src/errors/paycomet-error-map.ts

  • Check the possibility of mapping errors where classes have already been created.

    • e.g.:

      image-20241016-114745.png

Error Messages

Paycomet

Lokalise Key

Class Error

Description

Modal Title

Modal Message

Modal CTA

Screen

Paycomet

Lokalise Key

Class Error

Description

Modal Title

Modal Message

Modal CTA

Screen

100

error.payment.2.100.003

ExpiredCardError

Expired Card -
Represents an error when the card has expired

“Expired Card”

“Your card has expired. Please change your payment method in order to complete the transaction.”

“Change Payment Method”

 

 

105

error.payment.2.100.004

NoFundsCardError

Insufficient Credit to make charge - Represents an error when the card does not have enough funds in order to perform the payment

“Payment Failed”

“Your payment couldn't be processed due to an issue with your payment method. Please review your payment method or choose a different one to complete your purchase.”

“Change Payment Method”

 

 

 

127, and 1038

error.payment.4.009

DataExternalValidationError

  • Invalid Parameter -
Represents an error when there is an invalid parameter

  • Incorrect DS_MERCHANT_AMOUNT field - Represents an error when the field DS_MERCHANT_AMOUNT is incorrect

“Payment Failed"

“Something went wrong with this 
payment. Please go back and try again.”

“Go Back and Try Again”

 

 

 

 

137, 1417, and 1425

error.payment.2.100.006

DeclinedCardError

Invalid Card - Represents an error when the card declined for various reasons

  • PayPal - The instrument presented has been declined. Please select another one. - Represents an error when the card declined for various reasons

  • Paypal - Operation Canceled by the user

 

“Payment Declined”

“You card was declined by the issuer. Please, change your payment method and try again.”

“Change Payment Method”

 

 

 

141

error.payment.2.100.007

InvalidAmountError

Zero or Invalid Quantity - Represents an error when the amount is zero or not valid

“Payment Failed”

“Something went wrong with this 
payment. Please go back and try again.”

“Go Back and Try Again”

 

 

143

error.payment.4.001.001

AuthenticationError

Authentication error - Represents errors related to security and authentication within the payment system.
Invalid access tokens, and other related security and authentication problems.

“Payment Failed”

“Something went wrong with this 
payment. Please go back and try again.”

“Go Back and Try Again”

 

 

 

 

195

error.payment.4.001.002

ScaAuthenticationError

Requires SCA Authentication -

Represents an error a Strong Customer Authentication error.

SCA (Strong Customer Authentication) is a requirement of the European directive PSD2 (Revised Payment Services Directive) aimed at enhancing the security of online financial transactions

Payment Declined"

“Something went wrong with this 
payment. Please go back and try again.”

“Go Back”

 

 

500, 513, 514, 515, 516, 517, 518, 519, 520, 521, 522, 523, 524, 525, 526, 535, 549 and 1099

error.payment.4.006

ExternalError2

General, unspecified payment error.

“Payment Failed”

“Something went wrong with this 
payment. Please go back and try again.”

“Go Back and Try Again”

506

error.payment.4.006.001

ConfirmationDataNotValidError

Invalid Confirmation Data - Represents an error when confirmation data is not valid

“Payment Failed”

“It seems the system could not validate the data entered. Please go back and try again.”

“Go Back and Try Again”

 

 

 

510

error.payment.4.010.001

RefundNotPossibleError

Return is not possible - Represents an error when the refund is not possible

“Payment Failed”

“Something went wrong with this 
payment. Please go back and try again.”

“Go Back and Try Again”

 

 

 

555

error.payment.4.009.001

CouldNotFindPreviousOperationError

Represents an error when could not find the previous operation

“Payment Failed”

““Something went wrong with this 
payment. Please go back and try again.”

“Go Back and Try Again”

569

error.payment.4.010

OperationDeniedError

Operation Rejected
(Denied by the issuer) - Represents an error when the operation cannot be performed

Payment Declined

“Your payment was declined by your card issuer. Please select another payment method in order to proceed.”

"Change Payment Method”

 

 

 

 

 

1019

error.payment.4.011

TimeOutConnectionError

Request Timed Out - Represents an error when there is a timeout

“Request Timed Out”

“Looks like the server is taking to long to respond, please try again.”

“Go Back and Try Again”

 

 

1026

error.payment.4.006.002

DuplicatedExternalReferenceError

Duplicate external reference - Represents an error when there is a duplicated external reference

“Duplicated Payment”

“Duplicate transaction detected. It seems this payment has already been processed. Please check your order history or try again in a moment.”

“Go Back”

 

 

 

1185, 1186, 1187, 1188, 1189, 1190, 1191

PAYMENT.2.102.004

CardLimitExceededError

 

  • Minimun limit not allowed

  • Maximum limit per transaction not allowed
(Default 1000 Euros)

  • Daily limit not allowed

  • Monthly limit not allowed

  • Max amount (same card / last 24 h.) not allowed

  • Max amount (same card / last 24 h. / same IP address) not allowed

  • Day / IP address limit (all cards) not allowed

Payment Declined"

Your payment was declined due to security reasons. Please review your order and try again.

"Go Back”

1194

PAYMENT.2.100.002

CardTypeNotAllowedError

Card Brand not allowed - Represents an error when the card type (type/brand/etc.) is not allowed for this transaction

“Payment Failed”

“It seems the card type you're using is not supported. Please return and select a different payment method to complete your transaction.”

“Change Payment Method”

 

 

1197

PAYMENT.2.102.005

CardCountryNotAllowed

Represents an error when the card / issuing bank country is not allowed for the transaction

“Payment Declined”

“Unfortunately, payments from different country than card issuer are not allowed on this platform. Please use a card issued in the same country or change your payment method.”

“Change Payment Method”

1254

PAYMENT.4.001.003

CardholderSecurePurchaseKeyError

Attempt to process a secure payment, and the card does not allow it. - Represents an error when there is a commerce with secure cardholder and cardholder without secure purchase key

“Payment Failed”

“The payment couldn’t be processed because your card doesn’t support secure authentication methods. Please go back and try another payment method.”

“Change Payment Method”

 

 

1326

PAYMENT.2.002

FraudError

Represents errors generated when a transaction is suspected of being fraudulent. This class extends `ExternalError` to encapsulate fraud-related issues, including abnormal user behavior, suspicious transaction patterns, and other indicators of potential fraud. It is designed to aid in the identification and management of transactions that may pose a risk to the payment system

Payment Declined

“Your payment was declined due to security reasons. Please select a new payment method and try again.”

"Change Payment Method”

 

 

 

 

 

1327

PAYMENT.2.101.003

ThreeDsChallengeFailedError

Denied by security reasons - Represents an error when the 3DS Challenge failed

Payment Declined"

“Your payment was declined due to security reasons. Please select a new payment method and try again.”

"Change Payment Method”

 

 

 

 

 

 

 




Out-of-scope

It is out of the scope to create the Lokalise key, since the key can be added directly to the Lokalise portal.

For help, there is a list of keys that can be created in the Lokalise portal in the description error table (Lokalise key column).

Potential Challenges

N/A

Cost

Describe any additional cost this solution may imply.

Configuration

For this feature work, need to enable this feature flag: enable-rbi-error-2

Metrics

Delivery Plan

QA Plan

N/A

Call-outs