Jump to

• Request
• Response

Get Payment Event

get

https://server:port/spl/rest/apis/customer/financials/paymentEvents/{paymentEventId}

Request

Path Parameters

• paymentEventId(required): string

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : C1-PayEvent

Type: object

Show Source

• _self: string
  _self
• account: object account
• account2: object account2
• account3: object account3
• accountNumber: string
  Maximum Length: 50

  Account Number
• accountT: object accountT
• bank: string
  Maximum Length: 5

  Define the Bank Code and Bank Account into which the tender source's funds will be deposited. The bank account defines the distribution code used to build the General Ledger details for the payment.
• cancelReason: object cancelReason
• canDistribute: boolean
  Defining Distribute as true distributes all Incomplete, Error, or Freezable payments linked to the event.

  Example: false
• characteristics: object characteristics
• characteristicValueDescription: string
  Maximum Length: 60

  Char Value Description
• characteristicValueForeignKeyInformation: string
  Maximum Length: 254

  Characteristic Value Foreign Key Information
• characteristicValueForeignKeys: string
  Maximum Length: 254

  Characteristic Value Foreign Keys
• charateristicValue: string
  Maximum Length: 150

  Characteristic Value Indicates the value of the characteristic.
• creationDateTime: string (date-time)
  Create Date/Time
• currency: object currency
• description: string
  Maximum Length: 60

  Description
• document: object document
• entityName2: string
  Maximum Length: 254

  Name
• exceptions: object exceptions
• hasTransfer: boolean
  The Transfer button is enabled if: There is a single non-cancelled tender linked to the event AND There is a single frozen payment linked to the event AND The account on the tender is the same as the account on the payment.

  Example: false
• isNonCisAccount: boolean
  Non CIS Switch is defined as true if the payment is linked to an Account ID that belongs to a customer class that is used for non-CIS payments.
• matchType: string
  Maximum Length: 8

  Match Type and Match Value should only be used if either of the following conditions is true: This Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment. The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of "service agreement ID" and a Match Value of the respective service agreement ID.

  Example: BILL-ID (Bill ID / Sequential Bill Number)
• matchValue: string
  Maximum Length: 30

  Match Type and Match Value should only be used if either of the following conditions is true: This Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment. The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of "service agreement ID" and a Match Value of the respective service agreement ID.

  Example: 995516242555
• nonCisComments: string
  Maximum Length: 254

  Non CIS Comments
• nonCisName: string
  Maximum Length: 50

  Non CIS Name
• nonCisSaId: string
  Maximum Length: 10

  Non CIS Service Agreement ID for account that belongs to a customer class that is used for non-CIS payments.
• numberOfPayments: number
  Minimum Value: 0

  Maximum Value: 9.99999999999999E14

  Payment Number
• numberOfTenders: number
  Minimum Value: 0

  Maximum Value: 9.99999999999999E14

  Tender Number
• payEventAlternateCurrency: object payEventAlternateCurrency
• paymentAmount: number
  Payment Amount
• paymentDate: string (date)
  Payment Date is the business date associated with the payment event.
• paymentEventException: string
  Maximum Length: 254

  Message
• paymentEventId: string
  Maximum Length: 12

  Payment Event ID is the system-assigned unique identifier of the payment event.

  Example: 317772795000
• paymentEventId2: string
  Maximum Length: 30

  Payment Event ID is the system-assigned unique identifier of the payment event.

  Example: 755669969777
• payments: object payments
• paymentTemplate: string
  Maximum Length: 12

  Payment Templates can be configured for common types of payment allocations to pre-populate the payment distribution and allowing non-CIS payments to be directly allocated against distribution codes.
• paymentTenders: object paymentTenders
• paymentTotalAmount: number
  Payment Total Amount
• payorAccount: object payorAccount
• referenceNumber: string
  Maximum Length: 30

  Reference Number
• shouldAllPaymentsFreeze: boolean
  Defining Freeze as true causes all Freezable payments linked to the event to become frozen.

  Example: false
• shouldOverrideTenderAuthorization: boolean
  The Authorization Override checkbox is only displayed if the tender type selected requires authorization. Use the Authorization override checkbox to indicate whether or not tender authorization should take place. If Authorization override is checked, an authorization code must be entered and the system bypasses the authorization web service call.
• tenderAuthorizationCode: string
  Maximum Length: 60

  If authorization override is checked, an authorization code must be entered and the system bypasses the authorization web service call.
• tenderReversal: string
  Maximum Length: 10

  Tender Reversal Code
• tenderSource: string
  Maximum Length: 8

  Tender Source is the source of the tenders. For example, cash drawer 22, lockbox 1 at Bank of America.

  Example: ACH (Auto pay)
• tenderTotalAmount: number
  Tender Amount contains the amount of the tender.
• tenderType: object tenderType
• totTenderAmt: number
  Total Tender Amount is the total amount of all tenders linked to the tender control.
• transferNonCISComment: string
  Maximum Length: 254

  Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments. Non CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments.
• transferNonCisName: string
  Maximum Length: 50

  Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments. Non CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments.
• transferNonCisReferenceNumber: string
  Maximum Length: 30

  Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments. Non CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments.
