Create Payment Tender
post
https://server:port/spl/rest/apis/customer/financials/paymentTenders/
Request
There are no request parameters for this operation.
Supported Media Types
- application/xml
- application/json
Root Schema : schema
Type:
Show Source
object
-
adjustment: object
adjustment
-
alternateCurrency: object
alternateCurrency
If the payment tender was remitted in an alternate currency, i.e. a currency other than the payor account's currency.
-
alternateTenderAmount: object
alternateTenderAmount
Tender Amount
-
autoPayClearing: object
autoPayClearing
-
cancelReason: object
cancelReason
If the payment is canceled, the Cancel Reason is displayed.
-
characteristics: object
characteristics
-
checkNumber: string
Maximum Length:
10
If a check was used for payment, the Check Number contains the identity of the check. -
currency: object
currency
Currency Code defines the currency in which the account's financial transactions are expressed.
-
customerId: string
Maximum Length:
36
Customer ID is the customer's account ID that appeared on the payment. -
encryptedMicrId: string
Maximum Length:
64
Encrypted MICR ID -
externalReferenceId: string
Maximum Length:
36
Ext. Reference ID is the unique identifier of the payment upload record. -
hashMicrId: string
Maximum Length:
88
A hash representation of MICR ID field. -
micrId: string
Maximum Length:
30
MICR ID is the value of the magnetic ink character recognition (MICR) line on the payment. -
name: string
Maximum Length:
40
Name is the customer's name on the payment record. -
paymentEvent: object
paymentEvent
-
paymentTenderId: string
Maximum Length:
12
Pay Tender ID is the system-assigned unique identifier of the tender.Example:221888888888
-
payorAccount: object
payorAccount
-
tenderAmount: number
Tender Amount is the amount of the tender. The amount is disabled if the payment was made in an alternate currency.Example:
$25.00
-
tenderControl: object
tenderControl
-
tenders: object
tenders
-
tenderStatus: string
Allowed Values:
[ "25 ", "60 " ]
Tender Status is the tender's status. * `25 ` - Valid, * `60 ` - CanceledExample:Valid
-
tenderType: object
tenderType
Tender Type describes what was remitted, such as cash or check.
-
tndrTypeNonCredit: string
(tndrTypeNonCredit)
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:1
Nested Schema : adjustment
Type:
Show Source
object
-
adjustmentId: string
Maximum Length:
12
Adjustment ID is displayed if there is an adjustment associated with the payment.
Nested Schema : alternateCurrency
Type:
object
If the payment tender was remitted in an alternate currency, i.e. a currency other than the payor account's currency.
Show Source
-
alternateCurrency: string
Maximum Length:
3
If the payment tender was remitted in an alternate currency, i.e. a currency other than the payor account's currency.
Nested Schema : alternateTenderAmount
Type:
object
Tender Amount
Show Source
-
alternateTenderAmount: number
Minimum Value:
-9.99999999999999E12
Maximum Value:9.99999999999999E12
Tender Amount
Nested Schema : autoPayClearing
Type:
Show Source
object
-
accountAutoPay: object
accountAutoPay
-
autopayClearingId: string
Maximum Length:
12
Auto Pay Clearing ID is PK of the auto pay staging record. -
autopayDistributeAndFreezeDate: string
(date)
The automatic payment is NOT distributed and frozen when the automatic payment is initially created. A separate background process distributes and freezes the automatic payment on the automatic payment GL distribution date . On the GL distribution date, the automatic payment will be interfaced to the general ledger.
-
autopaySource: object
autopaySource
Auto Pay Source Code is the financial institution or credit card company that receives the automatic payment request.
-
batchControl: object
batchControl
Batch Code is the batch code for which the tender control was created. If the tender controls are created for a background process, such as the automatic payment extract, Batch Code is displayed.
-
batchNumber: number
Minimum Value:
-9.999999999E9
Maximum Value:9.999999999E9
Batch Number is the batch number for which the tender control was created. If the tender controls are created for a background process, such as the automatic payment extract, Batch Number is displayed. -
bill: object
bill
-
encryptedExternalAccountId: string
Maximum Length:
108
External Account ID is used to define the customer's bank account or credit card number. The system supports encryption for the External Account ID. If your implementation has configured the system to encrypt the External Account ID, the data will be returned with a masked value, such as *******. -
entityName: string
Maximum Length:
254
Name is the customer's name in the financial institution's system. -
expireDate: string
(date)
Expires On is only needed if the Tender Type indicates that an expiration date is necessary, such as for a credit card payment.
-
externalAccountId: string
Maximum Length:
50
External Account ID is the customer's account number at the financial institution. -
scheduleExtractDate: string
(date)
Scheduled Extract Date is the date the automatic payment request was sent or is scheduled to be sent to the financial institution.
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:1
Nested Schema : cancelReason
Type:
object
If the payment is canceled, the Cancel Reason is displayed.
Show Source
-
cancelReason: string
Maximum Length:
4
Cancel Reason
Nested Schema : currency
Type:
object
Currency Code defines the currency in which the account's financial transactions are expressed.
Show Source
-
currency: string
Maximum Length:
3
Currency Code
Nested Schema : paymentEvent
Type:
Show Source
object
-
paymentEventId: string
Maximum Length:
12
Payment Event ID
Nested Schema : payorAccount
Type:
Show Source
object
-
payorAccountId: string
Maximum Length:
10
Account ID
Nested Schema : tenderControl
Type:
Show Source
object
-
tenderControlId: string
Maximum Length:
10
Tender Control ID is the identity of the remittance processor batch or cash drawer bundle in which the tender was remitted.Example:0225339900
Nested Schema : tenderType
Type:
object
Tender Type describes what was remitted, such as cash or check.
Show Source
-
tenderType: string
Maximum Length:
4
Tender Type
Nested Schema : accountAutoPay
Type:
Show Source
object
-
accountAutoPayId: string
Maximum Length:
10
Auto Pay ID is the unique, system-assigned identifier of the auto-pay record.
Nested Schema : autopaySource
Type:
object
Auto Pay Source Code is the financial institution or credit card company that receives the automatic payment request.
Show Source
-
autopaySourceCd: string
Maximum Length:
12
Auto Pay Source
Nested Schema : batchControl
Type:
object
Batch Code is the batch code for which the tender control was created. If the tender controls are created for a background process, such as the automatic payment extract, Batch Code is displayed.
Show Source
-
batchControl: string
Maximum Length:
8
Batch Code is the batch code for which the tender control was created. If the tender controls are created for a background process, such as the automatic payment extract, Batch Code is displayed.
Nested Schema : items
Type:
Show Source
object
-
characteristicType: object
characteristicType
-
characteristicValue: object
characteristicValue
-
effectiveDate: string
(date)
Effective Date defines the date on which the characteristic becomes effective. The effective date defaults from the Installation Record.Example:
2016-01-01
-
typeOfCharacteristicValue: string
Maximum Length:
4
Characteristic Value indicates the value of the characteristic if the characteristic type is pre-defined or foreign key reference.Example:02-20-2008
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:1
Nested Schema : characteristicType
Type:
Show Source
object
-
characteristicType: string
Maximum Length:
8
Characteristic Type
Nested Schema : characteristicValue
Type:
Show Source
object
-
_link: string
(_link)
-
value: string
(value)
-
value2: string
(value2)
-
value3: string
(value3)
-
value4: string
(value4)
-
value5: string
(value5)
Nested Schema : items
Type:
Show Source
object
-
adjustment: object
adjustment
-
alternateCurrency: object
alternateCurrency
-
altTenderAmount2: number
Minimum Value:
-9.99999999999999E12
Maximum Value:9.99999999999999E12
Tender Amount -
autoPayClearing: object
autoPayClearing
-
cancelReason: object
cancelReason
-
checkNumber: string
Maximum Length:
10
Check Number -
currency: object
currency
-
customerId: string
Maximum Length:
36
Customer ID is the customer's account ID that appeared on the payment. -
encryptedMicrId2: string
Maximum Length:
64
Encrypted MICR ID -
externalReferenceId2: string
Maximum Length:
36
Ext. Reference ID is the unique identifier of the payment upload record. -
hashMicrId2: string
Maximum Length:
88
A hash representation of MICR ID field. -
isIncludedInTenderControlBalance: boolean
Included in Tender Ctl Balance
-
micrId2: string
Maximum Length:
30
MICR ID is the value of the magnetic ink character recognition (MICR) line on the payment. -
name: string
Maximum Length:
40
Name is the customer's name on the payment record. -
nextActions: object
nextActions
-
paymentTenderId: string
Maximum Length:
12
Pay Tender ID is the system-assigned unique identifier of the tender.Example:221888888888
-
payorAccount: object
payorAccount
-
tenderAmount: number
Tender Amount is the amount of the tender. The amount is disabled if the payment was made in an alternate currency.Example:
$25.00
-
tenderControl: object
tenderControl
-
tenderStatus: string
Allowed Values:
[ "25 ", "60 " ]
Tender Status is the tender's status. * `25 ` - Valid, * `60 ` - CanceledExample:Valid
-
tenderType: object
tenderType
-
tndrTypeNonCredit: string
(tndrTypeNonCredit)
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:1
Nested Schema : adjustment
Type:
Show Source
object
-
adjustmentId: string
Maximum Length:
12
Adjustment ID
Nested Schema : alternateCurrency
Type:
Show Source
object
-
alternateCurrency: string
Maximum Length:
3
Alternate Currency Code
Nested Schema : autoPayClearing
Type:
Show Source
object
-
accountAutoPay: object
accountAutoPay
-
autopayClearingId: string
Maximum Length:
12
Auto Pay Clearing ID is PK of the auto pay staging record. -
autopayDistributeAndFreezeDate: string
(date)
The automatic payment is NOT distributed and frozen when the automatic payment is initially created. A separate background process distributes and freezes the automatic payment on the automatic payment GL distribution date . On the GL distribution date, the automatic payment will be interfaced to the general ledger.
-
autopaySource: object
autopaySource
-
batchControl: object
batchControl
-
batchNumber: number
Minimum Value:
-9.999999999E9
Maximum Value:9.999999999E9
Batch Number is the batch number for which the tender control was created. If the tender controls are created for a background process, such as the automatic payment extract, Batch Number is displayed. -
bill: object
bill
-
encryptedExternalAccountId: string
Maximum Length:
108
External Account ID is used to define the customer's bank account or credit card number. The system supports encryption for the External Account ID. If your implementation has configured the system to encrypt the External Account ID, the data will be returned with a masked value, such as *******. -
entityName: string
Maximum Length:
254
Name is the customer's name in the financial institution's system. -
expireDate: string
(date)
Expires On is only needed if the Tender Type indicates that an expiration date is necessary, such as for a credit card payment.
-
externalAccountId: string
Maximum Length:
50
External Account ID is the customer's account number at the financial institution. -
scheduleExtractDate: string
(date)
Scheduled Extract Date is the date the automatic payment request was sent or is scheduled to be sent to the financial institution.
-
version3: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:1
Nested Schema : cancelReason
Type:
Show Source
object
-
cancelReason: string
Maximum Length:
4
Cancel Reason
Nested Schema : payorAccount
Type:
Show Source
object
-
payorAccountId: string
Maximum Length:
10
Account ID
Nested Schema : tenderControl
Type:
Show Source
object
-
tenderControlId: string
Maximum Length:
10
Tender Control ID
Nested Schema : tenderType
Type:
Show Source
object
-
tenderType: string
Maximum Length:
4
Tender Type
Nested Schema : accountAutoPay
Type:
Show Source
object
-
accountAutoPayId: string
Maximum Length:
10
Auto Pay ID
Nested Schema : autopaySource
Type:
Show Source
object
-
autopaySourceCd: string
Maximum Length:
12
Auto Pay Source
Nested Schema : batchControl
Type:
Show Source
object
-
batchControl: string
Maximum Length:
8
Batch Control
Nested Schema : items
Type:
Show Source
object
-
action: string
Allowed Values:
[ "C1CN" ]
Payment Tender Web Service Actions: * `C1CN` - Cancel
Root Schema : schema
Type:
Show Source
object
-
adjustment: object
adjustment
-
alternateCurrency: object
alternateCurrency
If the payment tender was remitted in an alternate currency, i.e. a currency other than the payor account's currency.
-
alternateTenderAmount: object
alternateTenderAmount
Tender Amount
-
autoPayClearing: object
autoPayClearing
-
cancelReason: object
cancelReason
If the payment is canceled, the Cancel Reason is displayed.
-
characteristics: object
characteristics
-
checkNumber: string
Maximum Length:
10
If a check was used for payment, the Check Number contains the identity of the check. -
currency: object
currency
Currency Code defines the currency in which the account's financial transactions are expressed.
-
customerId: string
Maximum Length:
36
Customer ID is the customer's account ID that appeared on the payment. -
encryptedMicrId: string
Maximum Length:
64
Encrypted MICR ID -
externalReferenceId: string
Maximum Length:
36
Ext. Reference ID is the unique identifier of the payment upload record. -
hashMicrId: string
Maximum Length:
88
A hash representation of MICR ID field. -
micrId: string
Maximum Length:
30
MICR ID is the value of the magnetic ink character recognition (MICR) line on the payment. -
name: string
Maximum Length:
40
Name is the customer's name on the payment record. -
paymentEvent: object
paymentEvent
-
paymentTenderId: string
Maximum Length:
12
Pay Tender ID is the system-assigned unique identifier of the tender.Example:221888888888
-
payorAccount: object
payorAccount
-
tenderAmount: number
Tender Amount is the amount of the tender. The amount is disabled if the payment was made in an alternate currency.Example:
$25.00
-
tenderControl: object
tenderControl
-
tenders: object
tenders
-
tenderStatus: string
Allowed Values:
[ "25 ", "60 " ]
Tender Status is the tender's status. * `25 ` - Valid, * `60 ` - CanceledExample:Valid
-
tenderType: object
tenderType
Tender Type describes what was remitted, such as cash or check.
-
tndrTypeNonCredit: string
(tndrTypeNonCredit)
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:1
Nested Schema : adjustment
Type:
Show Source
object
-
adjustmentId: string
Maximum Length:
12
Adjustment ID is displayed if there is an adjustment associated with the payment.
Nested Schema : alternateCurrency
Type:
object
If the payment tender was remitted in an alternate currency, i.e. a currency other than the payor account's currency.
Show Source
-
alternateCurrency: string
Maximum Length:
3
If the payment tender was remitted in an alternate currency, i.e. a currency other than the payor account's currency.
Nested Schema : alternateTenderAmount
Type:
object
Tender Amount
Show Source
-
alternateTenderAmount: number
Minimum Value:
-9.99999999999999E12
Maximum Value:9.99999999999999E12
Tender Amount
Nested Schema : autoPayClearing
Type:
Show Source
object
-
accountAutoPay: object
accountAutoPay
-
autopayClearingId: string
Maximum Length:
12
Auto Pay Clearing ID is PK of the auto pay staging record. -
autopayDistributeAndFreezeDate: string
(date)
The automatic payment is NOT distributed and frozen when the automatic payment is initially created. A separate background process distributes and freezes the automatic payment on the automatic payment GL distribution date . On the GL distribution date, the automatic payment will be interfaced to the general ledger.
-
autopaySource: object
autopaySource
Auto Pay Source Code is the financial institution or credit card company that receives the automatic payment request.
-
batchControl: object
batchControl
Batch Code is the batch code for which the tender control was created. If the tender controls are created for a background process, such as the automatic payment extract, Batch Code is displayed.
-
batchNumber: number
Minimum Value:
-9.999999999E9
Maximum Value:9.999999999E9
Batch Number is the batch number for which the tender control was created. If the tender controls are created for a background process, such as the automatic payment extract, Batch Number is displayed. -
bill: object
bill
-
encryptedExternalAccountId: string
Maximum Length:
108
External Account ID is used to define the customer's bank account or credit card number. The system supports encryption for the External Account ID. If your implementation has configured the system to encrypt the External Account ID, the data will be returned with a masked value, such as *******. -
entityName: string
Maximum Length:
254
Name is the customer's name in the financial institution's system. -
expireDate: string
(date)
Expires On is only needed if the Tender Type indicates that an expiration date is necessary, such as for a credit card payment.
-
externalAccountId: string
Maximum Length:
50
External Account ID is the customer's account number at the financial institution. -
scheduleExtractDate: string
(date)
Scheduled Extract Date is the date the automatic payment request was sent or is scheduled to be sent to the financial institution.
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:1
Nested Schema : cancelReason
Type:
object
If the payment is canceled, the Cancel Reason is displayed.
Show Source
-
cancelReason: string
Maximum Length:
4
Cancel Reason
Nested Schema : currency
Type:
object
Currency Code defines the currency in which the account's financial transactions are expressed.
Show Source
-
currency: string
Maximum Length:
3
Currency Code
Nested Schema : paymentEvent
Type:
Show Source
object
-
paymentEventId: string
Maximum Length:
12
Payment Event ID
Nested Schema : payorAccount
Type:
Show Source
object
-
payorAccountId: string
Maximum Length:
10
Account ID
Nested Schema : tenderControl
Type:
Show Source
object
-
tenderControlId: string
Maximum Length:
10
Tender Control ID is the identity of the remittance processor batch or cash drawer bundle in which the tender was remitted.Example:0225339900
Nested Schema : tenderType
Type:
object
Tender Type describes what was remitted, such as cash or check.
Show Source
-
tenderType: string
Maximum Length:
4
Tender Type
Nested Schema : accountAutoPay
Type:
Show Source
object
-
accountAutoPayId: string
Maximum Length:
10
Auto Pay ID is the unique, system-assigned identifier of the auto-pay record.
Nested Schema : autopaySource
Type:
object
Auto Pay Source Code is the financial institution or credit card company that receives the automatic payment request.
Show Source
-
autopaySourceCd: string
Maximum Length:
12
Auto Pay Source
Nested Schema : batchControl
Type:
object
Batch Code is the batch code for which the tender control was created. If the tender controls are created for a background process, such as the automatic payment extract, Batch Code is displayed.
Show Source
-
batchControl: string
Maximum Length:
8
Batch Code is the batch code for which the tender control was created. If the tender controls are created for a background process, such as the automatic payment extract, Batch Code is displayed.
Nested Schema : items
Type:
Show Source
object
-
characteristicType: object
characteristicType
-
characteristicValue: object
characteristicValue
-
effectiveDate: string
(date)
Effective Date defines the date on which the characteristic becomes effective. The effective date defaults from the Installation Record.Example:
2016-01-01
-
typeOfCharacteristicValue: string
Maximum Length:
4
Characteristic Value indicates the value of the characteristic if the characteristic type is pre-defined or foreign key reference.Example:02-20-2008
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:1
Nested Schema : characteristicType
Type:
Show Source
object
-
characteristicType: string
Maximum Length:
8
Characteristic Type
Nested Schema : characteristicValue
Type:
Show Source
object
-
_link: string
(_link)
-
value: string
(value)
-
value2: string
(value2)
-
value3: string
(value3)
-
value4: string
(value4)
-
value5: string
(value5)
Nested Schema : items
Type:
Show Source
object
-
adjustment: object
adjustment
-
alternateCurrency: object
alternateCurrency
-
altTenderAmount2: number
Minimum Value:
-9.99999999999999E12
Maximum Value:9.99999999999999E12
Tender Amount -
autoPayClearing: object
autoPayClearing
-
cancelReason: object
cancelReason
-
checkNumber: string
Maximum Length:
10
Check Number -
currency: object
currency
-
customerId: string
Maximum Length:
36
Customer ID is the customer's account ID that appeared on the payment. -
encryptedMicrId2: string
Maximum Length:
64
Encrypted MICR ID -
externalReferenceId2: string
Maximum Length:
36
Ext. Reference ID is the unique identifier of the payment upload record. -
hashMicrId2: string
Maximum Length:
88
A hash representation of MICR ID field. -
isIncludedInTenderControlBalance: boolean
Included in Tender Ctl Balance
-
micrId2: string
Maximum Length:
30
MICR ID is the value of the magnetic ink character recognition (MICR) line on the payment. -
name: string
Maximum Length:
40
Name is the customer's name on the payment record. -
nextActions: object
nextActions
-
paymentTenderId: string
Maximum Length:
12
Pay Tender ID is the system-assigned unique identifier of the tender.Example:221888888888
-
payorAccount: object
payorAccount
-
tenderAmount: number
Tender Amount is the amount of the tender. The amount is disabled if the payment was made in an alternate currency.Example:
$25.00
-
tenderControl: object
tenderControl
-
tenderStatus: string
Allowed Values:
[ "25 ", "60 " ]
Tender Status is the tender's status. * `25 ` - Valid, * `60 ` - CanceledExample:Valid
-
tenderType: object
tenderType
-
tndrTypeNonCredit: string
(tndrTypeNonCredit)
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:1
Nested Schema : adjustment
Type:
Show Source
object
-
adjustmentId: string
Maximum Length:
12
Adjustment ID
Nested Schema : alternateCurrency
Type:
Show Source
object
-
alternateCurrency: string
Maximum Length:
3
Alternate Currency Code
Nested Schema : autoPayClearing
Type:
Show Source
object
-
accountAutoPay: object
accountAutoPay
-
autopayClearingId: string
Maximum Length:
12
Auto Pay Clearing ID is PK of the auto pay staging record. -
autopayDistributeAndFreezeDate: string
(date)
The automatic payment is NOT distributed and frozen when the automatic payment is initially created. A separate background process distributes and freezes the automatic payment on the automatic payment GL distribution date . On the GL distribution date, the automatic payment will be interfaced to the general ledger.
-
autopaySource: object
autopaySource
-
batchControl: object
batchControl
-
batchNumber: number
Minimum Value:
-9.999999999E9
Maximum Value:9.999999999E9
Batch Number is the batch number for which the tender control was created. If the tender controls are created for a background process, such as the automatic payment extract, Batch Number is displayed. -
bill: object
bill
-
encryptedExternalAccountId: string
Maximum Length:
108
External Account ID is used to define the customer's bank account or credit card number. The system supports encryption for the External Account ID. If your implementation has configured the system to encrypt the External Account ID, the data will be returned with a masked value, such as *******. -
entityName: string
Maximum Length:
254
Name is the customer's name in the financial institution's system. -
expireDate: string
(date)
Expires On is only needed if the Tender Type indicates that an expiration date is necessary, such as for a credit card payment.
-
externalAccountId: string
Maximum Length:
50
External Account ID is the customer's account number at the financial institution. -
scheduleExtractDate: string
(date)
Scheduled Extract Date is the date the automatic payment request was sent or is scheduled to be sent to the financial institution.
-
version3: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:1
Nested Schema : cancelReason
Type:
Show Source
object
-
cancelReason: string
Maximum Length:
4
Cancel Reason
Nested Schema : payorAccount
Type:
Show Source
object
-
payorAccountId: string
Maximum Length:
10
Account ID
Nested Schema : tenderControl
Type:
Show Source
object
-
tenderControlId: string
Maximum Length:
10
Tender Control ID
Nested Schema : tenderType
Type:
Show Source
object
-
tenderType: string
Maximum Length:
4
Tender Type
Nested Schema : accountAutoPay
Type:
Show Source
object
-
accountAutoPayId: string
Maximum Length:
10
Auto Pay ID
Nested Schema : autopaySource
Type:
Show Source
object
-
autopaySourceCd: string
Maximum Length:
12
Auto Pay Source
Nested Schema : batchControl
Type:
Show Source
object
-
batchControl: string
Maximum Length:
8
Batch Control
Nested Schema : items
Type:
Show Source
object
-
action: string
Allowed Values:
[ "C1CN" ]
Payment Tender Web Service Actions: * `C1CN` - Cancel
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : C1CreatPayTe
Type:
Show Source
object
-
_self: string
_self
-
adjustment: object
adjustment
-
alternateCurrency: object
alternateCurrency
If the payment tender was remitted in an alternate currency, i.e. a currency other than the payor account's currency.
-
alternateTenderAmount: object
alternateTenderAmount
Tender Amount
-
autoPayClearing: object
autoPayClearing
-
cancelReason: object
cancelReason
If the payment is canceled, the Cancel Reason is displayed.
-
characteristics: object
characteristics
-
checkNumber: string
Maximum Length:
10
If a check was used for payment, the Check Number contains the identity of the check. -
currency: object
currency
Currency Code defines the currency in which the account's financial transactions are expressed.
-
customerId: string
Maximum Length:
36
Customer ID is the customer's account ID that appeared on the payment. -
encryptedMicrId: string
Maximum Length:
64
Encrypted MICR ID -
externalReferenceId: string
Maximum Length:
36
Ext. Reference ID is the unique identifier of the payment upload record. -
hashMicrId: string
Maximum Length:
88
A hash representation of MICR ID field. -
micrId: string
Maximum Length:
30
MICR ID is the value of the magnetic ink character recognition (MICR) line on the payment. -
name: string
Maximum Length:
40
Name is the customer's name on the payment record. -
paymentEvent: object
paymentEvent
-
paymentTenderId: string
Maximum Length:
12
Pay Tender ID is the system-assigned unique identifier of the tender.Example:221888888888
-
payorAccount: object
payorAccount
-
tenderAmount: number
Tender Amount is the amount of the tender. The amount is disabled if the payment was made in an alternate currency.Example:
$25.00
-
tenderControl: object
tenderControl
-
tenders: object
tenders
-
tenderStatus: string
Allowed Values:
[ "25 ", "60 " ]
Tender Status is the tender's status. * `25 ` - Valid, * `60 ` - CanceledExample:Valid
-
tenderType: object
tenderType
Tender Type describes what was remitted, such as cash or check.
-
tndrTypeNonCredit: string
(tndrTypeNonCredit)
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:1
Nested Schema : adjustment
Type:
Show Source
object
-
_link: string
_link
-
adjustmentId: string
Maximum Length:
12
Adjustment ID is displayed if there is an adjustment associated with the payment.
Nested Schema : alternateCurrency
Type:
object
If the payment tender was remitted in an alternate currency, i.e. a currency other than the payor account's currency.
Show Source
-
_link: string
_link
-
alternateCurrency: string
Maximum Length:
3
If the payment tender was remitted in an alternate currency, i.e. a currency other than the payor account's currency.
Nested Schema : alternateTenderAmount
Type:
object
Tender Amount
Show Source
-
_link: string
_link
-
alternateTenderAmount: number
Minimum Value:
-9.99999999999999E12
Maximum Value:9.99999999999999E12
Tender Amount
Nested Schema : autoPayClearing
Type:
Show Source
object
-
accountAutoPay: object
accountAutoPay
-
autopayClearingId: string
Maximum Length:
12
Auto Pay Clearing ID is PK of the auto pay staging record. -
autopayDistributeAndFreezeDate: string
(date)
The automatic payment is NOT distributed and frozen when the automatic payment is initially created. A separate background process distributes and freezes the automatic payment on the automatic payment GL distribution date . On the GL distribution date, the automatic payment will be interfaced to the general ledger.
-
autopaySource: object
autopaySource
Auto Pay Source Code is the financial institution or credit card company that receives the automatic payment request.
-
batchControl: object
batchControl
Batch Code is the batch code for which the tender control was created. If the tender controls are created for a background process, such as the automatic payment extract, Batch Code is displayed.
-
batchNumber: number
Minimum Value:
-9.999999999E9
Maximum Value:9.999999999E9
Batch Number is the batch number for which the tender control was created. If the tender controls are created for a background process, such as the automatic payment extract, Batch Number is displayed. -
bill: object
bill
-
encryptedExternalAccountId: string
Maximum Length:
108
External Account ID is used to define the customer's bank account or credit card number. The system supports encryption for the External Account ID. If your implementation has configured the system to encrypt the External Account ID, the data will be returned with a masked value, such as *******. -
entityName: string
Maximum Length:
254
Name is the customer's name in the financial institution's system. -
expireDate: string
(date)
Expires On is only needed if the Tender Type indicates that an expiration date is necessary, such as for a credit card payment.
-
externalAccountId: string
Maximum Length:
50
External Account ID is the customer's account number at the financial institution. -
scheduleExtractDate: string
(date)
Scheduled Extract Date is the date the automatic payment request was sent or is scheduled to be sent to the financial institution.
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:1
Nested Schema : cancelReason
Type:
object
If the payment is canceled, the Cancel Reason is displayed.
Show Source
-
_link: string
_link
-
cancelReason: string
Maximum Length:
4
Cancel Reason
Nested Schema : currency
Type:
object
Currency Code defines the currency in which the account's financial transactions are expressed.
Show Source
-
_link: string
_link
-
currency: string
Maximum Length:
3
Currency Code
Nested Schema : paymentEvent
Type:
Show Source
object
-
_link: string
_link
-
paymentEventId: string
Maximum Length:
12
Payment Event ID
Nested Schema : payorAccount
Type:
Show Source
object
-
_link: string
_link
-
payorAccountId: string
Maximum Length:
10
Account ID
Nested Schema : tenderControl
Type:
Show Source
object
-
_link: string
_link
-
tenderControlId: string
Maximum Length:
10
Tender Control ID is the identity of the remittance processor batch or cash drawer bundle in which the tender was remitted.Example:0225339900
Nested Schema : tenderType
Type:
object
Tender Type describes what was remitted, such as cash or check.
Show Source
-
_link: string
_link
-
tenderType: string
Maximum Length:
4
Tender Type
Nested Schema : accountAutoPay
Type:
Show Source
object
-
_link: string
_link
-
accountAutoPayId: string
Maximum Length:
10
Auto Pay ID is the unique, system-assigned identifier of the auto-pay record.
Nested Schema : autopaySource
Type:
object
Auto Pay Source Code is the financial institution or credit card company that receives the automatic payment request.
Show Source
-
_link: string
_link
-
autopaySourceCd: string
Maximum Length:
12
Auto Pay Source
Nested Schema : batchControl
Type:
object
Batch Code is the batch code for which the tender control was created. If the tender controls are created for a background process, such as the automatic payment extract, Batch Code is displayed.
Show Source
-
_link: string
_link
-
batchControl: string
Maximum Length:
8
Batch Code is the batch code for which the tender control was created. If the tender controls are created for a background process, such as the automatic payment extract, Batch Code is displayed.
Nested Schema : bill
Type:
Show Source
object
-
_link: string
_link
-
billId: string
Maximum Length:
12
Bill ID
Nested Schema : items
Type:
Show Source
object
-
characteristicType: object
characteristicType
-
characteristicValue: object
characteristicValue
-
effectiveDate: string
(date)
Effective Date defines the date on which the characteristic becomes effective. The effective date defaults from the Installation Record.Example:
2016-01-01
-
typeOfCharacteristicValue: string
Maximum Length:
4
Characteristic Value indicates the value of the characteristic if the characteristic type is pre-defined or foreign key reference.Example:02-20-2008
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:1
Nested Schema : characteristicType
Type:
Show Source
object
-
_link: string
_link
-
characteristicType: string
Maximum Length:
8
Characteristic Type
Nested Schema : characteristicValue
Type:
Show Source
object
-
_link: string
(_link)
-
value: string
(value)
-
value2: string
(value2)
-
value3: string
(value3)
-
value4: string
(value4)
-
value5: string
(value5)
Nested Schema : items
Type:
Show Source
object
-
adjustment: object
adjustment
-
alternateCurrency: object
alternateCurrency
-
altTenderAmount2: number
Minimum Value:
-9.99999999999999E12
Maximum Value:9.99999999999999E12
Tender Amount -
autoPayClearing: object
autoPayClearing
-
cancelReason: object
cancelReason
-
checkNumber: string
Maximum Length:
10
Check Number -
currency: object
currency
-
customerId: string
Maximum Length:
36
Customer ID is the customer's account ID that appeared on the payment. -
encryptedMicrId2: string
Maximum Length:
64
Encrypted MICR ID -
externalReferenceId2: string
Maximum Length:
36
Ext. Reference ID is the unique identifier of the payment upload record. -
hashMicrId2: string
Maximum Length:
88
A hash representation of MICR ID field. -
isIncludedInTenderControlBalance: boolean
Included in Tender Ctl Balance
-
micrId2: string
Maximum Length:
30
MICR ID is the value of the magnetic ink character recognition (MICR) line on the payment. -
name: string
Maximum Length:
40
Name is the customer's name on the payment record. -
nextActions: object
nextActions
-
paymentTenderId: string
Maximum Length:
12
Pay Tender ID is the system-assigned unique identifier of the tender.Example:221888888888
-
payorAccount: object
payorAccount
-
tenderAmount: number
Tender Amount is the amount of the tender. The amount is disabled if the payment was made in an alternate currency.Example:
$25.00
-
tenderControl: object
tenderControl
-
tenderStatus: string
Allowed Values:
[ "25 ", "60 " ]
Tender Status is the tender's status. * `25 ` - Valid, * `60 ` - CanceledExample:Valid
-
tenderType: object
tenderType
-
tndrTypeNonCredit: string
(tndrTypeNonCredit)
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:1
Nested Schema : adjustment
Type:
Show Source
object
-
_link: string
_link
-
adjustmentId: string
Maximum Length:
12
Adjustment ID
Nested Schema : alternateCurrency
Type:
Show Source
object
-
_link: string
_link
-
alternateCurrency: string
Maximum Length:
3
Alternate Currency Code
Nested Schema : autoPayClearing
Type:
Show Source
object
-
accountAutoPay: object
accountAutoPay
-
autopayClearingId: string
Maximum Length:
12
Auto Pay Clearing ID is PK of the auto pay staging record. -
autopayDistributeAndFreezeDate: string
(date)
The automatic payment is NOT distributed and frozen when the automatic payment is initially created. A separate background process distributes and freezes the automatic payment on the automatic payment GL distribution date . On the GL distribution date, the automatic payment will be interfaced to the general ledger.
-
autopaySource: object
autopaySource
-
batchControl: object
batchControl
-
batchNumber: number
Minimum Value:
-9.999999999E9
Maximum Value:9.999999999E9
Batch Number is the batch number for which the tender control was created. If the tender controls are created for a background process, such as the automatic payment extract, Batch Number is displayed. -
bill: object
bill
-
encryptedExternalAccountId: string
Maximum Length:
108
External Account ID is used to define the customer's bank account or credit card number. The system supports encryption for the External Account ID. If your implementation has configured the system to encrypt the External Account ID, the data will be returned with a masked value, such as *******. -
entityName: string
Maximum Length:
254
Name is the customer's name in the financial institution's system. -
expireDate: string
(date)
Expires On is only needed if the Tender Type indicates that an expiration date is necessary, such as for a credit card payment.
-
externalAccountId: string
Maximum Length:
50
External Account ID is the customer's account number at the financial institution. -
scheduleExtractDate: string
(date)
Scheduled Extract Date is the date the automatic payment request was sent or is scheduled to be sent to the financial institution.
-
version3: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:1
Nested Schema : cancelReason
Type:
Show Source
object
-
_link: string
_link
-
cancelReason: string
Maximum Length:
4
Cancel Reason
Nested Schema : currency
Type:
Show Source
object
-
_link: string
_link
-
currency: string
Maximum Length:
3
Currency Code
Nested Schema : payorAccount
Type:
Show Source
object
-
_link: string
_link
-
payorAccountId: string
Maximum Length:
10
Account ID
Nested Schema : tenderControl
Type:
Show Source
object
-
_link: string
_link
-
tenderControlId: string
Maximum Length:
10
Tender Control ID
Nested Schema : tenderType
Type:
Show Source
object
-
_link: string
_link
-
tenderType: string
Maximum Length:
4
Tender Type
Nested Schema : accountAutoPay
Type:
Show Source
object
-
_link: string
_link
-
accountAutoPayId: string
Maximum Length:
10
Auto Pay ID
Nested Schema : autopaySource
Type:
Show Source
object
-
_link: string
_link
-
autopaySourceCd: string
Maximum Length:
12
Auto Pay Source
Nested Schema : batchControl
Type:
Show Source
object
-
_link: string
_link
-
batchControl: string
Maximum Length:
8
Batch Control
Nested Schema : bill
Type:
Show Source
object
-
_link: string
_link
-
billId: string
Maximum Length:
12
Bill ID
Nested Schema : items
Type:
Show Source
object
-
action: string
Allowed Values:
[ "C1CN" ]
Payment Tender Web Service Actions: * `C1CN` - Cancel
400 Response
Bad Request
Root Schema : problemDetailDocument
Type:
Show Source
object
-
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.
Nested Schema : serverMessage
Type:
Show Source
object
-
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.
500 Response
Internal Server Error
Root Schema : problemDetailDocument
Type:
Show Source
object
-
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.
Nested Schema : serverMessage
Type:
Show Source
object
-
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.