Return Codes
Default API Event Codes
| Event Code | Name | HTTP Response |
Description |
|---|---|---|---|
| EC000_001 | Internal Server Error | 500 | Internal Server Error, please contact support. |
| EC000_002 | Unauthorized | 401 | The request is not authorized |
| EC000_003 | Validation Failure | 400 | The request failed validation |
| EC000_004 | Resource Not Found | 404 | The requested resource is not found |
| EC000_005 | Method Not Allowed | 405 | The requested HTTP method is not allowed |
| EC000_006 | Unsupported Media Type | 405 | Content-Type provided is not supported |
| EC000_007 | Invalid Content | 400 | Invalid secured payload |
Payment Event Codes
Validation failures relating to payment submissions. The codes and status are returned in a Payment Status response message.
Event Code Ranges
| Range Start | Range End | Usage |
|---|---|---|
| EC004_101 | EC004_199 | Group level error |
| EC004_201 | EC004_299 | Payment level error |
| EC004_301 | EC004_399 | Transaction level error |
Payment Event Code List
| Event Code | Status Code | Status Reason Code | Status Reason Code Description | Error Description |
|---|---|---|---|---|
| RJCT | NARR | Narrative | Reason is provided as narrative information in the additional reason information. Generic error which will be returned where no external reason code is available. For rejections from downstream applications additional_information will contain proprietary rejection code and reason in format: (<rejection code>) <rejection reason> I.e “(1234) Insufficient funds” |
|
| EC004_101 | RJCT | TD03 | InvalidPayment | Schema validation failed against the payment schema, error details [Missing or invalid X-Message-Id] |
| EC004_102 | RJCT | TD03 | DuplicatePayment | Duplicate payment received (supplied X-Message-Id value: [X-Message-Id] |
| EC004_103 | RJCT | TD03 | CryptoFailure | Failed to decrypt and verify the message |
| EC004_104 | RJCT | TD03 | SchemaValidation | Schema validation failed against the payment schema, error details [{errorDetail}] |
| EC004_105 | RJCT | DT02 | PaymentProcessingFailed | Payment processing failed, please re-submit and try again |
| EC004_106 | RJCT | DT02 | InvalidCreationDate | creation_date_time is too far in the past (greater than 24 hours), or in the future |
| EC004_107 | RJCT | BC01 | InvalidPaymentInformationCount | The number of payment_information elements should not be more than 1 per request |
| EC004_108 | RJCT | AM10 | InvalidControlSum | Sum of instructed amounts does not equal the control sum. |
| EC004_109 | RJCT | AM18 | InvalidNumberOfTransactions | Number of transactions is invalid or missing. |
| EC004_110 | RJCT | TD03 | SchemaValidation | Echo any parser error message. I.e. Property with the name ‘<json key>’ already exists in the current JSON object. Path ‘<json key>’, line <#>, position <#>. Property with the name ‘payment_information’ already exists in the current JSON object. Path ‘payment_information’, line 32, position 30. |
| EC004_158 | RJCT | BE16 | InvalidDebtorIdentificationCode | Where: Payment Type is CBFT Do a check on debtor_account_identification to determine if it’s AU domestic (CACHE) or FX (MIDANZ) MIDANZ pattern: [0-9]{6}[A-Z]{3}[0-9]{5} (i.e 123456USD00001) Cache pattern: [0-9]{15} (i.e 012123999999999) Error Message: Invalid Debtor Identification Code |
| EC004_159 | RJCT | AM10 | InvalidControlSum | Where: Payment Type is CBFT Sum of amounts(instructed and equivalent) does not equal the control sum. Error Message: Invalid Control Sum |
| EC004_201 | RJCT | AC02 | InvalidDebtorAccountNumber | Where: {max_account_length} = Integer. Maximum length allowed for account number for country/ payment type Error Message: Debtor Account Number format is invalid for country and payment type. Value exceeds maximum length of {max_account_length} (supplied value: [{debtor_account_identification}]) |
| EC004_202 | RJCT | TC01 | InvalidTransactionCount | The number of credit_transfer_transaction_information elements should not be more than 1000 per payment_information element |
| EC004_203 | RJCT | AM03 | NotAllowedCurrency | Where: {currency} = List of values provided against instructed_amount.currency Error Message: Payment type only allows for single currency in batch. Provided currencies: [{currency}] |
| EC004_204 | RJCT | DU02 | DuplicatePaymentInformationID | Payment Information ID must be unique per payment (supplied value: [{payment_information_identification}]) |
| EC004_205 | RJCT | CH16 | ElementContentFormallyIncorrect | Where: {max_length} = Maximum allowed length for payment type Error Message: Payment Information ID exceeds maximum allowed length for country and payment type. Value exceeds maximum length of {max_length} (supplied value: [{payment_information_identification}]) |
| EC004_301 | RJCT | AC03 | CreditorAccountRule | creditor_account_proxy is invalid for CountryCode: [{countryCode}] and PaymentType: [{paymentType}] |
| EC004_302 | RJCT | AM03 | NotAllowedCurrency | Where: {allowed currencies} = an array of currency codes valid for the country/ payment type {currency} = value of instructed_amount.currency Error Message: “Invalid currency for payment type. Instructed amount currency must be one of [{allowed currencies}] (supplied value: \[{currency}\])” |
| EC004_303 | RJCT | DU05 | DuplicateInstructionID | Instruction ID must be unique within a batch (supplied value: [{instruction_identification}]) |
| EC004_304 | RJCT | AC03 | InvalidCreditorAccountNumber | Either creditor_account_identification or creditor_account_proxy may be present, but not both |
| EC004_305 | RJCT | CH16 | ElementContentFormallyIncorrect | Where: {max_length} = Maximum allowed length for payment type Error Message: Instruction Identification exceeds maximum allowed length for country and payment type. Value exceeds maximum length of {max_length} (supplied value: [{instruction_identification}]) |
| EC004_306 | RJCT | BE22 | MissingCreditorName | Where: {creditor_name} = not present Error Message: Creditor name is missing |
| EC004_307 | RJCT | MS06 | MissingAmount | Where: PaymentType is CBFT and {instructed_amount} = Not present Or {equivalent_amount} = Not present Error Message: Amount is missing |
| EC004_308 | RJCT | BE19 | InvalidChargeBearerCode | Where: PaymentType is CBFT and {charge_bearer} = Not present Error Message: Invalid Charge Bearer Code |
NPP Event Codes
Below event codes are used to indicate Payment validation failures. The codes and status are returned in a Payment Status response message
| Event Code | transaction_ status |
transaction_status_ reason_code |
transaction_status_ description |
Description |
|---|---|---|---|---|
| EC004_001 | RJCT | TD03 | EC004_001-InvalidPayment | Schema validation failed against the payment schema, error details [Missing or invalid X-Message-Id] |
| EC004_002 | RJCT | TD03 | EC004_002-DuplicatePayment | Duplicate payment received (supplied X-Message-Id value: [X-Message-Id] |
| EC004_003 | RJCT | TD03 | EC004_003-InvalidPayment | Schema validation failed against the payment schema, error details [{errorDetail}] |
| EC004_004 | RJCT | TD03 | EC004_004-CryptoFailure | Failed to decrypt and verify the message |
| EC004_005 | RJCT | TD03 | EC004_005-SchemaValidation | Schema validation failed against the payment schema, PaymentSubmissionResource |
| EC004_006 | RJCT | AC03 | EC004_006-CreditorAccountRule | /CreditorAliasValue or /CreditorAccountIdentification must be present |
| EC004_007 | RJCT | AC03 | EC004_007-CreditorAccountRule | If /CreditorAccountType is present then /CreditorAccountIdentification must be present |
| EC004_008 | RJCT | AC03 | EC004_008-CreditorAccountRule | If /CreditorAliasType is present then /CreditorAliasValue must be present |
| EC004_009 | RJCT | AC13 | EC004_009-DebtorAccountRule | /DebtorAccountType AND /DebtorAccountIdentification must be present |
| EC004_010 | RJCT | DT02 | EC004_010-CreationDateRule | Creation date and time (UTC) is too far in the past (greater than 24 hours), or is future dated |
| EC004_011 | RJCT | DT01 | EC004_011-RequestedDateRule | Requested Execution Date is in the past or invalid |
| EC004_012 | RJCT | DT01 | EC004_012-RequestedDateRule | Requested Execution Date is in the future or invalid |
| EC004_013 | RJCT | AM12 | EC004_013-InstructedAmountRule | Amount field does not match a two decimal place format. |
| EC004_014 | RJCT | AM06 | EC004_014-TooLowAmount | Instructed amount must be equal or greater than $0.01 |
| EC004_015 | RJCT | AM03 | EC004_015-CurrencyRule | Instructed amount must be in AUD |
| EC004_016 | RJCT | AC02 | EC004_016-InvalidDebtorAccountNumber | Account numbers for NPP can only contain numeric values |
| EC004_017 | RJCT | AC08 | EC004_017-InvalidBranchCode | Debtor BSB must be a minimum of 6 numeric digits, including leading zeroes |
| EC004_018 | RJCT | AC03 | EC004_018-InvalidCreditorAccountNumber | Account numbers for NPP can only contain numeric values |
| EC004_019 | RJCT | AC08 | EC004_019-InvalidBranchCode | Creditor BSB must be a minimum of 6 numeric digits, including leading zeroes |
| EC004_020 | RJCT | AC14 | EC004_020-InvalidCreditorAccountType | Valid values are: AIIN and BBAN |
| EC004_021 | RJCT | AC13 | EC004_021-InvalidDebtorAccountType | Valid values are: AIIN and BBAN |
| EC004_022 | RJCT | AC13 | EC004_022-InvalidEndToEndId | EndToEnd Identification is missing or invalid |
| EC004_023 | RJCT | FF04 | EC004_023-InvalidServiceLevelCode | Service Level must be npp.clear.01-x2p1 |
| EC004_024 | RJCT | DT02 | EC004_024-InvalidCreationDate | Creation date must be of ISODateTime format (UTC Expressed: YYYY-MM-DDThh:mm:ss.sssZ) |
| EC004_026 | RJCT | DT02 | EC004_026-PaymentProcessingFailed | Payment processing failed, please re-submit and try again |
| EC004_027 | RJCT | DT02 | EC004_027-InvalidAlias | Alias value is invalid as per Alias Type. |