• user: object user
  USER ID
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "_self":{
            "type":"string",
            "description":"_self"
        },
        "paymentEventId":{
            "type":"string",
            "maxLength":12,
            "description":"Payment Event ID is the system-assigned unique identifier of the payment event.",
            "example":"317772795000"
        },
        "payorAccount":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "payorAccountId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Account ID"
                }
            }
        },
        "matchType":{
            "type":"string",
            "maxLength":8,
            "description":"Match Type and Match Value should only be used if either of the following conditions is true:\n\n        This Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment. \n        The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of \"service agreement ID\" and a Match Value of the respective service agreement ID.",
            "example":"BILL-ID\n\n(Bill ID / Sequential Bill Number)"
        },
        "matchValue":{
            "type":"string",
            "maxLength":30,
            "description":"Match Type and Match Value should only be used if either of the following conditions is true:\n\n        This Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment. \n        The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of \"service agreement ID\" and a Match Value of the respective service agreement ID.",
            "example":"995516242555"
        },
        "paymentAmount":{
            "type":"number",
            "description":"Payment Amount"
        },
        "totTenderAmt":{
            "type":"number",
            "description":"Total Tender Amount is the total amount of all tenders linked to the tender control."
        },
        "nonCisName":{
            "type":"string",
            "maxLength":50,
            "description":"Non CIS Name"
        },
        "referenceNumber":{
            "type":"string",
            "maxLength":30,
            "description":"Reference Number"
        },
        "nonCisComments":{
            "type":"string",
            "maxLength":254,
            "description":"Non CIS Comments"
        },
        "isNonCisAccount":{
            "type":"boolean",
            "description":"Non CIS Switch is defined as true if the payment is linked to an Account ID that belongs to a customer class that is used for non-CIS payments."
        },
        "nonCisSaId":{
            "type":"string",
            "maxLength":10,
            "description":"Non CIS Service Agreement ID for account that belongs to a customer class that is used for non-CIS payments."
        },
        "paymentTemplate":{
            "type":"string",
            "maxLength":12,
            "description":"Payment Templates can be configured for common types of payment allocations to pre-populate the payment distribution and allowing non-CIS payments to be directly allocated against distribution codes."
        },
        "bank":{
            "type":"string",
            "maxLength":5,
            "description":"Define the Bank Code and Bank Account into which the tender source's funds will be deposited. The bank account defines the distribution code used to build the General Ledger details for the payment."
        },
        "tenderSource":{
            "type":"string",
            "maxLength":8,
            "description":"Tender Source is the source of the tenders. For example, cash drawer 22, lockbox 1 at Bank of America.",
            "example":"ACH \n\n(Auto pay)"
        },
        "shouldOverrideTenderAuthorization":{
            "type":"boolean",
            "description":"The Authorization Override checkbox is only displayed if the tender type selected requires authorization. Use the Authorization override checkbox to indicate whether or not tender authorization should take place. If Authorization override is checked, an authorization code must be entered and the system bypasses the authorization web service call."
        },
        "tenderAuthorizationCode":{
            "type":"string",
            "maxLength":60,
            "description":"If authorization override is checked, an authorization code must be entered and the system bypasses the authorization web service call."
        },
        "tenderReversal":{
            "type":"string",
            "maxLength":10,
            "description":"Tender Reversal Code"
        },
        "payEventAlternateCurrency":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "payEventAlternateCurrency":{
                    "type":"string",
                    "maxLength":1,
                    "description":"Pay Event Alternate Currency Info"
                }
            }
        },
        "account":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "accountId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Account ID"
                }
            }
        },
        "transferNonCisName":{
            "type":"string",
            "maxLength":50,
            "description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments."
        },
        "transferNonCisReferenceNumber":{
            "type":"string",
            "maxLength":30,
            "description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments."
        },
        "transferNonCISComment":{
            "type":"string",
            "maxLength":254,
            "description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments."
        },
        "cancelReason":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "cancelReason":{
                    "type":"string",
                    "maxLength":4,
                    "description":"Cancel Reason"
                }
            }
        },
        "paymentTotalAmount":{
            "type":"number",
            "description":"Payment Total Amount"
        },
        "tenderTotalAmount":{
            "type":"number",
            "description":"Tender Amount contains the amount of the tender."
        },
        "numberOfPayments":{
            "type":"number",
            "maximum":9.99999999999999E14,
            "minimum":0,
            "description":"Payment Number"
        },
        "numberOfTenders":{
            "type":"number",
            "maximum":9.99999999999999E14,
            "minimum":0,
            "description":"Tender Number"
        },
        "currency":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "currency":{
                    "type":"string",
                    "maxLength":3,
                    "description":"Currency Code"
                }
            }
        },
        "characteristicValueDescription":{
            "type":"string",
            "maxLength":60,
            "description":"Char Value Description"
        },
        "characteristicValueForeignKeys":{
            "type":"string",
            "maxLength":254,
            "description":"Characteristic Value Foreign Keys"
        },
        "characteristicValueForeignKeyInformation":{
            "type":"string",
            "maxLength":254,
            "description":"Characteristic Value Foreign Key Information"
        },
        "charateristicValue":{
            "type":"string",
            "maxLength":150,
            "description":"Characteristic Value Indicates the value of the characteristic."
        },
        "user":{
            "type":"object",
            "description":"USER ID",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "user":{
                    "type":"string",
                    "maxLength":8,
                    "description":"USER ID"
                }
            }
        },
        "description":{
            "type":"string",
            "maxLength":60,
            "description":"Description"
        },
        "accountNumber":{
            "type":"string",
            "maxLength":50,
            "description":"Account Number"
        },
        "account2":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "accountId2":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Account ID references the payment's account. The name of the account's main customer is displayed adjacent."
                }
            }
        },
        "paymentDate":{
            "type":"string",
            "format":"date",
            "description":"Payment Date is the business date associated with the payment event."
        },
        "creationDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Create Date/Time"
        },
        "document":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "documentId":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Document ID"
                }
            }
        },
        "accountT":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "accountIdT":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Account ID references the payment's account. The name of the account's main customer is displayed adjacent."
                }
            }
        },
        "paymentEventId2":{
            "type":"string",
            "maxLength":30,
            "description":"Payment Event ID is the system-assigned unique identifier of the payment event.",
            "example":"755669969777"
        },
        "entityName2":{
            "type":"string",
            "maxLength":254,
            "description":"Name"
        },
        "account3":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "acctId3":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Reversal Account ID"
                }
            }
        },
        "paymentEventException":{
            "type":"string",
            "maxLength":254,
            "description":"Message"
        },
        "hasTransfer":{
            "type":"boolean",
            "description":"The Transfer button is enabled if:\n\n    There is a single non-cancelled tender linked to the event AND\n    There is a single frozen payment linked to the event AND\n    The account on the tender is the same as the account on the payment.",
            "example":"false"
        },
        "canDistribute":{
            "type":"boolean",
            "description":"Defining Distribute as true distributes all Incomplete, Error, or Freezable payments linked to the event.",
            "example":"false"
        },
        "shouldAllPaymentsFreeze":{
            "type":"boolean",
            "description":"Defining Freeze as true causes all Freezable payments linked to the event to become frozen.",
            "example":"false"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        },
        "payments":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "payment":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "paymentId":{
                                        "type":"string",
                                        "maxLength":12,
                                        "description":"Payment ID"
                                    }
                                }
                            },
                            "paymentEventId2":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Payment Event ID is the system-assigned unique identifier of the payment event.",
                                "example":"317772795000"
                            },
                            "cancelReason":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "cancelReason":{
                                        "type":"string",
                                        "maxLength":4,
                                        "description":"Cancel Reason"
                                    }
                                }
                            },
                            "accountId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Account ID"
                            },
                            "paymentStatus":{
                                "type":"string",
                                "enum":[
                                    "10  ",
                                    "20  ",
                                    "30  ",
                                    "50  ",
                                    "60  "
                                ],
                                "description":"Payment Status is the payment's status. If the payment's status is Error , the error message is displayed adjacent.\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `50  ` - Frozen,\n* `60  ` - Canceled",
                                "example":"10"
                            },
                            "payStatusMessage":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Payment Status Message"
                            },
                            "paymentAmount":{
                                "type":"number",
                                "description":"Payment Amount is the amount of the account's debt relieved by the payment."
                            },
                            "currency":{
                                "type":"string",
                                "maxLength":3,
                                "description":"Currency Code"
                            },
                            "nonCisName":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Non CIS Name is the name of the person remitting the payment."
                            },
                            "referenceNumber":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Reference Number is the reference number of the item being paid. For example, the property tax reference number."
                            },
                            "nonCisComments":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Non CIS Name is the name of the person remitting the payment.",
                                "example":"ZZMXA,CX_test"
                            },
                            "matchType":{
                                "type":"string",
                                "maxLength":8,
                                "description":"Match Type and Match Value should only be used if either of the following conditions is true:\n\n        This Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment. \n        The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of \"service agreement ID\" and a Match Value of the respective service agreement ID.",
                                "example":"BILL-ID\n\n(Bill ID / Sequential Bill Number)"
                            },
                            "matchValue":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Match Type and Match Value should only be used if either of the following conditions is true:\n\n        This Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment. \n        The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of \"service agreement ID\" and a Match Value of the respective service agreement ID.",
                                "example":"995516242555"
                            },
                            "paymentSegmentTotal":{
                                "type":"number",
                                "description":"Payment Segment Total",
                                "example":"28.43"
                            },
                            "paymentAccountCash":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Use Cash-Only Threshold to define the number of cash-only points a customer must have before the system warns the Customer Service Representative accepting payments that the account is cash-only."
                            },
                            "isNonCisPayment":{
                                "type":"boolean",
                                "description":"Non-CIS Account Switch",
                                "example":"false"
                            },
                            "isOpenItemAccounting":{
                                "type":"boolean",
                                "description":"Open Item Accounting Switch",
                                "example":"false"
                            },
                            "bill":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "billId":{
                                        "type":"string",
                                        "maxLength":12,
                                        "description":"Bill ID"
                                    },
                                    "billTotal":{
                                        "type":"number",
                                        "description":"Bill Total"
                                    },
                                    "billDate":{
                                        "type":"string",
                                        "format":"date",
                                        "description":"Bill Date"
                                    }
                                }
                            },
                            "paymentException":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Message"
                            },
                            "paymentId2":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Payment ID"
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version"
                            },
                            "nextActions":{
                                "type":"object",
                                "properties":{
                                    "_data":{
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "action":{
                                                    "type":"string",
                                                    "maxLength":4,
                                                    "description":"Action Name"
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "paymentTenders":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "paymentTender":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "paymentTenderId":{
                                        "type":"string",
                                        "maxLength":12,
                                        "description":"Pay Tender ID"
                                    }
                                }
                            },
                            "payorAccountId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Account ID"
                            },
                            "currency":{
                                "type":"string",
                                "maxLength":3,
                                "description":"Currency Code"
                            },
                            "tenderType":{
                                "type":"string",
                                "maxLength":4,
                                "description":"Tender Type"
                            },
                            "tenderControl":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "tenderControlId":{
                                        "type":"string",
                                        "maxLength":10,
                                        "description":"Tender Control ID"
                                    }
                                }
                            },
                            "isIncludedInTenderControlBalance":{
                                "type":"boolean",
                                "description":"Turn off Included in Tender Ctl Balance if the tender should not be included in the tender amount in the tender control's tender balance. You would turn this switch off if you canceled a tender because it was mistakenly applied to the wrong account (or the amount was wrong). This switch is only enabled if:\n\n        The tender control is not balanced.\n        The tender is canceled."
                            },
                            "tenderAmount":{
                                "type":"number",
                                "description":"Tender Amount is the amount of the tender. The amount is disabled if the payment was made in an alternate currency."
                            },
                            "checkNumber":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Check Number"
                            },
                            "tenderStatus":{
                                "type":"string",
                                "enum":[
                                    "25  ",
                                    "60  "
                                ],
                                "description":"Tender Status is the tender's status.\n* `25  ` - Valid,\n* `60  ` - Canceled",
                                "example":"Valid"
                            },
                            "cancelReason":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "cancelReason":{
                                        "type":"string",
                                        "maxLength":4,
                                        "description":"Cancel Reason"
                                    }
                                }
                            },
                            "adjustment":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "adjustmentId":{
                                        "type":"string",
                                        "maxLength":12,
                                        "description":"Adjustment ID"
                                    }
                                }
                            },
                            "customerId":{
                                "type":"string",
                                "maxLength":36,
                                "description":"Customer ID is the customer's account ID that appeared on the interfaced payment."
                            },
                            "micrId":{
                                "type":"string",
                                "maxLength":30,
                                "description":"MICR ID"
                            },
                            "name":{
                                "type":"string",
                                "maxLength":40,
                                "description":"Name is the customer's name on the interfaced payment record."
                            },
                            "externalReferenceId":{
                                "type":"string",
                                "maxLength":36,
                                "description":"External Reference ID"
                            },
                            "alternateCurrency":{
                                "type":"string",
                                "maxLength":3,
                                "description":"Alternate Currency Code"
                            },
                            "externalAccountId":{
                                "type":"string",
                                "maxLength":50,
                                "description":"External Account ID is the customer's account number at the financial institution."
                            },
                            "altTenderAmount":{
                                "type":"number",
                                "maximum":9.99999999999999E12,
                                "minimum":-9.99999999999999E12,
                                "description":"Alternate Amount"
                            },
                            "encryptedMicrId":{
                                "type":"string",
                                "maxLength":64,
                                "description":"Encrypted Micr ID"
                            },
                            "hashMicrId":{
                                "type":"string",
                                "maxLength":88,
                                "description":"Hash MICR ID"
                            },
                            "tenderTypeNonCredit":{
                                "type":"string",
                                "description":"(tenderTypeNonCredit)"
                            },
                            "isTenderTypeAuthorized":{
                                "type":"boolean",
                                "description":"(isTenderTypeAuthorized)"
                            },
                            "hasCashTendered":{
                                "type":"boolean",
                                "description":"(hasCashTendered)"
                            },
                            "hasCancelTender":{
                                "type":"boolean",
                                "description":"(hasCancelTender)"
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version"
                            },
                            "characteristics":{
                                "type":"object",
                                "properties":{
                                    "_data":{
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "sequence":{
                                                    "type":"number",
                                                    "maximum":999,
                                                    "minimum":-999,
                                                    "description":"Sequence"
                                                },
                                                "characteristicType":{
                                                    "type":"object",
                                                    "properties":{
                                                        "_link":{
                                                            "type":"string",
                                                            "description":"_link"
                                                        },
                                                        "characteristicType":{
                                                            "type":"string",
                                                            "description":"(characteristicType5)"
                                                        }
                                                    }
                                                },
                                                "characteristicValueForeignKey":{
                                                    "type":"object",
                                                    "properties":{
                                                        "_link":{
                                                            "type":"string",
                                                            "description":"_link"
                                                        },
                                                        "characteristicValueForeignKey":{
                                                            "type":"string",
                                                            "description":"(characteristicValueForeignKey12)"
                                                        }
                                                    }
                                                },
                                                "adhocCharacteristicValue":{
                                                    "type":"string",
                                                    "maxLength":254,
                                                    "description":"Adhoc Characteristic Value"
                                                },
                                                "characteristicValue":{
                                                    "type":"string",
                                                    "description":"(characteristicValue3)"
                                                },
                                                "version":{
                                                    "type":"number",
                                                    "maximum":99999,
                                                    "minimum":-99999,
                                                    "description":"Version"
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "tenderType":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "tenderedAmount":{
                                "type":"number",
                                "description":"Amount Tendered contains the amount that was tendered by the customer."
                            },
                            "tenderType":{
                                "type":"string",
                                "maxLength":4,
                                "description":"Tender Type"
                            },
                            "checkNumber":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Check Number"
                            },
                            "micrId":{
                                "type":"string",
                                "maxLength":30,
                                "description":"MICR ID"
                            },
                            "hashMicrId":{
                                "type":"string",
                                "maxLength":88,
                                "description":"Hash MICR ID"
                            },
                            "externalReferenceId":{
                                "type":"string",
                                "maxLength":36,
                                "description":"External Reference ID"
                            },
                            "comment":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Use Comments to describe anything unusual about the tender control. For example, comments can explain why a large over/under amount was created."
                            },
                            "alternateCurrency":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "alternateCurrency":{
                                        "type":"string",
                                        "maxLength":3,
                                        "description":"Alternate Currency Code"
                                    }
                                }
                            },
                            "alternateTenderAmount":{
                                "type":"number",
                                "maximum":9.99999999999999E12,
                                "minimum":-9.99999999999999E12,
                                "description":"Alternate Amount"
                            }
                        }
                    }
                }
            }
        },
        "exceptions":{
            "type":"object",
            "properties":{
                "paymentEventId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Payment Event ID is the system-assigned unique identifier of the payment event.",
                    "example":"317772795000"
                },
                "messageCategory2":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message category within Oracle Utilities Application Framework",
                    "example":"11"
                },
                "messageNumber2":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message number within Oracle Utilities Application Framework.",
                    "example":"14107"
                },
                "paymentEventExceptionType":{
                    "type":"string",
                    "enum":[
                        "10  ",
                        "20  "
                    ],
                    "description":"Payment Exception Type\n* `10  ` - Unbalanced Event,\n* `20  ` - Unfrozen Payment",
                    "example":"20"
                },
                "expandedMessage2":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Message"
                },
                "messageParameter12":{
                    "type":"string",
                    "maxLength":2000,
                    "description":"Message Parameter",
                    "example":"."
                },
                "messageParameter22":{
                    "type":"string",
                    "maxLength":2000,
                    "description":"Message Parameter"
                },
                "messageParameter32":{
                    "type":"string",
                    "maxLength":2000,
                    "description":"Message Parameter"
                },
                "messageParameter42":{
                    "type":"string",
                    "maxLength":2000,
                    "description":"Message Parameter"
                },
                "messageParameter52":{
                    "type":"string",
                    "maxLength":2000,
                    "description":"Message Parameter"
                },
                "messageParameter62":{
                    "type":"string",
                    "maxLength":2000,
                    "description":"Message Parameter"
                },
                "messageParameter72":{
                    "type":"string",
                    "maxLength":2000,
                    "description":"Message Parameter"
                },
                "messageParameter82":{
                    "type":"string",
                    "maxLength":2000,
                    "description":"Message Parameter"
                },
                "messageParameter92":{
                    "type":"string",
                    "maxLength":2000,
                    "description":"Message Parameter"
                },
                "userId2":{
                    "type":"string",
                    "maxLength":30,
                    "description":"User"
                },
                "isReviewed2":{
                    "type":"boolean",
                    "description":"Reviewed",
                    "example":"false"
                },
                "reviewUser2":{
                    "type":"string",
                    "maxLength":8,
                    "description":"Review User"
                },
                "reviewedDate2":{
                    "type":"string",
                    "format":"date",
                    "description":"Review Date"
                },
                "comments2":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Comments"
                },
                "creationDateTime2":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Create Date/Time",
                    "example":"2010-11-24T17:49:23-05:00"
                },
                "version23":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Version2"
                }
            }
        },
        "characteristics":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "sequence":{
                                "type":"number",
                                "maximum":999,
                                "minimum":-999,
                                "description":"Sequence"
                            },
                            "characteristicType":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "characteristicType":{
                                        "type":"string",
                                        "maxLength":8,
                                        "description":"Characteristic Type"
                                    }
                                }
                            },
                            "typeOfCharacteristicValue":{
                                "type":"string",
                                "maxLength":4,
                                "description":"Characteristic Value Indicate the value of the characteristic.",
                                "example":"02-20-2008"
                            },
                            "characteristicValue":{
                                "type":"object",
                                "properties":{
                                    "value":{
                                        "type":"string",
                                        "description":"(value)"
                                    },
                                    "value2":{
                                        "type":"string",
                                        "description":"(value2)"
                                    },
                                    "value3":{
                                        "type":"string",
                                        "description":"(value3)"
                                    },
                                    "value4":{
                                        "type":"string",
                                        "description":"(value4)"
                                    },
                                    "value5":{
                                        "type":"string",
                                        "description":"(value5)"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"(_link)"
                                    }
                                }
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version"
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1-PayEvent"
    }
}

