Create a reversal record
post
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentReversals
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
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. -
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. -
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.
Response
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 : 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.