Get a set of checkout payment data
get
/fscmRestApi/resources/11.13.18.05/publicSectorCheckouts/{CheckoutId}/child/CheckoutPmt/{CheckoutPmtUniqID}
Request
Path Parameters
-
CheckoutId(required): string
The unique identifier for the checkout data. Generated using the Fusion unique ID API.
-
CheckoutPmtUniqID(required): string
This is the hash key of the attributes which make up the composite key--- CheckoutId and CheckoutPmtId ---for the Checkout Payments resource and used to uniquely identify an instance of Checkout Payments. The client should not generate the hash key value. Instead, the client should query on the Checkout Payments collection resource with a filter on the primary key values in order to navigate to a specific instance of Checkout Payments.
For example: CheckoutPmt?q=CheckoutId=<value1>;CheckoutPmtId=<value2>
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:
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.
Root Schema : publicSectorCheckouts-CheckoutPmt-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Identifies the identifier associated with an agency.
-
AuthorizationCode: string
Maximum Length:
10
Authorization code value returned by the payment gateway or trust account system. -
AuthorizationDttm: string
(date-time)
Authorization date and time returned by payment gateway system or trust account system.
-
AuthorizationStatus: string
Maximum Length:
4
The status value returned by the payment gateway or trust account system. -
CashierId: string
Maximum Length:
50
The unique identifier for the cashier. -
ChangeAmount: number
The amount of money to be handed back to the payer if the payment received from the payer is more than the amount due.
-
CheckAddress: string
Maximum Length:
240
The address on the check. -
CheckDate: string
(date)
The date that the check was received from the payer.
-
CheckName: string
Maximum Length:
100
The name on the check. -
CheckNumber: string
Maximum Length:
10
The number of the check that was received from the payer. -
CheckoutId: string
Maximum Length:
50
Unique identifier for the checkout data. Generated using the Fusion unique ID API. -
CheckoutPmtId: integer
(int64)
Unique sequence number for the checkout payment row generated using the Fusion unique ID API.
-
Comments: string
Maximum Length:
240
Comments provided for the payment. -
Description: string
Maximum Length:
100
Description provided for the payment. -
DrawerId: string
Maximum Length:
30
The unique identifier for the cash drawer. -
FirstResponseMessage: 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. -
LineAmount: number
That dollar amount that applies to a line item.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PayerAddress: string
Maximum Length:
240
The address of the person who made the payment. -
PayerName: string
Maximum Length:
100
The name of the person who made the payment. -
PaymentCurrency: string
Maximum Length:
3
Currency used for the payment transaction. -
PaymentDate: string
(date)
Date on which the payment transaction occurred.
-
PaymentMethodCode: string
Maximum Length:
30
Type of payment selected during checkout. -
PaymentReferenceId: string
Maximum Length:
50
Global unique payment identifier that comprises a 4-character prefix and random digits. -
PaymentTrackingData: string
Maximum Length:
50
The identifying attribute passed during checkout by the originator of the assessed fees. -
PaymentTrackingDataPlus: string
Maximum Length:
50
The additional identifying attribute passed during checkout by the originator of the assessed fees. -
PaymentTransactionId: string
Maximum Length:
50
Transaction ID/reference number received from the payment gateway or trust account system. -
PrimaryId: string
Maximum Length:
3
The unique identifier for the primary document used to identify the payer of a cash drawer check payment. -
SecondaryId: string
Maximum Length:
3
The unique identifier for the secondary document used to identify the payer of a cash drawer check payment. -
SecondResponseMessage: 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. -
SessionId: string
Maximum Length:
50
The unique identifier for the cashier session. -
ThirdResponseMessage: 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. -
TotalTendAmount: number
The total amount of money received in payment from the payer. If this amount is more than the amount due, the difference is handed back to the payer.
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.