Get a payment record
get
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentRecords/{publicSectorPaymentRecordsUniqID}
Request
Path Parameters
-
publicSectorPaymentRecordsUniqID: integer
This is the hash key of the attributes which make up the composite key--- PaymentHistoryKey and ItemRecKey ---for the Payment Records resource and used to uniquely identify an instance of Payment Records. The client should not generate the hash key value. Instead, the client should query on the Payment Records collection resource with a filter on the primary key values in order to navigate to a specific instance of Payment Records.
For example: publicSectorPaymentRecords?q=PaymentHistoryKey=<value1>;ItemRecKey=<value2>
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 : publicSectorPaymentRecords-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.
-
BusinessEntityDbaName(optional):
string
Maximum Length:
100
Doing business as name of the business making the payment. -
BusinessEntityId(optional):
string
Maximum Length:
50
The unique identifier for the business entity associated with this transaction. -
BusinessEntityName(optional):
string
Maximum Length:
100
Entity name of the business making the payment. -
BusinessEntityPartyId(optional):
integer(int64)
The unique identifier for the business entity party associated with this transaction.
-
BusinessLocationId(optional):
string
Maximum Length:
50
The unique identifier for the location of the business entity. -
BusinessLocationPartyId(optional):
integer(int64)
The unique identifier for the party associated with the business entity location.
-
BusinessProfileId(optional):
integer(int64)
The unique identifier for the profile of the business entity associated with this transaction
-
Classification(optional):
string
Maximum Length:
3
Source application that generated the fee. -
CreditCardDigits(optional):
integer(int64)
The last four digits of the credit card number used for a payment.
-
CreditCardType(optional):
string
Maximum Length:
4
The type of credit card used for a payment. Examples are Mastercard and Visa. -
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 -
Meaning(optional):
string
Maximum Length:
80
Identifies the meaning that is associated with the payment method value. -
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. -
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
Maximum Length:
320
Email address of the payer for a payment transaction. -
PayerFirstName(optional):
string
Maximum Length:
150
The first name of the payer for a payment transaction. -
PayerLastName(optional):
string
Maximum Length:
150
The last name of the payer for a payment transaction. -
PayerMiddleName(optional):
string
Maximum Length:
60
The middle name of the payer for a payment transaction. -
PayerPhone(optional):
string
Maximum Length:
60
Phone number of the person making the payment. -
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. -
PaymentDate(optional):
string(date)
Date on which the payment transaction occurred.
-
PaymentHistoryKey(optional):
integer(int64)
The unique identifier for the payment transaction.
-
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
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. -
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.
-
RecordId(optional):
string
Maximum Length:
50
Source application's record identifier. -
RecordTypeId(optional):
string
Maximum Length:
30
Source application's record type. -
TrustAccountNumber(optional):
string
Maximum Length:
30
An attribute that identifies the logical trust account number.
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.