Create payment data
post
/fscmRestApi/resources/11.13.18.05/publicSectorPayments
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorPayments-item
Type:
Show Source
object-
Address1(optional):
string
Maximum Length:
240First line of the payer billing address. Requires a valid street number and name. -
Address2(optional):
string
Maximum Length:
240Second line of the payer billing address such as apartment, suite, unit, building, floor, or village information. -
Address3(optional):
string
Maximum Length:
240Third line of the payer billing address. -
Address4(optional):
string
Maximum Length:
240Fourth line of the payer billing address. -
AgencyId(optional):
integer(int64)
The unique identifier of the agency associated with the payment transaction.
-
AuthorizationCode(optional):
string
Maximum Length:
10Authorization code value returned by the payment gateway or trust account system. -
AuthorizationStatus(optional):
string
Maximum Length:
4The status value returned by the payment gateway or trust account system. -
CreditCardDigits(optional):
integer(int64)
Title:
Credit Card DigitsThe last four digits of the credit card number used for a payment. -
CreditCardType(optional):
string
Title:
Credit Card TypeMaximum Length:4The type of credit card used for a payment. Examples are Mastercard and Visa. -
FirstResponseMessage(optional):
string
Maximum Length:
100First part of the response message returned by the payment gateway or a free form message entered by agency staff for cash drawer or trust account. -
links(optional):
array Items
Title:
ItemsLink Relations -
Meaning(optional):
string
Maximum Length:
80Payment method description. -
PartyId(optional):
integer(int64)
The unique identifier for the party associated with this transaction.
-
PayerCity(optional):
string
Maximum Length:
60City of the payer billing address. -
PayerCountryThreeCharacterCode(optional):
string
Maximum Length:
3International three-digit country code call prefix of the payer's phone number. -
PayerCountryTwoCharacterCode(optional):
string
Maximum Length:
2International two-digit country code call prefix of the payer's phone number. -
PayerCounty(optional):
string
Maximum Length:
60County of the payer billing address. This is a geographical subdivision within a state or region and encompasses multiple cities. -
PayerEmail(optional):
string
Title:
EmailMaximum Length:320Email address of the payer for a payment transaction. -
PayerFirstName(optional):
string
Title:
First NameMaximum Length:150The first name of the payer for a payment transaction. -
PayerLastName(optional):
string
Title:
Last NameMaximum Length:150The last name of the payer for a payment transaction. -
PayerMiddleName(optional):
string
Title:
Middle NameMaximum Length:60The middle name of the payer for a payment transaction. -
PayerNameSuffix(optional):
string
Title:
SuffixMaximum Length:30Suffix for the name of the payer for a payment transaction. -
PayerPhone(optional):
string
Maximum Length:
60Phone number of the person making the payment. -
PayerPostalAddOnCode(optional):
string
Maximum Length:
10Additional digits used to identify a specific mail delivery route. -
PayerPostalCode(optional):
string
Maximum Length:
60Postal code of the payer billing address. Can be a series of digits or letters or both. -
PayerProvince(optional):
string
Maximum Length:
60Region code for the payer billing address in non-US countries. In Canada, this is the two character province abbreviation by the Canada Post. -
PayerState(optional):
string
Maximum Length:
60State code of the payer billing address. In the U.S, this is the two character USPS state abbreviation. For example, NY for New York. -
PaymentAdapterId(optional):
string
Maximum Length:
100The unique identifier of the payment adapter associated with the agency and payment method. -
PaymentAmount(optional):
number
Title:
Amount PaidTotal payment amount authorized and settled by the payment gateway or verified by the trust account system. -
PaymentCurrency(optional):
string
Title:
CurrencyMaximum Length:3Currency used for the payment transaction. -
PaymentDate(optional):
string(date)
Title:
Receipt DateDate on which the payment transaction occurred. -
PaymentHistoryKey(optional):
integer(int64)
The unique identifier for the payment transaction.
-
PaymentHistoryLine(optional):
array Payment Lines
Title:
Payment LinesThe payments resource is used to view or create payment records. -
PaymentMethodCode(optional):
string
Maximum Length:
30Method of payment used for a payment transaction, such as credit card, cash, personal check, or cashier's check. -
PaymentReferenceId(optional):
string
Title:
Payment Reference IDMaximum Length:50A reference value created by the payment module and sent as pass through data to the payment processor, trust account, and cash drawer. -
PaymentTrackingData(optional):
string
Title:
ReferenceMaximum Length:50The identifying attribute passed during checkout by the originator of the assessed fees. -
PaymentTrackingDataPlus(optional):
string
Title:
Additional ReferenceMaximum Length:50The additional identifying attribute passed during checkout by the originator of the assessed fees. -
PaymentTransactionId(optional):
string
Maximum Length:
50The unique identifier of the transaction that is received from the payment gateway or from the trust account system. -
ProfileId(optional):
integer(int64)
The unique identifier for the profile of the user associated with this transaction.
-
SecondResponseMessage(optional):
string
Maximum Length:
100Second part of the response message returned by the payment gateway or a free form message entered by agency staff for cash drawer or trust account. -
ServiceChargeAmount(optional):
number
Convenience fee assessed by the department for using a specific payment method.
-
ServiceChargeCurrency(optional):
string
Maximum Length:
3Currency used for the service charge. -
ThirdResponseMessage(optional):
string
Maximum Length:
100Third part of the response message returned by the payment gateway or a free form message entered by agency staff for cash drawer or trust account. -
TrustAccountNumber(optional):
string
Title:
Trust Account NumberMaximum Length:30An attribute that identifies the logical trust account number.
Nested Schema : Payment Lines
Type:
arrayTitle:
Payment LinesThe payments resource is used to view or create payment records.
Show Source
Nested Schema : link
Type:
Show Source
object-
href(optional):
string
Title:
hyperlink referenceThe URI to the related resource. -
rel(optional):
string
Title:
relationThe name of the relation to the resource instance. Example: self.
Nested Schema : publicSectorPayments-PaymentHistoryLine-item
Type:
Show Source
object-
AgencyId(optional):
integer(int64)
The unique identifier of the agency associated with the row.
-
ApplicationReferenceId(optional):
string
Maximum Length:
50Key identifier as the header passed by the consuming application. For example, the CART_ID value from the Pay Cart. -
ApplicationReferenceIdPlus(optional):
string
Maximum Length:
50Additional key identifier passed by the consuming application. -
Classification(optional):
string
Maximum Length:
3Source application that generated the fee. -
ItemCurrency(optional):
string
Maximum Length:
3Currency code for both the unit price and tax amount. -
ItemDescription(optional):
string
Maximum Length:
50Item description provided by the requesting application. -
ItemLine(optional):
integer(int64)
Item line provided by the requesting application. When none is provided, it is set to zero.
-
ItemName(optional):
string
Maximum Length:
30Item name provided by the requesting application. -
ItemRecKey(optional):
integer(int64)
The key value for the item in the payment line.
-
ItemReference(optional):
string
Maximum Length:
50Custom reference value provided by the requesting application. -
ItemTaxAmount(optional):
number
Tax amount assessed for the transaction.
-
ItemUnitPrice(optional):
number
Base price of the item being paid by the payment transaction.
-
links(optional):
array Items
Title:
ItemsLink Relations -
PaymentHistoryKey(optional):
integer(int64)
The unique identifier for the payment transaction.
-
RecordId(optional):
string
Maximum Length:
50Source application's record identifier. -
RecordTypeId(optional):
string
Maximum Length:
30Source application's record type.
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorPayments-item
Type:
Show Source
object-
Address1(optional):
string
Maximum Length:
240First line of the payer billing address. Requires a valid street number and name. -
Address2(optional):
string
Maximum Length:
240Second line of the payer billing address such as apartment, suite, unit, building, floor, or village information. -
Address3(optional):
string
Maximum Length:
240Third line of the payer billing address. -
Address4(optional):
string
Maximum Length:
240Fourth line of the payer billing address. -
AgencyId(optional):
integer(int64)
The unique identifier of the agency associated with the payment transaction.
-
AuthorizationCode(optional):
string
Maximum Length:
10Authorization code value returned by the payment gateway or trust account system. -
AuthorizationStatus(optional):
string
Maximum Length:
4The status value returned by the payment gateway or trust account system. -
CreditCardDigits(optional):
integer(int64)
Title:
Credit Card DigitsThe last four digits of the credit card number used for a payment. -
CreditCardType(optional):
string
Title:
Credit Card TypeMaximum Length:4The type of credit card used for a payment. Examples are Mastercard and Visa. -
FirstResponseMessage(optional):
string
Maximum Length:
100First part of the response message returned by the payment gateway or a free form message entered by agency staff for cash drawer or trust account. -
links(optional):
array Items
Title:
ItemsLink Relations -
Meaning(optional):
string
Maximum Length:
80Payment method description. -
PartyId(optional):
integer(int64)
The unique identifier for the party associated with this transaction.
-
PayerCity(optional):
string
Maximum Length:
60City of the payer billing address. -
PayerCountryThreeCharacterCode(optional):
string
Maximum Length:
3International three-digit country code call prefix of the payer's phone number. -
PayerCountryTwoCharacterCode(optional):
string
Maximum Length:
2International two-digit country code call prefix of the payer's phone number. -
PayerCounty(optional):
string
Maximum Length:
60County of the payer billing address. This is a geographical subdivision within a state or region and encompasses multiple cities. -
PayerEmail(optional):
string
Title:
EmailMaximum Length:320Email address of the payer for a payment transaction. -
PayerFirstName(optional):
string
Title:
First NameMaximum Length:150The first name of the payer for a payment transaction. -
PayerLastName(optional):
string
Title:
Last NameMaximum Length:150The last name of the payer for a payment transaction. -
PayerMiddleName(optional):
string
Title:
Middle NameMaximum Length:60The middle name of the payer for a payment transaction. -
PayerNameSuffix(optional):
string
Title:
SuffixMaximum Length:30Suffix for the name of the payer for a payment transaction. -
PayerPhone(optional):
string
Maximum Length:
60Phone number of the person making the payment. -
PayerPostalAddOnCode(optional):
string
Maximum Length:
10Additional digits used to identify a specific mail delivery route. -
PayerPostalCode(optional):
string
Maximum Length:
60Postal code of the payer billing address. Can be a series of digits or letters or both. -
PayerProvince(optional):
string
Maximum Length:
60Region code for the payer billing address in non-US countries. In Canada, this is the two character province abbreviation by the Canada Post. -
PayerState(optional):
string
Maximum Length:
60State code of the payer billing address. In the U.S, this is the two character USPS state abbreviation. For example, NY for New York. -
PaymentAdapterId(optional):
string
Maximum Length:
100The unique identifier of the payment adapter associated with the agency and payment method. -
PaymentAmount(optional):
number
Title:
Amount PaidTotal payment amount authorized and settled by the payment gateway or verified by the trust account system. -
PaymentCurrency(optional):
string
Title:
CurrencyMaximum Length:3Currency used for the payment transaction. -
PaymentDate(optional):
string(date)
Title:
Receipt DateDate on which the payment transaction occurred. -
PaymentHistoryKey(optional):
integer(int64)
The unique identifier for the payment transaction.
-
PaymentHistoryLine(optional):
array Payment Lines
Title:
Payment LinesThe payments resource is used to view or create payment records. -
PaymentMethodCode(optional):
string
Maximum Length:
30Method of payment used for a payment transaction, such as credit card, cash, personal check, or cashier's check. -
PaymentReferenceId(optional):
string
Title:
Payment Reference IDMaximum Length:50A reference value created by the payment module and sent as pass through data to the payment processor, trust account, and cash drawer. -
PaymentTrackingData(optional):
string
Title:
ReferenceMaximum Length:50The identifying attribute passed during checkout by the originator of the assessed fees. -
PaymentTrackingDataPlus(optional):
string
Title:
Additional ReferenceMaximum Length:50The additional identifying attribute passed during checkout by the originator of the assessed fees. -
PaymentTransactionId(optional):
string
Maximum Length:
50The unique identifier of the transaction that is received from the payment gateway or from the trust account system. -
ProfileId(optional):
integer(int64)
The unique identifier for the profile of the user associated with this transaction.
-
SecondResponseMessage(optional):
string
Maximum Length:
100Second part of the response message returned by the payment gateway or a free form message entered by agency staff for cash drawer or trust account. -
ServiceChargeAmount(optional):
number
Convenience fee assessed by the department for using a specific payment method.
-
ServiceChargeCurrency(optional):
string
Maximum Length:
3Currency used for the service charge. -
ThirdResponseMessage(optional):
string
Maximum Length:
100Third part of the response message returned by the payment gateway or a free form message entered by agency staff for cash drawer or trust account. -
TrustAccountNumber(optional):
string
Title:
Trust Account NumberMaximum Length:30An attribute that identifies the logical trust account number.
Nested Schema : Payment Lines
Type:
arrayTitle:
Payment LinesThe payments resource is used to view or create payment records.
Show Source
Nested Schema : link
Type:
Show Source
object-
href(optional):
string
Title:
hyperlink referenceThe URI to the related resource. -
rel(optional):
string
Title:
relationThe name of the relation to the resource instance. Example: self.
Nested Schema : publicSectorPayments-PaymentHistoryLine-item
Type:
Show Source
object-
AgencyId(optional):
integer(int64)
The unique identifier of the agency associated with the row.
-
ApplicationReferenceId(optional):
string
Maximum Length:
50Key identifier as the header passed by the consuming application. For example, the CART_ID value from the Pay Cart. -
ApplicationReferenceIdPlus(optional):
string
Maximum Length:
50Additional key identifier passed by the consuming application. -
Classification(optional):
string
Maximum Length:
3Source application that generated the fee. -
ItemCurrency(optional):
string
Maximum Length:
3Currency code for both the unit price and tax amount. -
ItemDescription(optional):
string
Maximum Length:
50Item description provided by the requesting application. -
ItemLine(optional):
integer(int64)
Item line provided by the requesting application. When none is provided, it is set to zero.
-
ItemName(optional):
string
Maximum Length:
30Item name provided by the requesting application. -
ItemRecKey(optional):
integer(int64)
The key value for the item in the payment line.
-
ItemReference(optional):
string
Maximum Length:
50Custom reference value provided by the requesting application. -
ItemTaxAmount(optional):
number
Tax amount assessed for the transaction.
-
ItemUnitPrice(optional):
number
Base price of the item being paid by the payment transaction.
-
links(optional):
array Items
Title:
ItemsLink Relations -
PaymentHistoryKey(optional):
integer(int64)
The unique identifier for the payment transaction.
-
RecordId(optional):
string
Maximum Length:
50Source application's record identifier. -
RecordTypeId(optional):
string
Maximum Length:
30Source application's record type.