Normalized Payment Record

The normalized payment record is a list of fields that are received from, and returned to, the client. These fields make up a transaction. Clients, such as the Gateway, can optionally send and receive normalized payment record fields. The client is not required to fill in all of the fields, only the subset necessary to process the transaction record.

Several of the node types are set up to use these fields. All of the payment validation rule (PVR) nodes require their usage (see Payment Validation Rules).

The data type for each field is listed in Table 1. It is required for them to be in the format shown. The Business Rules framework does not care which fields are sent, nor does it validity check those fields which are sent.

At the end of the decision workflow, the data fields are checked for any changes. A list of the changes are returned for possible review. It does not check any field for validity or track a missing field and tag that as an error. The ibmNprRepairable field is an exception to this.

If ibmNprRepairable is not set on the current condition, the Business Rules Server sets it. If the ibmValidationError is 1, the ibmNprRepairable flag is set to yes. If the ibmValidationError is 0, the ibmNprRepairable flag is set to no. For more information, see Payment Repair User's Guide.

Table 1. Normalized Payment Record Fields
Field Name Data Type Range of Values
ibmNprAmount char  
ibmNprPc char  
ibmNprAccount char  
ibmNprField4 char  
ibmNprRT char  
ibmNprExtProcCode char  
ibmNprAuxOnUs char  
ibmNprField8 byte  
ibmNprField9 byte  
ibmNprField10 byte  
ibmNprField11 byte  
ibmNprField12 byte  
ibmNprField13 byte  
ibmNprField14 byte  
ibmNprField15 byte  
ibmNprValidAmount byte 0, 1 (1 - is valid)
ibmNprValidPc byte 0, 1
ibmNprValidAccount byte 0, 1
ibmNprValidField4 byte 0, 1
ibmNprValidRT byte 0, 1
ibmNprValidExtProcCode byte 0, 1
ibmNprValidSerialNum byte 0, 1
ibmNprValidField8 byte 0, 1
ibmNprValidField9 byte 0, 1
ibmNprValidField10 byte 0, 1
ibmNprValidField11 byte 0, 1
ibmNprValidField12 byte 0, 1
ibmNprValidField13 byte 0, 1
ibmNprValidField14 byte 0, 1
ibmNprValidField15 byte 0, 1
ibmNprBdSite char  
ibmNprBdDate char  
ibmNprBdCategory char  
ibmNprSettlementDate char  
ibmNprRecordId byte 0 - 255
ibmNprRecordType byte 244–247
ibmNprReturnReason char  
ibmNprOnUsFlag char N, Y (Y - On-us)
ibmNprEndpoint char  
ibmNprEndpointType byte  
ibmNprClearingChannel byte 0 - 9
ibmNprPocket byte 0 (reject), 1 - X
ibmNprCredit char N, Y (N-Debit)
ibmNprValidationError byte 0, 1
ibmNprControlDoc char N, Y (Y-Control document)
ibmNprCurrencyCode char USD, CAD
ibmNprImageSuspect char N, Y (Y-Has image suspect)
ibmNprImageReviewable char N, Y (Y-is Reviewable)
ibmNprRepairable char N, Y (Y-is Repairable)
ibmNprAutoCorrected char N, Y, ‘ ’ (‘ ’-not attempted)
ibmNprOcrAmount char  
ibmNprOcrPc char  
ibmNprOcrAccount char  
ibmNprOcrField4 char  
ibmNprOcrRT char  
ibmNprOcrExtProcCode char  
ibmNprOcrAuxOnUs char  
ibmNprOriginalEndpoint char  
ibmNprOcrMatchedAmount char  
ibmNprOcrMatchedPc char  
ibmNprOcrMatchedAccount char  
ibmNprOcrMatchedField4 char  
ibmNprOcrMatchedRT char  
ibmNprOcrMatchedExtProcCode char  
ibmNprOcrMatchedAuxOnUs char  
ibmNprImgCompFailedTIFF char  
ibmNprImgCompFailedIQA char  
ibmNprImgCompFailedIIA char  
ibmNprAccumId char  
ibmNprCreditAvailDays byte  
ibmNprCreditAvailDate char  
ibmNprDebitAvailDays byte  
ibmNprItemDeposBillingCode char  
ibmNprItemPresBillingCode char  
ibmNprBofdRT char  
ibmNprBofdBdDate char  
ibmNprBofdSeqNum char  
ibmNprBofdValidRT char  
ibmNprBofdValidBdDate char  
ibmNprBofdValidSeqNum char  
ibmNprTransmissionDefld byte  
Note: Field names are case sensitive.