Nested Schema : account

Type: object

Show Source

• _link: string
  _link
• accountId: string
  Maximum Length: 10

  Account ID

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID"
        }
    }
}

Nested Schema : account2

Type: object

Show Source

• _link: string
  _link
• accountId2: string
  Maximum Length: 30

  Account ID references the payment's account. The name of the account's main customer is displayed adjacent.

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "accountId2":{
            "type":"string",
            "maxLength":30,
            "description":"Account ID references the payment's account. The name of the account's main customer is displayed adjacent."
        }
    }
}

Nested Schema : account3

Type: object

Show Source

• _link: string
  _link
• acctId3: string
  Maximum Length: 10

  Reversal Account ID

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "acctId3":{
            "type":"string",
            "maxLength":10,
            "description":"Reversal Account ID"
        }
    }
}

Nested Schema : accountT

Type: object

Show Source

• _link: string
  _link
• accountIdT: string
  Maximum Length: 10

  Account ID references the payment's account. The name of the account's main customer is displayed adjacent.

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "accountIdT":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID references the payment's account. The name of the account's main customer is displayed adjacent."
        }
    }
}

Nested Schema : cancelReason

Type: object

Show Source

• _link: string
  _link
• cancelReason: string
  Maximum Length: 4

  Cancel Reason

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "cancelReason":{
            "type":"string",
            "maxLength":4,
            "description":"Cancel Reason"
        }
    }
}

Nested Schema : characteristics

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "sequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"Sequence"
                    },
                    "characteristicType":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "characteristicType":{
                                "type":"string",
                                "maxLength":8,
                                "description":"Characteristic Type"
                            }
                        }
                    },
                    "typeOfCharacteristicValue":{
                        "type":"string",
                        "maxLength":4,
                        "description":"Characteristic Value Indicate the value of the characteristic.",
                        "example":"02-20-2008"
                    },
                    "characteristicValue":{
                        "type":"object",
                        "properties":{
                            "value":{
                                "type":"string",
                                "description":"(value)"
                            },
                            "value2":{
                                "type":"string",
                                "description":"(value2)"
                            },
                            "value3":{
                                "type":"string",
                                "description":"(value3)"
                            },
                            "value4":{
                                "type":"string",
                                "description":"(value4)"
                            },
                            "value5":{
                                "type":"string",
                                "description":"(value5)"
                            },
                            "_link":{
                                "type":"string",
                                "description":"(_link)"
                            }
                        }
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    }
                }
            }
        }
    }
}

Nested Schema : currency

Type: object

Show Source

• _link: string
  _link
• currency: string
  Maximum Length: 3

  Currency Code

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "currency":{
            "type":"string",
            "maxLength":3,
            "description":"Currency Code"
        }
    }
}

Nested Schema : document

Type: object

Show Source

• _link: string
  _link
• documentId: string
  Maximum Length: 30

  Document ID

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "documentId":{
            "type":"string",
            "maxLength":30,
            "description":"Document ID"
        }
    }
}

Nested Schema : exceptions

