Return codes and error messages

mPAY24 provides within each operation response the status and returnCode element.

status

The status element specifies if the operation itself was successful or not. It does not specify if the transaction was successful or not.

Status	Description
`OK`	The operation was ok (no error occurred).
`ERROR`	The operation was not ok (see `returnCode` for more information).

returnCode

The following list contains a short description of the currently returned values of
returnCode. Additionally some codes are described in detailed afterwards. The list can
be extended by mPAY24 at any time.

Nr.	ReturnCode	Description
0	`OK`	The transaction was ok (no error occurred).
1	`DECLINED`	The transaction was declined by the external payment interface.
2	`BLOCKED`	The transaction was blocked.
3	`ACCESS_DENIED`	The merchant’s IP address is not white listed.
4	`MERCHANT_LOCKED`	The merchant id is locked.
5	`PAYMENT_METHOD_NOT_ACTIVE`	The desired payment system is not active.
6	`<parameter>_NOT_ENTERED`	A mandatory parameter is missing.
7	`<parameter>_NOT_CORRECT`	The parameter supplied is not valid.
8	`OPERATION_NOT_SUPPORTED`	The operation is not supported.
9	`PTYPE_MISMATCH`	The payment method mismatches.
10	`NOT_FOUND`	The transaction was not found.
11	`ALREADY_PROCESSED`	The transaction has been processed and can not be processed again.
12	`CACHE_DATA_EXPIRED`	The temporary cache data are invalid due to expiration.
13	`INVALID_MDXI`	The MDXI XML stream could not be validated.
14	`INVALID_PRICE` \ `INVALID_AMOUNT`	The parameter `price` \ `amount` holds invalid values.
15	`INVALID_CREDITCARD_NUMBER`	The credit card number is not plausible.
16	`INVALID_MAESTRO_NUMBER`	The Maestro card number is not plausible.
17	`INVALID_IBAN`	The provided IBAN is not plausible.
20	`PROFILE_NOT_FOUND`	mPAY24 payment profile could not be found.
21	`PROFILE_NOT_SUPPORTED`	mPAY24 Profile is not activated.
22	`PROFILE_FLEX_NOT_SUPPORTED`	mPAY24 Profile FLEX is not activated.
23	`PROFILE_COUNT_EXCEEDED`	The maximum number of payment profiles of a customer is reached.
30	`TOKEN_NOT_FOUND`	The token has not been found or has already been used.
31	`TOKEN_NOT_VALID`	The token is invalid due to missing or incorrect data.
32	`TOKEN_EXPIRED`	The token has not been used and is expired.
33	`TOKEN_ENCRYPTION_FAILURE`	The token data could not be encrypted.
34	`TOKEN_DECRYPTION_FAILURE`	The token data could not be decrypted.
40	`WITHDRAW_NOT_ALLOWED`	Withdraw operation is not allowed for the merchant.
50	`TRANSACTION_ALREADY_CLEARED`	The transaction has already been cleared.
60	`CREDIT_LIMIT_EXCEEDED`	The total amount of all credits exceeds the clearing amount.
61	`CLEARING_LIMIT_EXCEEDED`	The total amount of all clearing exceeds the reservation amount.
99	`INTERNAL_ERROR`	An error during the communication occurred.
100	`EXTERNAL_ERROR`	The external payment interface returned an error.

`OK`

The returnCode OK indicates that a operation was processed. It does not specifies the
transactions state. If the returnCode OK was returned, the transaction state is either
additionally specified or can be received via the Confirmation Interface.

Special scenario with profiles

If a profile is created or updated during a payment process, following ReturnCodes are possible:

Status	ReturnCode	Description
`OK`	`PROFILE_CREATED`	The transaction was ok and the profile created
`OK`	`PROFILE_UPDATED`	The transaction was ok and the profile updated
`OK`	`PROFILE_ERROR`	The transaction was ok but the profile was not stored/updated

`DECLINED`

The transaction was declined by the specific external payment interface and can not be
processed any more. No technical problem occurred during the transaction.

The merchant should advise the customer to refer to his issuer about the reason of the
failure.

`INTERNAL_ERROR`

An error during the communication occurred. The operation was not successful and in most
cases the transaction has not been processed. For further questions about a transaction
with returnCode INTERNAL_ERROR contact the mPAY24 support.

📘
This error is also returned if the external payment interface returns an
incorrect or unknown error code.

`EXTERNAL_ERROR`

An error occurred while processing through the external payment interface and a correct
error code was returned by this interface. The operation was not successful and the
transaction has not been processed.

The return value errText may contain additional information supplied by the external
payment interface if a public error code (or message) was defined by the interface. If
possible, the error message is returned in the language defined upon request (default: DE).

In case of a non public error code as defined by the external payment interface, a general
message will be provided, since the merchant or respectively the customer is not allowed
to be notified about the reason of the error.