Get payment data
get
/fscmRestApi/resources/11.13.18.05/publicSectorPayments/{PaymentHistoryKey}
Request
Path Parameters
-
PaymentHistoryKey: integer
The unique identifier for the payment transaction.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource attributes. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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:
240
First line of the payer billing address. Requires a valid street number and name. -
Address2(optional):
string
Maximum Length:
240
Second line of the payer billing address such as apartment, suite, unit, building, floor, or village information. -
Address3(optional):
string
Maximum Length:
240
Third line of the payer billing address. -
Address4(optional):
string
Maximum Length:
240
Fourth 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:
10
Authorization code value returned by the payment gateway or trust account system. -
AuthorizationStatus(optional):
string
Maximum Length:
4
The status value returned by the payment gateway or trust account system. -
CreditCardDigits(optional):
integer(int64)
Title:
Credit Card Digits
The last four digits of the credit card number used for a payment. -
CreditCardType(optional):
string
Title:
Credit Card Type
Maximum Length:4
The type of credit card used for a payment. Examples are Mastercard and Visa. -
FirstResponseMessage(optional):
string
Maximum Length:
100
First 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:
Items
Link Relations -
Meaning(optional):
string
Maximum Length:
80
Payment method description. -
PartyId(optional):
integer(int64)
The unique identifier for the party associated with this transaction.
-
PayerCity(optional):
string
Maximum Length:
60
City of the payer billing address. -
PayerCountryThreeCharacterCode(optional):
string
Maximum Length:
3
International three-digit country code call prefix of the payer's phone number. -
PayerCountryTwoCharacterCode(optional):
string
Maximum Length:
2
International two-digit country code call prefix of the payer's phone number. -
PayerCounty(optional):
string
Maximum Length:
60
County of the payer billing address. This is a geographical subdivision within a state or region and encompasses multiple cities. -
PayerEmail(optional):
string
Title:
Email
Maximum Length:320
Email address of the payer for a payment transaction. -
PayerFirstName(optional):
string
Title:
First Name
Maximum Length:150
The first name of the payer for a payment transaction. -
PayerLastName(optional):
string
Title:
Last Name
Maximum Length:150
The last name of the payer for a payment transaction. -
PayerMiddleName(optional):
string
Title:
Middle Name
Maximum Length:60
The middle name of the payer for a payment transaction. -
PayerNameSuffix(optional):
string
Title:
Suffix
Maximum Length:30
Suffix for the name of the payer for a payment transaction. -
PayerPhone(optional):
string
Maximum Length:
60
Phone number of the person making the payment. -
PayerPostalAddOnCode(optional):
string
Maximum Length:
10
Additional digits used to identify a specific mail delivery route. -
PayerPostalCode(optional):
string
Maximum Length:
60
Postal code of the payer billing address. Can be a series of digits or letters or both. -
PayerProvince(optional):
string
Maximum Length:
60
Region 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:
60
State 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:
100
The unique identifier of the payment adapter associated with the agency and payment method. -
PaymentAmount(optional):
number
Title:
Amount Paid
Total payment amount authorized and settled by the payment gateway or verified by the trust account system. -
PaymentCurrency(optional):
string
Title:
Currency
Maximum Length:3
Currency used for the payment transaction. -
PaymentDate(optional):
string(date)
Title:
Receipt Date
Date on which the payment transaction occurred. -
PaymentHistoryKey(optional):
integer(int64)
The unique identifier for the payment transaction.
-
PaymentHistoryLine(optional):
array Payment Lines
Title:
Payment Lines
The payments resource is used to view or create payment records. -
PaymentMethodCode(optional):
string
Maximum Length:
30
Method of payment used for a payment transaction, such as credit card, cash, personal check, or cashier's check. -
PaymentReferenceId(optional):
string
Title:
Payment Reference ID
Maximum Length:50
A 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:
Reference
Maximum Length:50
The identifying attribute passed during checkout by the originator of the assessed fees. -
PaymentTrackingDataPlus(optional):
string
Title:
Additional Reference
Maximum Length:50
The additional identifying attribute passed during checkout by the originator of the assessed fees. -
PaymentTransactionId(optional):
string
Maximum Length:
50
The 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:
100
Second 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:
3
Currency used for the service charge. -
ThirdResponseMessage(optional):
string
Maximum Length:
100
Third 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 Number
Maximum Length:30
An attribute that identifies the logical trust account number.
Nested Schema : Payment Lines
Type:
array
Title:
Payment Lines
The payments resource is used to view or create payment records.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The 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:
50
Key identifier as the header passed by the consuming application. For example, the CART_ID value from the Pay Cart. -
ApplicationReferenceIdPlus(optional):
string
Maximum Length:
50
Additional key identifier passed by the consuming application. -
Classification(optional):
string
Maximum Length:
3
Source application that generated the fee. -
ItemCurrency(optional):
string
Maximum Length:
3
Currency code for both the unit price and tax amount. -
ItemDescription(optional):
string
Maximum Length:
50
Item 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:
30
Item 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:
50
Custom 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:
Items
Link Relations -
PaymentHistoryKey(optional):
integer(int64)
The unique identifier for the payment transaction.
-
RecordId(optional):
string
Maximum Length:
50
Source application's record identifier. -
RecordTypeId(optional):
string
Maximum Length:
30
Source application's record type.