Type: object

Show Source

• comments2: string
  Maximum Length: 254

  Comments
• creationDateTime2: string (date-time)
  Create Date/Time

  Example: 2010-11-24T17:49:23-05:00
• expandedMessage2: string
  Maximum Length: 254

  Message
• isReviewed2: boolean
  Reviewed

  Example: false
• messageCategory2: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message category within Oracle Utilities Application Framework

  Example: 11
• messageNumber2: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message number within Oracle Utilities Application Framework.

  Example: 14107
• messageParameter12: string
  Maximum Length: 2000

  Message Parameter

  Example: .
• messageParameter22: string
  Maximum Length: 2000

  Message Parameter
• messageParameter32: string
  Maximum Length: 2000

  Message Parameter
• messageParameter42: string
  Maximum Length: 2000

  Message Parameter
• messageParameter52: string
  Maximum Length: 2000

  Message Parameter
• messageParameter62: string
  Maximum Length: 2000

  Message Parameter
• messageParameter72: string
  Maximum Length: 2000

  Message Parameter
• messageParameter82: string
  Maximum Length: 2000

  Message Parameter
• messageParameter92: string
  Maximum Length: 2000

  Message Parameter
• paymentEventExceptionType: string
  Allowed Values: [ "10 ", "20 " ]

  Payment Exception Type * `10 ` - Unbalanced Event, * `20 ` - Unfrozen Payment

  Example: 20
• paymentEventId: string
  Maximum Length: 12

  Payment Event ID is the system-assigned unique identifier of the payment event.

  Example: 317772795000
• reviewedDate2: string (date)
  Review Date
• reviewUser2: string
  Maximum Length: 8

  Review User
• userId2: string
  Maximum Length: 30

  User
• version23: number
  Minimum Value: 0

  Maximum Value: 0

  Version2

{
    "type":"object",
    "properties":{
        "paymentEventId":{
            "type":"string",
            "maxLength":12,
            "description":"Payment Event ID is the system-assigned unique identifier of the payment event.",
            "example":"317772795000"
        },
        "messageCategory2":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message category within Oracle Utilities Application Framework",
            "example":"11"
        },
        "messageNumber2":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message number within Oracle Utilities Application Framework.",
            "example":"14107"
        },
        "paymentEventExceptionType":{
            "type":"string",
            "enum":[
                "10  ",
                "20  "
            ],
            "description":"Payment Exception Type\n* `10  ` - Unbalanced Event,\n* `20  ` - Unfrozen Payment",
            "example":"20"
        },
        "expandedMessage2":{
            "type":"string",
            "maxLength":254,
            "description":"Message"
        },
        "messageParameter12":{
            "type":"string",
            "maxLength":2000,
            "description":"Message Parameter",
            "example":"."
        },
        "messageParameter22":{
            "type":"string",
            "maxLength":2000,
            "description":"Message Parameter"
        },
        "messageParameter32":{
            "type":"string",
            "maxLength":2000,
            "description":"Message Parameter"
        },
        "messageParameter42":{
            "type":"string",
            "maxLength":2000,
            "description":"Message Parameter"
        },
        "messageParameter52":{
            "type":"string",
            "maxLength":2000,
            "description":"Message Parameter"
        },
        "messageParameter62":{
            "type":"string",
            "maxLength":2000,
            "description":"Message Parameter"
        },
        "messageParameter72":{
            "type":"string",
            "maxLength":2000,
            "description":"Message Parameter"
        },
        "messageParameter82":{
            "type":"string",
            "maxLength":2000,
            "description":"Message Parameter"
        },
        "messageParameter92":{
            "type":"string",
            "maxLength":2000,
            "description":"Message Parameter"
        },
        "userId2":{
            "type":"string",
            "maxLength":30,
            "description":"User"
        },
        "isReviewed2":{
            "type":"boolean",
            "description":"Reviewed",
            "example":"false"
        },
        "reviewUser2":{
            "type":"string",
            "maxLength":8,
            "description":"Review User"
        },
        "reviewedDate2":{
            "type":"string",
            "format":"date",
            "description":"Review Date"
        },
        "comments2":{
            "type":"string",
            "maxLength":254,
            "description":"Comments"
        },
        "creationDateTime2":{
            "type":"string",
            "format":"date-time",
            "description":"Create Date/Time",
            "example":"2010-11-24T17:49:23-05:00"
        },
        "version23":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Version2"
        }
    }
}

Nested Schema : payEventAlternateCurrency

Type: object

Show Source

• _link: string
  _link
• payEventAlternateCurrency: string
  Maximum Length: 1

  Pay Event Alternate Currency Info

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "payEventAlternateCurrency":{
            "type":"string",
            "maxLength":1,
            "description":"Pay Event Alternate Currency Info"
        }
    }
}

Nested Schema : payments

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "payment":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "paymentId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Payment ID"
                            }
                        }
                    },
                    "paymentEventId2":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Payment Event ID is the system-assigned unique identifier of the payment event.",
                        "example":"317772795000"
                    },
                    "cancelReason":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "cancelReason":{
                                "type":"string",
                                "maxLength":4,
                                "description":"Cancel Reason"
                            }
                        }
                    },
                    "accountId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Account ID"
                    },
                    "paymentStatus":{
                        "type":"string",
                        "enum":[
                            "10  ",
                            "20  ",
                            "30  ",
                            "50  ",
                            "60  "
                        ],
                        "description":"Payment Status is the payment's status. If the payment's status is Error , the error message is displayed adjacent.\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `50  ` - Frozen,\n* `60  ` - Canceled",
                        "example":"10"
                    },
                    "payStatusMessage":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Payment Status Message"
                    },
                    "paymentAmount":{
                        "type":"number",
                        "description":"Payment Amount is the amount of the account's debt relieved by the payment."
                    },
                    "currency":{
                        "type":"string",
                        "maxLength":3,
                        "description":"Currency Code"
                    },
                    "nonCisName":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Non CIS Name is the name of the person remitting the payment."
                    },
                    "referenceNumber":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Reference Number is the reference number of the item being paid. For example, the property tax reference number."
                    },
                    "nonCisComments":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Non CIS Name is the name of the person remitting the payment.",
                        "example":"ZZMXA,CX_test"
                    },
                    "matchType":{
                        "type":"string",
                        "maxLength":8,
                        "description":"Match Type and Match Value should only be used if either of the following conditions is true:\n\n        This Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment. \n        The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of \"service agreement ID\" and a Match Value of the respective service agreement ID.",
                        "example":"BILL-ID\n\n(Bill ID / Sequential Bill Number)"
                    },
                    "matchValue":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Match Type and Match Value should only be used if either of the following conditions is true:\n\n        This Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment. \n        The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of \"service agreement ID\" and a Match Value of the respective service agreement ID.",
                        "example":"995516242555"
                    },
                    "paymentSegmentTotal":{
                        "type":"number",
                        "description":"Payment Segment Total",
                        "example":"28.43"
                    },
                    "paymentAccountCash":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Use Cash-Only Threshold to define the number of cash-only points a customer must have before the system warns the Customer Service Representative accepting payments that the account is cash-only."
                    },
                    "isNonCisPayment":{
                        "type":"boolean",
                        "description":"Non-CIS Account Switch",
                        "example":"false"
                    },
                    "isOpenItemAccounting":{
                        "type":"boolean",
                        "description":"Open Item Accounting Switch",
                        "example":"false"
                    },
                    "bill":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "billId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Bill ID"
                            },
                            "billTotal":{
                                "type":"number",
                                "description":"Bill Total"
                            },
                            "billDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Bill Date"
                            }
                        }
                    },
                    "paymentException":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Message"
                    },
                    "paymentId2":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Payment ID"
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    },
                    "nextActions":{
                        "type":"object",
                        "properties":{
                            "_data":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "action":{
                                            "type":"string",
                                            "maxLength":4,
                                            "description":"Action Name"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : paymentTenders

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "paymentTender":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "paymentTenderId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Pay Tender ID"
                            }
                        }
                    },
                    "payorAccountId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Account ID"
                    },
                    "currency":{
                        "type":"string",
                        "maxLength":3,
                        "description":"Currency Code"
                    },
                    "tenderType":{
                        "type":"string",
                        "maxLength":4,
                        "description":"Tender Type"
                    },
                    "tenderControl":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "tenderControlId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Tender Control ID"
                            }
                        }
                    },
                    "isIncludedInTenderControlBalance":{
                        "type":"boolean",
                        "description":"Turn off Included in Tender Ctl Balance if the tender should not be included in the tender amount in the tender control's tender balance. You would turn this switch off if you canceled a tender because it was mistakenly applied to the wrong account (or the amount was wrong). This switch is only enabled if:\n\n        The tender control is not balanced.\n        The tender is canceled."
                    },
                    "tenderAmount":{
                        "type":"number",
                        "description":"Tender Amount is the amount of the tender. The amount is disabled if the payment was made in an alternate currency."
                    },
                    "checkNumber":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Check Number"
                    },
                    "tenderStatus":{
                        "type":"string",
                        "enum":[
                            "25  ",
                            "60  "
                        ],
                        "description":"Tender Status is the tender's status.\n* `25  ` - Valid,\n* `60  ` - Canceled",
                        "example":"Valid"
                    },
                    "cancelReason":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "cancelReason":{
                                "type":"string",
                                "maxLength":4,
                                "description":"Cancel Reason"
                            }
                        }
                    },
                    "adjustment":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "adjustmentId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Adjustment ID"
                            }
                        }
                    },
                    "customerId":{
                        "type":"string",
                        "maxLength":36,
                        "description":"Customer ID is the customer's account ID that appeared on the interfaced payment."
                    },
                    "micrId":{
                        "type":"string",
                        "maxLength":30,
                        "description":"MICR ID"
                    },
                    "name":{
                        "type":"string",
                        "maxLength":40,
                        "description":"Name is the customer's name on the interfaced payment record."
                    },
                    "externalReferenceId":{
                        "type":"string",
                        "maxLength":36,
                        "description":"External Reference ID"
                    },
                    "alternateCurrency":{
                        "type":"string",
                        "maxLength":3,
                        "description":"Alternate Currency Code"
                    },
                    "externalAccountId":{
                        "type":"string",
                        "maxLength":50,
                        "description":"External Account ID is the customer's account number at the financial institution."
                    },
                    "altTenderAmount":{
                        "type":"number",
                        "maximum":9.99999999999999E12,
                        "minimum":-9.99999999999999E12,
                        "description":"Alternate Amount"
                    },
                    "encryptedMicrId":{
                        "type":"string",
                        "maxLength":64,
                        "description":"Encrypted Micr ID"
                    },
                    "hashMicrId":{
                        "type":"string",
                        "maxLength":88,
                        "description":"Hash MICR ID"
                    },
                    "tenderTypeNonCredit":{
                        "type":"string",
                        "description":"(tenderTypeNonCredit)"
                    },
                    "isTenderTypeAuthorized":{
                        "type":"boolean",
                        "description":"(isTenderTypeAuthorized)"
                    },
                    "hasCashTendered":{
                        "type":"boolean",
                        "description":"(hasCashTendered)"
                    },
                    "hasCancelTender":{
                        "type":"boolean",
                        "description":"(hasCancelTender)"
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    },
                    "characteristics":{
                        "type":"object",
                        "properties":{
                            "_data":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "sequence":{
                                            "type":"number",
                                            "maximum":999,
                                            "minimum":-999,
                                            "description":"Sequence"
                                        },
                                        "characteristicType":{
                                            "type":"object",
                                            "properties":{
                                                "_link":{
                                                    "type":"string",
                                                    "description":"_link"
                                                },
                                                "characteristicType":{
                                                    "type":"string",
                                                    "description":"(characteristicType5)"
                                                }
                                            }
                                        },
                                        "characteristicValueForeignKey":{
                                            "type":"object",
                                            "properties":{
                                                "_link":{
                                                    "type":"string",
                                                    "description":"_link"
                                                },
                                                "characteristicValueForeignKey":{
                                                    "type":"string",
                                                    "description":"(characteristicValueForeignKey12)"
                                                }
                                            }
                                        },
                                        "adhocCharacteristicValue":{
                                            "type":"string",
                                            "maxLength":254,
                                            "description":"Adhoc Characteristic Value"
                                        },
                                        "characteristicValue":{
                                            "type":"string",
                                            "description":"(characteristicValue3)"
                                        },
                                        "version":{
                                            "type":"number",
                                            "maximum":99999,
                                            "minimum":-99999,
                                            "description":"Version"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : payorAccount

Type: object

Show Source

• _link: string
  _link
• payorAccountId: string
  Maximum Length: 10

  Account ID

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "payorAccountId":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID"
        }
    }
}

