Get a fee or deposit to be reversed
get
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentReversals/{PaymentReversalKey}
Request
Path Parameters
-
PaymentReversalKey(required): integer(int64)
The unique identifier of the reversal 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:
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 : publicSectorPaymentReversals-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
The unique identifier of the agency record.
-
BalanceAmount: number
Default Value:
0
Indicates the balance amount that has not been reversed. -
Classification: string
Maximum Length:
3
The identifier assigned to classify a source record. -
DepositAccountKey: integer
(int64)
The unique identifier of the deposit account record.
-
DepositActivityKey: integer
(int64)
The unique identifier of the deposit activity record.
-
FullReversalFlag: string
Maximum Length:
1
Default Value:Y
Indicates whether the full payment has been reversed. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MessageName: string
Maximum Length:
120
The unique name of the message that is populated by the payment reversal process. -
PaymentMethodCode: string
Maximum Length:
30
The method of payment used for a payment transaction, such as credit card, cash, personal check, or cashier???s check. -
PaymentReferenceId: string
Maximum Length:
50
The reference ID of the payment stored on the payment reversal record. -
PaymentReversalKey: integer
(int64)
Read Only:
true
The unique identifier of the reversal transaction. -
ReceiptLineNumber: integer
(int32)
The line number assigned to each receipt on the cash drawer payment record.
-
ReceiptNumber: string
Maximum Length:
50
The unique identifier assigned to each receipt on the cash drawer payment record. -
ReversalAmount: number
The amount on the payment reversal record.
-
ReversalCurrency: string
Maximum Length:
3
The currency code on the payment reversal record. -
ReversalDate: string
(date)
The date on the payment reversal record.
-
ReversalReasonCd: string
Maximum Length:
30
The value assigned to a reversal transaction to identify the reason for requesting a reversal. -
ReversalRequestId: string
Maximum Length:
64
The unique identifier assigned to each batch of reversal request records. -
ReversalStatus: string
Maximum Length:
30
The status of the reversal record. -
ReversalTranType: string
Maximum Length:
30
The value assigned to a reversal transaction to identify the type of transaction that is requested to be reversed. -
SourceRecordKey: integer
(int64)
The unique identifier of the source record.
-
TokenValue: string
Maximum Length:
960
The value of the token that is referenced in the message. -
TransactionKey: integer
(int64)
The unique identifier of the source fee record.
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.