This thread has been locked.

If you have a related question, please click the "Ask a related question" button in the top right corner. The newly created question will be automatically linked to this question.

[FAQ] TI-API: v2 Backlog remittance advice API error codes and meanings (part 1 of 2)

Part Number: TI-API

What do the v2 remittance advice API error codes mean?

  • Scenario Error details Remediation steps
    Invalid JSON payload
    {
    	"errors": [
    		{
    			"errorCode": "ERR-BKG-REMA-API-0002",
    			"type": "ERROR",
    			"reason": "Invalid JSON payload",
    			"message": "JSON payload is not valid. Verify and correct the JSON payload input and resubmit request."
    		}
    	]
    }
    JSON payload is not valid. Enter a valid JSON payload input and resubmit the request. If further assistance is needed, contact TI API Support api-portal.ti.com/support
    Missing JSON payload
    {
    	"errors": [
    		{
    			"errorCode": "ERR-BKG-REMA-API-0003",
    			"type": "ERROR",
    			"reason": "Missing JSON payload",
    			"message": "JSON payload cannot be null or empty. Enter a valid JSON payload and resubmit request."
    		}
    	]
    }
    JSON payload is missing and cannot be null or empty. Enter a valid JSON payload input and resubmit the request. If further assistance is needed, contact TI API Support api-portal.ti.com/support
    Missing CustomerGlobalIdentifier
    {
    	"errors": [
    		{
    			"errorCode": "ERR-BKG-REMA-API-0010",
    			"type": "ERROR",
    			" reason ": "Missing CustomerGlobalIdentifier",
    			"message": "CustomerGlobalIdentifier is required. Contact TI API Support (https://api-portal.ti.com/support) for assistance."
    		}
    	]
    }
    CustomerGlobalIdentifier is required and cannot be null or empty. Contact TI API Support api-portal.ti.com/support for assistance.
    Missing remittanceAdviceNumber
    {
    	"errors": [
    		{
    			"errorCode": "ERR-BKG-REMA-API-0020",
    			"type": "ERROR",
    			" reason ": "Missing remittanceAdviceNumber",
    			"message": " remittanceAdviceNumbercannot be null or empty.  Enter a valid remittanceAdviceNumberand resubmit request."
    		}
    	]
    }
    remittanceAdviceNumber is missing and cannot be null or empty. Enter a valid remittanceAdviceNumber and resubmit the request. If further assistance is needed, contact TI API Support api-portal.ti.com/support
    Invalid remittanceAdviceNumber
    {
    	"errors": [
    		{
    			"errorCode": "ERR-BKG-REMA-API-0021",
    			"type": "ERROR",
    			" reason ": "Invalid remittanceAdviceNumber",
    			"message": "remittanceAdviceNumber cannot exceed 35 characters in length. Enter a valid remittanceAdviceNumber up to 35 characters and resubmit request."
    		}
    	]
    }
    remittanceAdviceNumber exceeds the maximum length of 35 characters. Enter a valid remittanceAdviceNumber that does not exceed 35 characters and resubmit the request. If further assistance is needed, contact TI API Support api-portal.ti.com/support
    Missing payerNumber
    {
    	"errors": [
    		{
    			"errorCode": "ERR-BKG-REMA-API-0050",
    			"type": "ERROR",
    			" reason ": "Missing payerNumber",
    			"message": " payerNumber cannot be null or empty.  Enter a valid payerNumber and resubmit request."
    		}
    	]
    }
    payerNumber is missing and cannot be null or empty. Enter a valid payerNumber and resubmit the request. If further assistance is needed, contact TI API Support api-portal.ti.com/support
    Invalid payerNumber
    {
    	"errors": [
    		{
    			"errorCode": "ERR-BKG-REMA-API-0051",
    			"type": "ERROR",
    			" reason ": "Invalid payerNumber",
    			"message": " payerNumber cannot exceed 35 characters in length. Enter a valid payerNumber up to 35 characters and resubmit request."
    		}
    	]
    }
    payerNumber exceeds the maximum length of 35 characters. Enter a valid payerNumber that does not exceed 35 characters and resubmit the request. If further assistance is needed, contact TI API Support api-portal.ti.com/support
    payerNumber not found
    {
    	"errors": [
    		{
    			"errorCode": "ERR-BKG-REMA-API-0052",
    			"type": "ERROR",
    			" reason ": "payerNumber not found",
    			"message": " payerNumber cannot be located. Verify payerNumber and resubmit request."
    		}
    	]
    }
    payerNumber cannot be found. Enter a valid payerNumber and resubmit the request. If further assistance is needed, contact TI API Support api-portal.ti.com/support
    Missing totalPaymentAmount
    {
    	"errors": [
    		{
    			"errorCode": "ERR-BKG-REMA-API-0060",
    			"type": "ERROR",
    			" reason ": "Missing totalPaymentAmount",
    			"message": " totalPaymentAmount cannot be null or empty.  Enter a valid totalPaymentAmount and resubmit request."
    		}
    	]
    }
    totalPaymentAmount is missing and cannot be null or empty. Enter a valid totalPaymentAmount and resubmit the request. If further assistance is needed, contact TI API Support api-portal.ti.com/support
    Invalid totalPaymentAmount
    {
    	"errors": [
    		{
    			"errorCode": "ERR-BKG-REMA-API-0070",
    			"type": "ERROR",
    			" reason ": "Invalid totalPaymentAmount ",
    			"message": " totalPaymentAmount cannot exceed 15 characters in length. Enter a valid totalPaymentAmount up to 15 characters and resubmit the request."
    		}
    	]
    }
    totalPaymentAmount exceeds the maximum length of 15 characters. Enter a valid totalPaymentAmount that does not exceed 15 characters and resubmit the request. If further assistance is needed, contact TI API Support api-portal.ti.com/support
    Invalid totalPaymentAmount
    {
    	"errors": [
    		{
    			"errorCode": "ERR-BKG-REMA-API-0080",
    			"type": "ERROR",
    			" reason ": "Invalid totalPaymentAmount",
    			"message": " totalPaymentAmount does not have a valid number format and must be a number. Enter totalPaymentAmount as a numeric value and resubmit request."
    		}
    	]
    }
    totalPaymentAmount has an invalid number format. Enter the totalPaymentAmount as a numeric value and resubmit the request. If further assistance is needed, contact TI API Support api-portal.ti.com/support
    Missing currencyCode
    {
    	"errors": [
    		{
    			"errorCode": "ERR-BKG-REMA-API-0090",
    			"type": "ERROR",
    			" reason ": "Missing currencyCode",
    			"message": "currencyCode cannot be null or empty.  Enter a valid currencyCode and resubmit request."
    		}
    	]
    }
    currencyCode is missing and cannot be null or empty. Enter a valid currencyCode and resubmit the request. If further assistance is needed, contact TI API Support api-portal.ti.com/support
    Invalid currencyCode
    {
    	"errors": [
    		{
    			"errorCode": "ERR-BKG-REMA-API-0091",
    			"type": "ERROR",
    			" reason ": "Invalid currencyCode",
    			"message": " currencyCode cannot exceed 5 characters in length. Enter a valid currencyCode up to 5 characters and resubmit request."
    		}
    	]
    }
    currencyCode exceeds the maximum length of 5 characters. Enter a valid currencyCode that does not exceed 5 characters and resubmit the request. If further assistance is needed, contact TI API Support api-portal.ti.com/support
    Missing paymentAmount
    {
    	"errors": [
    		{
    			"errorCode": "ERR-BKG-REMA-API-0100",
    			"type": "ERROR",
    			" reason ": "Missing paymentAmount",
    			"message": " paymentAmount cannot be null or empty.  Enter a valid paymentAmount and resubmit request."
    		}
    	]
    }
    paymentAmount is missing and cannot be null or empty. Enter a valid paymentAmount and resubmit the request. If further assistance is needed, contact TI API Support api-portal.ti.com/support
    Invalid paymentAmount
    {
    	"errors": [
    		{
    			"errorCode": "ERR-BKG-REMA-API-0101",
    			"type": "ERROR",
    			" reason ": "Invalid paymentAmount",
    			"message": " paymentAmount cannot exceed 15 characters in length. Enter a valid paymentAmount up to 15 characters and resubmit request."
    		}
    	]
    }
    paymentAmount exceeds the maximum length of 15 characters. Enter a valid paymentAmount that does not exceed 15 characters and resubmit the request. If further assistance is needed, contact TI API Support api-portal.ti.com/support
    Invalid paymentAmount
    {
    	"errors": [
    		{
    			"errorCode": "ERR-BKG-REMA-API-0102",
    			"type": "ERROR",
    			" reason ": "Invalid paymentAmount",
    			"message": " paymentAmount does not have a valid number format and must be a number. Verify and correct paymentAmount and resubmit request."
    		}
    	]
    }
    paymentAmount has an invalid number format. Enter the paymentAmount as a numeric value and resubmit the request. If further assistance is needed, contact TI API Support api-portal.ti.com/support
    Missing financialDocumentNumber
    {
    	"errors": [
    		{
    			"errorCode": "ERR-BKG-REMA-API-0110",
    			"type": "ERROR",
    			" reason ": "Missing financialDocumentNumber",
    			"message": " financialDocumentNumber cannot be null or empty.  Enter either a valid financialDocumentNumber and resubmit request."
    		}
    	]
    }
    financialDocumentNumber is missing and cannot be null or empty. Enter a valid financialDocumentNumber and resubmit the request. If further assistance is needed, contact TI API Support api-portal.ti.com/support
    Invalid financialDocumentNumber
    {
    	"errors": [
    		{
    			"errorCode": "ERR-BKG-REMA-API-0111",
    			"type": "ERROR",
    			" reason ": "Invalid financialDocumentNumber",
    			"message": "financialDocumentNumber cannot exceed 10 characters in length. Enter a valid financialDocumentNumber up to 10 characters and resubmit request."
    		}
    	]
    }
    financialDocumentNumber exceeds the maximum length of 10 characters. Enter a valid financialDocumentNumber that does not exceed 10 characters and resubmit the request. If further assistance is needed, contact TI API Support api-portal.ti.com/support
    Invalid customerFinancialDocumentNumber
    {
    	"errors": [
    		{
    			"errorCode": "ERR-BKG-REMA-API-0160",
    			"type": "ERROR",
    			" reason ": "Invalid customerFinancialDocumentNumber",
    			"message": " customerFinancialDocumentNumber cannot exceed 16 characters in length. Enter a valid customerFinancialDocumentNumber up to 16 characters and resubmit request."
    		}
    	]
    }
    customerFinancialDocumentNumber exceeds the maximum length of 16 characters. Enter a valid customerFinancialDocumentNumber that does not exceed 16 characters and resubmit the request. If further assistance is needed, contact TI API Support api-portal.ti.com/support
    TI API system error occurred
    {
    	"errors": [
    		{
    			"errorCode": "ERR-BKG-REMA-API-0500",
    			"type": "ERROR",
    			" reason ": "TI API system error occurred",
    			"message": "System error occurred. Execution ID: execution-... Contact TI API Support (https://api-portal.ti.com/support) with execution ID."
    		}
    	]
    }
    A system error occurred. Contact TI API Support api-portal.ti.com/support and provide execution ID.
    TI API unavailable for scheduled system maintenance
    {
    	"errors": [
    		{
    			"errorCode": "ERR-BKG-REMA-API-0510",
    			"type": "ERROR",
    			" reason ": "TI API unavailable for scheduled system maintenance",
    			"message": "This TI API is currently unavailable between $OutageStart and $OutageEnd $timeZoneStr for scheduled system maintenance. Resubmit request after maintenance has ended."
    		}
    	]
    }
    The TI API system is currently unavailable due to scheduled maintenance. Re-submit the request after the maintenance has ended. If after the schedule maintenance has ended and issues are still encountered, contact TI API Support api-portal.ti.com/support
    Invalid totalPaymentAmount
    {
    	"errors": [
    		{
    			"errorCode": "ERR-BKG-REMA-API-0511",
    			"type": "ERROR",
    			" reason ": "Invalid totalPaymentAmount",
    			"message": " totalPaymentAmount cannot be less than $0.   Enter a valid totalPaymentAmount and resubmit request."
    		}
    	]
    }
    totalPaymentAmount must be $0 or greater. Enter a valid totalPaymentAmount and resubmit the request. If further assistance is needed, contact TI API Support api-portal.ti.com/support

    {}

    View v2 Backlog remittance API error codes and meanings (part 2 of 2)

**Attention** This is a public forum