Nested Schema : tenderType

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "tenderedAmount":{
                        "type":"number",
                        "description":"Amount Tendered contains the amount that was tendered by the customer."
                    },
                    "tenderType":{
                        "type":"string",
                        "maxLength":4,
                        "description":"Tender Type"
                    },
                    "checkNumber":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Check Number"
                    },
                    "micrId":{
                        "type":"string",
                        "maxLength":30,
                        "description":"MICR ID"
                    },
                    "hashMicrId":{
                        "type":"string",
                        "maxLength":88,
                        "description":"Hash MICR ID"
                    },
                    "externalReferenceId":{
                        "type":"string",
                        "maxLength":36,
                        "description":"External Reference ID"
                    },
                    "comment":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Use Comments to describe anything unusual about the tender control. For example, comments can explain why a large over/under amount was created."
                    },
                    "alternateCurrency":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "alternateCurrency":{
                                "type":"string",
                                "maxLength":3,
                                "description":"Alternate Currency Code"
                            }
                        }
                    },
                    "alternateTenderAmount":{
                        "type":"number",
                        "maximum":9.99999999999999E12,
                        "minimum":-9.99999999999999E12,
                        "description":"Alternate Amount"
                    }
                }
            }
        }
    }
}

Nested Schema : user

Type: object

USER ID

Show Source

• _link: string
  _link
• user: string
  Maximum Length: 8

  USER ID

{
    "type":"object",
    "description":"USER ID",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "user":{
            "type":"string",
            "maxLength":8,
            "description":"USER ID"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "sequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"Sequence"
            },
            "characteristicType":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "characteristicType":{
                        "type":"string",
                        "maxLength":8,
                        "description":"Characteristic Type"
                    }
                }
            },
            "typeOfCharacteristicValue":{
                "type":"string",
                "maxLength":4,
                "description":"Characteristic Value Indicate the value of the characteristic.",
                "example":"02-20-2008"
            },
            "characteristicValue":{
                "type":"object",
                "properties":{
                    "value":{
                        "type":"string",
                        "description":"(value)"
                    },
                    "value2":{
                        "type":"string",
                        "description":"(value2)"
                    },
                    "value3":{
                        "type":"string",
                        "description":"(value3)"
                    },
                    "value4":{
                        "type":"string",
                        "description":"(value4)"
                    },
                    "value5":{
                        "type":"string",
                        "description":"(value5)"
                    },
                    "_link":{
                        "type":"string",
                        "description":"(_link)"
                    }
                }
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• characteristicType: object characteristicType
• characteristicValue: object characteristicValue
• sequence: number
  Minimum Value: -999

  Maximum Value: 999

  Sequence
• typeOfCharacteristicValue: string
  Maximum Length: 4

  Characteristic Value Indicate the value of the characteristic.

  Example: 02-20-2008
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "sequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Sequence"
        },
        "characteristicType":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "characteristicType":{
                    "type":"string",
                    "maxLength":8,
                    "description":"Characteristic Type"
                }
            }
        },
        "typeOfCharacteristicValue":{
            "type":"string",
            "maxLength":4,
            "description":"Characteristic Value Indicate the value of the characteristic.",
            "example":"02-20-2008"
        },
        "characteristicValue":{
            "type":"object",
            "properties":{
                "value":{
                    "type":"string",
                    "description":"(value)"
                },
                "value2":{
                    "type":"string",
                    "description":"(value2)"
                },
                "value3":{
                    "type":"string",
                    "description":"(value3)"
                },
                "value4":{
                    "type":"string",
                    "description":"(value4)"
                },
                "value5":{
                    "type":"string",
                    "description":"(value5)"
                },
                "_link":{
                    "type":"string",
                    "description":"(_link)"
                }
            }
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        }
    }
}

Nested Schema : characteristicType

Type: object

Show Source

• _link: string
  _link
• characteristicType: string
  Maximum Length: 8

  Characteristic Type

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "characteristicType":{
            "type":"string",
            "maxLength":8,
            "description":"Characteristic Type"
        }
    }
}

Nested Schema : characteristicValue

Type: object

Show Source

• _link: string
  (_link)
• value: string
  (value)
• value2: string
  (value2)
• value3: string
  (value3)
• value4: string
  (value4)
