Error Management in the API Framework

Transact

Error Management

Developer Sandbox Enabled

Understanding API errors is fundamental to any online testing and with Temenos Transact, errors are grouped in the API Framework, then mapped from custom application error codes to standard HTTP error codes, as an output.

When you run into an API error, assuming you are online and authenticated with a valid API key, there are three possible causes:

Transact API errors - something went wrong with Transact and a valid business error is displayed
API Framework errors - something went wrong at the API Framework layer
HTTP status codes - something is wrong with the online resource being used

Temenos API Framework Errors

In the below table, if the ‘Transact Error Message’ column is empty then it is an error raised from the Temenos API Framework layer.

IRIS Error Code	Scenario	HTTP Code	Transact Error Message
TGVCP-001	Unable to get the response from Transact	500
TGVCP-002	Security Violation	403	SECURITY VIOLATION
TGVCP-003	Invalid Query parameters passed	400
TGVCP-006	Query Response Parser Construction Failed/Required parameter missing	500
TGVCP-007	Missing Enquiry/Missing selection	400	MISSING ENQUIRY - / - MANDATORY INPUT
TGVCP-009	Mandatory URL parameters not passed	401
TGVCP-011	Invalid credentials during the sign-on process		INVALID/ NO SIGN-ON NAME SUPPLIED DURING SIGN-ON PROCESS
TGVCP-014	If the Security Context configuration is not set properly	400
TGVCP-017	Duplicate query parameter passed	400

IRIS Error code Mapping

IRIS Error Code	Scenario	HTTP Code	Transact Error Message
TGVCP-001	Unable to get a response from Transact	500
TGVCP-002	Application is not found/Resource not found	404	APPLICATION MISSING/RECORD MISSING
TGVCP-002	Record Not Changed/Security Violation	403	RECORD NOT CHANGED/SECURITY VIOLATION
TGVCP-005	Transfer Already Authorised	400	Transfer Already Authorised
TGVCP-008	Invalid company specified	400	INVALID COMPANY SPECIFIED
TGVCP-009	Mandatory URL parameters not passed/Mandatory parameter missing/transaction id not supplied	404	TRANSACTION ID NOT SUPPLIED
TGVCP-011	Invalid credentials during sign-on process	401	INVALID/ NO SIGN-ON NAME SUPPLIED DURING SIGN-ON PROCESS
TGVCP-012	If the payload sent is not in Application/JSON	400
TGVCP-014	If the Security Context configuration is not set properly	400
T24-001	If a mandatory field is missing	400	Missing field value
T24-002	If a field not found	400	Field not found
T24-003	Version field validation error	400

HTTP Status Codes

Each Transact or API Framework error is finally mapped to the below HTTP status code.

HTTP Code	Use Case
400	Bad Request - Used to indicate nonspecific failure. 400 is the generic client-side error status, used when no other 4xx error code is appropriate.
401	Unauthorized - Must be used when there is a problem with the client’s credentials.
403	Forbidden - Should be used to forbid access regardless of authorization state.
404	Not Found - Must be used when a client’s URI cannot be mapped to a resource
500	Internal Server Error - This is used to indicate an API malfunction

There are no custom error messages that are configured or practised in the API Framework.

If this user guide was useful to you, please let us know using the star rating in the summary box at the top of the page - your feedback is greatly appreciated!