Get payment data
get
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentCommunications/{PaymentHistoryKey}
Request
Path Parameters
-
PaymentHistoryKey(required): integer
A unique identifier for the payment transaction.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields 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 fields 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 fields. 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 fields. Only the specified fields are returned, which means that if no fields are specified, no fields 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 fields. 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 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : publicSectorPaymentCommunications-item-response
Type:
Show Source
object
-
AmountDue: number
Title:
Amount Due
Read Only:true
The total payment amount due, which is the sum total of the amounts on the payment history lines. -
BusinessEntityDbaName: string
Read Only:
true
Maximum Length:100
Doing business as name of the business making the payment. -
BusinessEntityName: string
Read Only:
true
Maximum Length:100
Entity name of the business making the payment. -
BusinessEntityPartyId: integer
(int64)
Read Only:
true
The unique identifier for the business entity party associated with this transaction. -
CreditAmountApplied: number
Title:
Credit Amount Applied
Read Only:true
The amount of credit applied to the payment. -
CreditAmountAvailable: number
Title:
Credit Amount Available
Read Only:true
The amount available to apply a payment on account credit. -
CreditAppliedFlag: string
Title:
Credit Applied
Read Only:true
Maximum Length:1
The payment on account credit is applied. -
CreditCardDigits: integer
(int32)
Title:
Credit Card Digits
Read Only:true
The last four digits of the credit card number used for a payment. -
CreditCardType: string
Title:
Credit Card Type
Read Only:true
Maximum Length:4
The type of credit card used for a payment. Examples are Mastercard and Visa. -
DepartmentId: string
Title:
Department ID
Read Only:true
Maximum Length:30
Indicates the department ID. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartyId: integer
(int64)
Read Only:
true
The unique identifier for the party associated with this transaction. -
PayerAddress: string
Read Only:
true
Maximum Length:240
The address of the person who made the payment. -
PayerEmail: string
Title:
Email
Read Only:true
Maximum Length:320
Email address of the payer for a payment transaction. -
PayerFirstName: string
Title:
First Name
Read Only:true
Maximum Length:150
The first name of the payer for a payment transaction. -
PayerLastName: string
Title:
Last Name
Read Only:true
Maximum Length:150
The last name of the payer for a payment transaction. -
PayerMiddleName: string
Title:
Middle Name
Read Only:true
Maximum Length:60
The middle name of the payer for a payment transaction. -
PayerName: string
Read Only:
true
Maximum Length:100
The name of the person who made the payment. -
PayerNameSuffix: string
Title:
Suffix
Read Only:true
Maximum Length:30
Suffix for the name of the payer for a payment transaction. -
PaymentAmount: number
Title:
Amount Paid
Read Only:true
Total payment amount authorized and settled by the payment gateway or verified by the trust account system. -
PaymentCurrency: string
Title:
Currency
Read Only:true
Maximum Length:3
Currency used for the payment transaction. -
PaymentDate: string
(date)
Title:
Receipt Date
Read Only:true
Date on which the payment transaction occurred. -
PaymentHistoryKey: integer
Read Only:
true
A unique identifier for the payment transaction. -
PaymentMethod: string
Title:
Payment Method
Read Only:true
Maximum Length:80
Method of payment used for a payment transaction, such as credit card, cash, personal check, or cashier???s check. -
PaymentReferenceId: string
Title:
Payment Reference ID
Read Only:true
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: string
Title:
Reference
Read Only:true
Maximum Length:50
The identifying attribute passed during checkout by the originator of the assessed fees. -
PaymentTrackingDataPlus: string
Title:
Additional Reference
Read Only:true
Maximum Length:50
The additional identifying attribute passed during checkout by the originator of the assessed fees. -
RecordType: string
Title:
Record Type
Read Only:true
Maximum Length:30
Indicates the record type. -
ServiceChargeAmount: number
Title:
Service Charge Amount
Read Only:true
The convenience fee assessed by the department for using a specific payment method. -
ServiceChargeCurrency: string
Title:
Service Charge Currency
Read Only:true
Maximum Length:3
The currency used for the service charge. -
TrustAccountNumber: string
Title:
Deposit Account Number
Read Only:true
Maximum Length:30
An attribute that identifies the logical trust account number.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.