• value5: string
  (value5)

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string",
            "description":"(value)"
        },
        "value2":{
            "type":"string",
            "description":"(value2)"
        },
        "value3":{
            "type":"string",
            "description":"(value3)"
        },
        "value4":{
            "type":"string",
            "description":"(value4)"
        },
        "value5":{
            "type":"string",
            "description":"(value5)"
        },
        "_link":{
            "type":"string",
            "description":"(_link)"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "payment":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "paymentId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Payment ID"
                    }
                }
            },
            "paymentEventId2":{
                "type":"string",
                "maxLength":12,
                "description":"Payment Event ID is the system-assigned unique identifier of the payment event.",
                "example":"317772795000"
            },
            "cancelReason":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "cancelReason":{
                        "type":"string",
                        "maxLength":4,
                        "description":"Cancel Reason"
                    }
                }
            },
            "accountId":{
                "type":"string",
                "maxLength":10,
                "description":"Account ID"
            },
            "paymentStatus":{
                "type":"string",
                "enum":[
                    "10  ",
                    "20  ",
                    "30  ",
                    "50  ",
                    "60  "
                ],
                "description":"Payment Status is the payment's status. If the payment's status is Error , the error message is displayed adjacent.\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `50  ` - Frozen,\n* `60  ` - Canceled",
                "example":"10"
            },
            "payStatusMessage":{
                "type":"string",
                "maxLength":10,
                "description":"Payment Status Message"
            },
            "paymentAmount":{
                "type":"number",
                "description":"Payment Amount is the amount of the account's debt relieved by the payment."
            },
            "currency":{
                "type":"string",
                "maxLength":3,
                "description":"Currency Code"
            },
            "nonCisName":{
                "type":"string",
                "maxLength":50,
                "description":"Non CIS Name is the name of the person remitting the payment."
            },
            "referenceNumber":{
                "type":"string",
                "maxLength":30,
                "description":"Reference Number is the reference number of the item being paid. For example, the property tax reference number."
            },
            "nonCisComments":{
                "type":"string",
                "maxLength":254,
                "description":"Non CIS Name is the name of the person remitting the payment.",
                "example":"ZZMXA,CX_test"
            },
            "matchType":{
                "type":"string",
                "maxLength":8,
                "description":"Match Type and Match Value should only be used if either of the following conditions is true:\n\n        This Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment. \n        The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of \"service agreement ID\" and a Match Value of the respective service agreement ID.",
                "example":"BILL-ID\n\n(Bill ID / Sequential Bill Number)"
            },
            "matchValue":{
                "type":"string",
                "maxLength":30,
                "description":"Match Type and Match Value should only be used if either of the following conditions is true:\n\n        This Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment. \n        The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of \"service agreement ID\" and a Match Value of the respective service agreement ID.",
                "example":"995516242555"
            },
            "paymentSegmentTotal":{
                "type":"number",
                "description":"Payment Segment Total",
                "example":"28.43"
            },
            "paymentAccountCash":{
                "type":"string",
                "maxLength":30,
                "description":"Use Cash-Only Threshold to define the number of cash-only points a customer must have before the system warns the Customer Service Representative accepting payments that the account is cash-only."
            },
            "isNonCisPayment":{
                "type":"boolean",
                "description":"Non-CIS Account Switch",
                "example":"false"
            },
            "isOpenItemAccounting":{
                "type":"boolean",
                "description":"Open Item Accounting Switch",
                "example":"false"
            },
            "bill":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "billId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Bill ID"
                    },
                    "billTotal":{
                        "type":"number",
                        "description":"Bill Total"
                    },
                    "billDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Bill Date"
                    }
                }
            },
            "paymentException":{
                "type":"string",
                "maxLength":254,
                "description":"Message"
            },
            "paymentId2":{
                "type":"string",
                "maxLength":12,
                "description":"Payment ID"
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            },
            "nextActions":{
                "type":"object",
                "properties":{
                    "_data":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "action":{
                                    "type":"string",
                                    "maxLength":4,
                                    "description":"Action Name"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• accountId: string
  Maximum Length: 10

  Account ID
• bill: object bill
• cancelReason: object cancelReason
• currency: string
  Maximum Length: 3

  Currency Code
• isNonCisPayment: boolean
  Non-CIS Account Switch

  Example: false
• isOpenItemAccounting: boolean
  Open Item Accounting Switch

  Example: false
• matchType: string
  Maximum Length: 8

  Match Type and Match Value should only be used if either of the following conditions is true: This Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment. The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of "service agreement ID" and a Match Value of the respective service agreement ID.

  Example: BILL-ID (Bill ID / Sequential Bill Number)
• matchValue: string
  Maximum Length: 30

  Match Type and Match Value should only be used if either of the following conditions is true: This Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment. The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of "service agreement ID" and a Match Value of the respective service agreement ID.

  Example: 995516242555
• nextActions: object nextActions
• nonCisComments: string
  Maximum Length: 254

  Non CIS Name is the name of the person remitting the payment.

  Example: ZZMXA,CX_test
• nonCisName: string
  Maximum Length: 50

  Non CIS Name is the name of the person remitting the payment.
• payment: object payment
• paymentAccountCash: string
  Maximum Length: 30

  Use Cash-Only Threshold to define the number of cash-only points a customer must have before the system warns the Customer Service Representative accepting payments that the account is cash-only.
• paymentAmount: number
  Payment Amount is the amount of the account's debt relieved by the payment.
• paymentEventId2: string
  Maximum Length: 12

  Payment Event ID is the system-assigned unique identifier of the payment event.

  Example: 317772795000
• paymentException: string
  Maximum Length: 254

  Message
• paymentId2: string
  Maximum Length: 12

  Payment ID
• paymentSegmentTotal: number
  Payment Segment Total

  Example: 28.43
• paymentStatus: string
  Allowed Values: [ "10 ", "20 ", "30 ", "50 ", "60 " ]

  Payment Status is the payment's status. If the payment's status is Error , the error message is displayed adjacent. * `10 ` - Incomplete, * `20 ` - Error, * `30 ` - Freezable, * `50 ` - Frozen, * `60 ` - Canceled

  Example: 10
• payStatusMessage: string
  Maximum Length: 10

  Payment Status Message
• referenceNumber: string
  Maximum Length: 30

  Reference Number is the reference number of the item being paid. For example, the property tax reference number.
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "payment":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "paymentId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Payment ID"
                }
            }
        },
        "paymentEventId2":{
            "type":"string",
            "maxLength":12,
            "description":"Payment Event ID is the system-assigned unique identifier of the payment event.",
            "example":"317772795000"
        },
        "cancelReason":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "cancelReason":{
                    "type":"string",
                    "maxLength":4,
                    "description":"Cancel Reason"
                }
            }
        },
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID"
        },
        "paymentStatus":{
            "type":"string",
            "enum":[
                "10  ",
                "20  ",
                "30  ",
                "50  ",
                "60  "
            ],
            "description":"Payment Status is the payment's status. If the payment's status is Error , the error message is displayed adjacent.\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `50  ` - Frozen,\n* `60  ` - Canceled",
            "example":"10"
        },
        "payStatusMessage":{
            "type":"string",
            "maxLength":10,
            "description":"Payment Status Message"
        },
        "paymentAmount":{
            "type":"number",
            "description":"Payment Amount is the amount of the account's debt relieved by the payment."
        },
        "currency":{
            "type":"string",
            "maxLength":3,
            "description":"Currency Code"
        },
        "nonCisName":{
            "type":"string",
            "maxLength":50,
            "description":"Non CIS Name is the name of the person remitting the payment."
        },
        "referenceNumber":{
            "type":"string",
            "maxLength":30,
            "description":"Reference Number is the reference number of the item being paid. For example, the property tax reference number."
        },
        "nonCisComments":{
            "type":"string",
            "maxLength":254,
            "description":"Non CIS Name is the name of the person remitting the payment.",
            "example":"ZZMXA,CX_test"
        },
        "matchType":{
            "type":"string",
            "maxLength":8,
            "description":"Match Type and Match Value should only be used if either of the following conditions is true:\n\n        This Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment. \n        The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of \"service agreement ID\" and a Match Value of the respective service agreement ID.",
            "example":"BILL-ID\n\n(Bill ID / Sequential Bill Number)"
        },
        "matchValue":{
            "type":"string",
            "maxLength":30,
            "description":"Match Type and Match Value should only be used if either of the following conditions is true:\n\n        This Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment. \n        The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of \"service agreement ID\" and a Match Value of the respective service agreement ID.",
            "example":"995516242555"
        },
        "paymentSegmentTotal":{
            "type":"number",
            "description":"Payment Segment Total",
            "example":"28.43"
        },
        "paymentAccountCash":{
            "type":"string",
            "maxLength":30,
            "description":"Use Cash-Only Threshold to define the number of cash-only points a customer must have before the system warns the Customer Service Representative accepting payments that the account is cash-only."
        },
        "isNonCisPayment":{
            "type":"boolean",
            "description":"Non-CIS Account Switch",
            "example":"false"
        },
        "isOpenItemAccounting":{
            "type":"boolean",
            "description":"Open Item Accounting Switch",
            "example":"false"
        },
        "bill":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "billId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Bill ID"
                },
                "billTotal":{
                    "type":"number",
                    "description":"Bill Total"
                },
                "billDate":{
                    "type":"string",
                    "format":"date",
                    "description":"Bill Date"
                }
            }
        },
        "paymentException":{
            "type":"string",
            "maxLength":254,
            "description":"Message"
        },
        "paymentId2":{
            "type":"string",
            "maxLength":12,
            "description":"Payment ID"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        },
        "nextActions":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "action":{
                                "type":"string",
                                "maxLength":4,
                                "description":"Action Name"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : bill

Type: object

Show Source

• _link: string
  _link
• billDate: string (date)
  Bill Date
• billId: string
  Maximum Length: 12

  Bill ID
• billTotal: number
  Bill Total

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "billId":{
            "type":"string",
            "maxLength":12,
            "description":"Bill ID"
        },
        "billTotal":{
            "type":"number",
            "description":"Bill Total"
        },
        "billDate":{
            "type":"string",
            "format":"date",
            "description":"Bill Date"
        }
    }
}

Nested Schema : cancelReason

Type: object

Show Source

• _link: string
  _link
• cancelReason: string
  Maximum Length: 4

  Cancel Reason

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "cancelReason":{
            "type":"string",
            "maxLength":4,
            "description":"Cancel Reason"
        }
    }
}

Nested Schema : nextActions

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "action":{
                        "type":"string",
                        "maxLength":4,
                        "description":"Action Name"
                    }
                }
            }
        }
    }
}

Nested Schema : payment

Type: object

Show Source

• _link: string
  _link
• paymentId: string
  Maximum Length: 12

  Payment ID

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "paymentId":{
            "type":"string",
            "maxLength":12,
            "description":"Payment ID"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "action":{
                "type":"string",
                "maxLength":4,
                "description":"Action Name"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• action: string
  Maximum Length: 4

  Action Name

{
    "type":"object",
    "properties":{
        "action":{
            "type":"string",
            "maxLength":4,
            "description":"Action Name"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "paymentTender":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "paymentTenderId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Pay Tender ID"
                    }
                }
            },
            "payorAccountId":{
                "type":"string",
                "maxLength":10,
                "description":"Account ID"
            },
            "currency":{
                "type":"string",
                "maxLength":3,
                "description":"Currency Code"
            },
            "tenderType":{
                "type":"string",
                "maxLength":4,
                "description":"Tender Type"
            },
            "tenderControl":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "tenderControlId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Tender Control ID"
                    }
                }
            },
            "isIncludedInTenderControlBalance":{
                "type":"boolean",
                "description":"Turn off Included in Tender Ctl Balance if the tender should not be included in the tender amount in the tender control's tender balance. You would turn this switch off if you canceled a tender because it was mistakenly applied to the wrong account (or the amount was wrong). This switch is only enabled if:\n\n        The tender control is not balanced.\n        The tender is canceled."
            },
            "tenderAmount":{
                "type":"number",
                "description":"Tender Amount is the amount of the tender. The amount is disabled if the payment was made in an alternate currency."
            },
            "checkNumber":{
                "type":"string",
                "maxLength":10,
                "description":"Check Number"
            },
            "tenderStatus":{
                "type":"string",
                "enum":[
                    "25  ",
                    "60  "
                ],
                "description":"Tender Status is the tender's status.\n* `25  ` - Valid,\n* `60  ` - Canceled",
                "example":"Valid"
            },
            "cancelReason":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "cancelReason":{
                        "type":"string",
                        "maxLength":4,
                        "description":"Cancel Reason"
                    }
                }
            },
            "adjustment":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "adjustmentId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Adjustment ID"
                    }
                }
            },
            "customerId":{
                "type":"string",
                "maxLength":36,
                "description":"Customer ID is the customer's account ID that appeared on the interfaced payment."
            },
            "micrId":{
                "type":"string",
                "maxLength":30,
                "description":"MICR ID"
            },
            "name":{
                "type":"string",
                "maxLength":40,
                "description":"Name is the customer's name on the interfaced payment record."
            },
            "externalReferenceId":{
                "type":"string",
                "maxLength":36,
                "description":"External Reference ID"
            },
            "alternateCurrency":{
                "type":"string",
                "maxLength":3,
                "description":"Alternate Currency Code"
            },
            "externalAccountId":{
                "type":"string",
                "maxLength":50,
                "description":"External Account ID is the customer's account number at the financial institution."
            },
            "altTenderAmount":{
                "type":"number",
                "maximum":9.99999999999999E12,
                "minimum":-9.99999999999999E12,
                "description":"Alternate Amount"
            },
            "encryptedMicrId":{
                "type":"string",
                "maxLength":64,
                "description":"Encrypted Micr ID"
            },
            "hashMicrId":{
                "type":"string",
                "maxLength":88,
                "description":"Hash MICR ID"
            },
            "tenderTypeNonCredit":{
                "type":"string",
                "description":"(tenderTypeNonCredit)"
            },
            "isTenderTypeAuthorized":{
                "type":"boolean",
                "description":"(isTenderTypeAuthorized)"
            },
            "hasCashTendered":{
                "type":"boolean",
                "description":"(hasCashTendered)"
            },
            "hasCancelTender":{
                "type":"boolean",
                "description":"(hasCancelTender)"
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            },
            "characteristics":{
                "type":"object",
                "properties":{
                    "_data":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "sequence":{
                                    "type":"number",
                                    "maximum":999,
                                    "minimum":-999,
                                    "description":"Sequence"
                                },
                                "characteristicType":{
                                    "type":"object",
                                    "properties":{
                                        "_link":{
                                            "type":"string",
                                            "description":"_link"
                                        },
                                        "characteristicType":{
                                            "type":"string",
                                            "description":"(characteristicType5)"
                                        }
                                    }
                                },
                                "characteristicValueForeignKey":{
                                    "type":"object",
                                    "properties":{
                                        "_link":{
                                            "type":"string",
                                            "description":"_link"
                                        },
                                        "characteristicValueForeignKey":{
                                            "type":"string",
                                            "description":"(characteristicValueForeignKey12)"
                                        }
                                    }
                                },
                                "adhocCharacteristicValue":{
                                    "type":"string",
                                    "maxLength":254,
                                    "description":"Adhoc Characteristic Value"
                                },
                                "characteristicValue":{
                                    "type":"string",
                                    "description":"(characteristicValue3)"
                                },
                                "version":{
                                    "type":"number",
                                    "maximum":99999,
                                    "minimum":-99999,
                                    "description":"Version"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• adjustment: object adjustment
• alternateCurrency: string
  Maximum Length: 3

  Alternate Currency Code
• altTenderAmount: number
  Minimum Value: -9.99999999999999E12

  Maximum Value: 9.99999999999999E12

  Alternate Amount
• cancelReason: object cancelReason
• characteristics: object characteristics
• checkNumber: string
  Maximum Length: 10

  Check Number
• currency: string
  Maximum Length: 3

  Currency Code
• customerId: string
  Maximum Length: 36

  Customer ID is the customer's account ID that appeared on the interfaced payment.
• encryptedMicrId: string
  Maximum Length: 64

  Encrypted Micr ID
• externalAccountId: string
  Maximum Length: 50

  External Account ID is the customer's account number at the financial institution.
• externalReferenceId: string
  Maximum Length: 36

  External Reference ID
• hasCancelTender: boolean
  (hasCancelTender)
• hasCashTendered: boolean
  (hasCashTendered)
• hashMicrId: string
  Maximum Length: 88

  Hash MICR ID
• isIncludedInTenderControlBalance: boolean
  Turn off Included in Tender Ctl Balance if the tender should not be included in the tender amount in the tender control's tender balance. You would turn this switch off if you canceled a tender because it was mistakenly applied to the wrong account (or the amount was wrong). This switch is only enabled if: The tender control is not balanced. The tender is canceled.
• isTenderTypeAuthorized: boolean
  (isTenderTypeAuthorized)
• micrId: string
  Maximum Length: 30

  MICR ID
• name: string
  Maximum Length: 40

  Name is the customer's name on the interfaced payment record.
• paymentTender: object paymentTender
• payorAccountId: string
  Maximum Length: 10

  Account ID
• tenderAmount: number
  Tender Amount is the amount of the tender. The amount is disabled if the payment was made in an alternate currency.
• tenderControl: object tenderControl
• tenderStatus: string
  Allowed Values: [ "25 ", "60 " ]

  Tender Status is the tender's status. * `25 ` - Valid, * `60 ` - Canceled

  Example: Valid
• tenderType: string
  Maximum Length: 4

  Tender Type
• tenderTypeNonCredit: string
  (tenderTypeNonCredit)
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "paymentTender":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "paymentTenderId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Pay Tender ID"
                }
            }
        },
        "payorAccountId":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID"
        },
        "currency":{
            "type":"string",
            "maxLength":3,
            "description":"Currency Code"
        },
        "tenderType":{
            "type":"string",
            "maxLength":4,
            "description":"Tender Type"
        },
        "tenderControl":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "tenderControlId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Tender Control ID"
                }
            }
        },
        "isIncludedInTenderControlBalance":{
            "type":"boolean",
            "description":"Turn off Included in Tender Ctl Balance if the tender should not be included in the tender amount in the tender control's tender balance. You would turn this switch off if you canceled a tender because it was mistakenly applied to the wrong account (or the amount was wrong). This switch is only enabled if:\n\n        The tender control is not balanced.\n        The tender is canceled."
        },
        "tenderAmount":{
            "type":"number",
            "description":"Tender Amount is the amount of the tender. The amount is disabled if the payment was made in an alternate currency."
        },
        "checkNumber":{
            "type":"string",
            "maxLength":10,
            "description":"Check Number"
        },
        "tenderStatus":{
            "type":"string",
            "enum":[
                "25  ",
                "60  "
            ],
            "description":"Tender Status is the tender's status.\n* `25  ` - Valid,\n* `60  ` - Canceled",
            "example":"Valid"
        },
        "cancelReason":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "cancelReason":{
                    "type":"string",
                    "maxLength":4,
                    "description":"Cancel Reason"
                }
            }
        },
        "adjustment":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "adjustmentId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Adjustment ID"
                }
            }
        },
        "customerId":{
            "type":"string",
            "maxLength":36,
            "description":"Customer ID is the customer's account ID that appeared on the interfaced payment."
        },
        "micrId":{
            "type":"string",
            "maxLength":30,
            "description":"MICR ID"
        },
        "name":{
            "type":"string",
            "maxLength":40,
            "description":"Name is the customer's name on the interfaced payment record."
        },
        "externalReferenceId":{
            "type":"string",
            "maxLength":36,
            "description":"External Reference ID"
        },
        "alternateCurrency":{
            "type":"string",
            "maxLength":3,
            "description":"Alternate Currency Code"
        },
        "externalAccountId":{
            "type":"string",
            "maxLength":50,
            "description":"External Account ID is the customer's account number at the financial institution."
        },
        "altTenderAmount":{
            "type":"number",
            "maximum":9.99999999999999E12,
            "minimum":-9.99999999999999E12,
            "description":"Alternate Amount"
        },
        "encryptedMicrId":{
            "type":"string",
            "maxLength":64,
            "description":"Encrypted Micr ID"
        },
        "hashMicrId":{
            "type":"string",
            "maxLength":88,
            "description":"Hash MICR ID"
        },
        "tenderTypeNonCredit":{
            "type":"string",
            "description":"(tenderTypeNonCredit)"
        },
        "isTenderTypeAuthorized":{
            "type":"boolean",
            "description":"(isTenderTypeAuthorized)"
        },
        "hasCashTendered":{
            "type":"boolean",
            "description":"(hasCashTendered)"
        },
        "hasCancelTender":{
            "type":"boolean",
            "description":"(hasCancelTender)"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        },
        "characteristics":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "sequence":{
                                "type":"number",
                                "maximum":999,
                                "minimum":-999,
                                "description":"Sequence"
                            },
                            "characteristicType":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "characteristicType":{
                                        "type":"string",
                                        "description":"(characteristicType5)"
                                    }
                                }
                            },
                            "characteristicValueForeignKey":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "characteristicValueForeignKey":{
                                        "type":"string",
                                        "description":"(characteristicValueForeignKey12)"
                                    }
                                }
                            },
                            "adhocCharacteristicValue":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Adhoc Characteristic Value"
                            },
                            "characteristicValue":{
                                "type":"string",
                                "description":"(characteristicValue3)"
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : adjustment

Type: object

Show Source

• _link: string
  _link
• adjustmentId: string
  Maximum Length: 12

  Adjustment ID

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "adjustmentId":{
            "type":"string",
            "maxLength":12,
            "description":"Adjustment ID"
        }
    }
}

Nested Schema : cancelReason

Type: object

Show Source

• _link: string
  _link
• cancelReason: string
  Maximum Length: 4

  Cancel Reason

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "cancelReason":{
            "type":"string",
            "maxLength":4,
            "description":"Cancel Reason"
        }
    }
}

Nested Schema : characteristics

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "sequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"Sequence"
                    },
                    "characteristicType":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "characteristicType":{
                                "type":"string",
                                "description":"(characteristicType5)"
                            }
                        }
                    },
                    "characteristicValueForeignKey":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "characteristicValueForeignKey":{
                                "type":"string",
                                "description":"(characteristicValueForeignKey12)"
                            }
                        }
                    },
                    "adhocCharacteristicValue":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Adhoc Characteristic Value"
                    },
                    "characteristicValue":{
                        "type":"string",
                        "description":"(characteristicValue3)"
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    }
                }
            }
        }
    }
}

Nested Schema : paymentTender

Type: object

Show Source

• _link: string
  _link
• paymentTenderId: string
  Maximum Length: 12

  Pay Tender ID

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "paymentTenderId":{
            "type":"string",
            "maxLength":12,
            "description":"Pay Tender ID"
        }
    }
}

Nested Schema : tenderControl

Type: object

Show Source

• _link: string
  _link
• tenderControlId: string
  Maximum Length: 10

  Tender Control ID

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "tenderControlId":{
            "type":"string",
            "maxLength":10,
            "description":"Tender Control ID"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "sequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"Sequence"
            },
            "characteristicType":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "characteristicType":{
                        "type":"string",
                        "description":"(characteristicType5)"
                    }
                }
            },
            "characteristicValueForeignKey":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "characteristicValueForeignKey":{
                        "type":"string",
                        "description":"(characteristicValueForeignKey12)"
                    }
                }
            },
            "adhocCharacteristicValue":{
                "type":"string",
                "maxLength":254,
                "description":"Adhoc Characteristic Value"
            },
            "characteristicValue":{
                "type":"string",
                "description":"(characteristicValue3)"
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• adhocCharacteristicValue: string
  Maximum Length: 254

  Adhoc Characteristic Value
• characteristicType: object characteristicType
• characteristicValue: string
  (characteristicValue3)
• characteristicValueForeignKey: object characteristicValueForeignKey
• sequence: number
  Minimum Value: -999

  Maximum Value: 999

  Sequence
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "sequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Sequence"
        },
        "characteristicType":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "characteristicType":{
                    "type":"string",
                    "description":"(characteristicType5)"
                }
            }
        },
        "characteristicValueForeignKey":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "characteristicValueForeignKey":{
                    "type":"string",
                    "description":"(characteristicValueForeignKey12)"
                }
            }
        },
        "adhocCharacteristicValue":{
            "type":"string",
            "maxLength":254,
            "description":"Adhoc Characteristic Value"
        },
        "characteristicValue":{
            "type":"string",
            "description":"(characteristicValue3)"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        }
    }
}

Nested Schema : characteristicType

Type: object

Show Source

• _link: string
  _link
• characteristicType: string
  (characteristicType5)

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "characteristicType":{
            "type":"string",
            "description":"(characteristicType5)"
        }
    }
}

Nested Schema : characteristicValueForeignKey

Type: object

Show Source

• _link: string
  _link
• characteristicValueForeignKey: string
  (characteristicValueForeignKey12)

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "characteristicValueForeignKey":{
            "type":"string",
            "description":"(characteristicValueForeignKey12)"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "tenderedAmount":{
                "type":"number",
                "description":"Amount Tendered contains the amount that was tendered by the customer."
            },
            "tenderType":{
                "type":"string",
                "maxLength":4,
                "description":"Tender Type"
            },
            "checkNumber":{
                "type":"string",
                "maxLength":10,
                "description":"Check Number"
            },
            "micrId":{
                "type":"string",
                "maxLength":30,
                "description":"MICR ID"
            },
            "hashMicrId":{
                "type":"string",
                "maxLength":88,
                "description":"Hash MICR ID"
            },
            "externalReferenceId":{
                "type":"string",
                "maxLength":36,
                "description":"External Reference ID"
            },
            "comment":{
                "type":"string",
                "maxLength":254,
                "description":"Use Comments to describe anything unusual about the tender control. For example, comments can explain why a large over/under amount was created."
            },
            "alternateCurrency":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "alternateCurrency":{
                        "type":"string",
                        "maxLength":3,
                        "description":"Alternate Currency Code"
                    }
                }
            },
            "alternateTenderAmount":{
                "type":"number",
                "maximum":9.99999999999999E12,
                "minimum":-9.99999999999999E12,
                "description":"Alternate Amount"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• alternateCurrency: object alternateCurrency
• alternateTenderAmount: number
  Minimum Value: -9.99999999999999E12

  Maximum Value: 9.99999999999999E12

  Alternate Amount
• checkNumber: string
  Maximum Length: 10

  Check Number
• comment: string
  Maximum Length: 254

  Use Comments to describe anything unusual about the tender control. For example, comments can explain why a large over/under amount was created.
• externalReferenceId: string
  Maximum Length: 36

  External Reference ID
• hashMicrId: string
  Maximum Length: 88

  Hash MICR ID
• micrId: string
  Maximum Length: 30

  MICR ID
• tenderedAmount: number
  Amount Tendered contains the amount that was tendered by the customer.
• tenderType: string
  Maximum Length: 4

  Tender Type

{
    "type":"object",
    "properties":{
        "tenderedAmount":{
            "type":"number",
            "description":"Amount Tendered contains the amount that was tendered by the customer."
        },
        "tenderType":{
            "type":"string",
            "maxLength":4,
            "description":"Tender Type"
        },
        "checkNumber":{
            "type":"string",
            "maxLength":10,
            "description":"Check Number"
        },
        "micrId":{
            "type":"string",
            "maxLength":30,
            "description":"MICR ID"
        },
        "hashMicrId":{
            "type":"string",
            "maxLength":88,
            "description":"Hash MICR ID"
        },
        "externalReferenceId":{
            "type":"string",
            "maxLength":36,
            "description":"External Reference ID"
        },
        "comment":{
            "type":"string",
            "maxLength":254,
            "description":"Use Comments to describe anything unusual about the tender control. For example, comments can explain why a large over/under amount was created."
        },
        "alternateCurrency":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "alternateCurrency":{
                    "type":"string",
                    "maxLength":3,
                    "description":"Alternate Currency Code"
                }
            }
        },
        "alternateTenderAmount":{
            "type":"number",
            "maximum":9.99999999999999E12,
            "minimum":-9.99999999999999E12,
            "description":"Alternate Amount"
        }
    }
}

Nested Schema : alternateCurrency

Type: object

Show Source

• _link: string
  _link
• alternateCurrency: string
  Maximum Length: 3

  Alternate Currency Code

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "alternateCurrency":{
            "type":"string",
            "maxLength":3,
            "description":"Alternate Currency Code"
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : problemDetailDocument

Type: object

Show Source

• detail: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• httpStatus: number
  Minimum Value: 0

  Maximum Value: 9999

  The HTTP Status code for the error.
• problemInstance: string
  Maximum Length: 60

  Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction.
• problemType: string
  Maximum Length: 60

  URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework.
• serverMessage: object serverMessage
• stackTrace: string
  Maximum Length: 60

  The stack trace shows where the error occurs during the execution of a program.
• title: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"URL of the format \"A/message/X/Y\" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

• callSequence: string
  Maximum Length: 60

  Delimited sequence of programs called.
• longDescription: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• messageCategory: number
  Minimum Value: 0

  Maximum Value: 0

  Message Category within Oracle Utilities Application Framework.
• messageNbr: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message Number within Oracle Utilities Application Framework.
• messageText: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
• programName: string
  Maximum Length: 60

  Name of the program that encountered the error.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : problemDetailDocument

Type: object

Show Source

• detail: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• httpStatus: number
  Minimum Value: 0

  Maximum Value: 9999

  The HTTP Status code for the error.
• problemInstance: string
  Maximum Length: 60

  Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction.
• problemType: string
  Maximum Length: 60

  URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework.
• serverMessage: object serverMessage
• stackTrace: string
  Maximum Length: 60

  The stack trace shows where the error occurs during the execution of a program.
• title: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"URL of the format \"A/message/X/Y\" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

• callSequence: string
  Maximum Length: 60

  Delimited sequence of programs called.
• longDescription: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• messageCategory: number
  Minimum Value: 0

  Maximum Value: 0

  Message Category within Oracle Utilities Application Framework.
• messageNbr: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message Number within Oracle Utilities Application Framework.
• messageText: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
• programName: string
  Maximum Length: 60

  Name of the program that encountered the error.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

Back to Top