Jump to

• Request
• Response

Update a fee or deposit to be reversed

patch

/fscmRestApi/resources/11.13.18.05/publicSectorPaymentReversals/{PaymentReversalKey}

Request

Path Parameters

• PaymentReversalKey(required): integer(int64)
  The unique identifier of the reversal transaction.

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.

Supported Media Types

• application/json

Request Body - application/json ()

The following table describes the body parameters in the request for this task.

Root Schema : schema

Type: object

Show Source

• 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.
• 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.

{
    "type":"object",
    "properties":{
        "FullReversalFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the full payment has been reversed.",
            "nullable":false,
            "default":"Y"
        },
        "DepositActivityKey":{
            "type":"integer",
            "description":"The unique identifier of the deposit activity record.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TransactionKey":{
            "type":"integer",
            "description":"The unique identifier of the source fee record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "BalanceAmount":{
            "type":"number",
            "description":"Indicates the balance amount that has not been reversed.",
            "nullable":false,
            "default":0
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the agency record.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":8
            }
        },
        "PaymentMethodCode":{
            "maxLength":30,
            "type":"string",
            "description":"The method of payment used for a payment transaction, such as credit card, cash, personal check, or cashier???s check.",
            "nullable":false
        },
        "DepositAccountKey":{
            "type":"integer",
            "description":"The unique identifier of the deposit account record.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ReversalRequestId":{
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier assigned to each batch of reversal request records.",
            "nullable":true
        },
        "MessageName":{
            "maxLength":120,
            "type":"string",
            "description":"The unique name of the message that is populated by the payment reversal process.",
            "nullable":true
        },
        "ReceiptLineNumber":{
            "type":"integer",
            "description":"The line number assigned to each receipt on the cash drawer payment record.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":3
            }
        },
        "TokenValue":{
            "maxLength":960,
            "type":"string",
            "description":"The value of the token that is referenced in the message.",
            "nullable":true
        },
        "ReversalStatus":{
            "maxLength":30,
            "type":"string",
            "description":"The status of the reversal record.",
            "nullable":false
        },
        "SourceRecordKey":{
            "type":"integer",
            "description":"The unique identifier of the source record.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ReversalTranType":{
            "maxLength":30,
            "type":"string",
            "description":"The value assigned to a reversal transaction to identify the type of transaction that is requested to be reversed.",
            "nullable":false
        },
        "ReversalReasonCd":{
            "maxLength":30,
            "type":"string",
            "description":"The value assigned to a reversal transaction to identify the reason for requesting a reversal.",
            "nullable":false
        },
        "Classification":{
            "maxLength":3,
            "type":"string",
            "description":"The identifier assigned to classify a source record.",
            "nullable":true
        },
        "ReversalCurrency":{
            "maxLength":3,
            "type":"string",
            "description":"The currency code on the payment reversal record.",
            "nullable":false
        },
        "ReversalDate":{
            "type":"string",
            "description":"The date on the payment reversal record.",
            "format":"date",
            "nullable":false
        },
        "ReversalAmount":{
            "type":"number",
            "description":"The amount on the payment reversal record.",
            "nullable":false
        },
        "ReceiptNumber":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier assigned to each receipt on the cash drawer payment record.",
            "nullable":true
        }
    }
}

Back to Top

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.

Body ()

Root Schema : publicSectorPaymentReversals-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "FullReversalFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the full payment has been reversed.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "DepositActivityKey":{
            "type":"integer",
            "description":"The unique identifier of the deposit activity record.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TransactionKey":{
            "type":"integer",
            "description":"The unique identifier of the source fee record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BalanceAmount":{
            "type":"number",
            "description":"Indicates the balance amount that has not been reversed.",
            "nullable":false,
            "default":0,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the agency record.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "PaymentReversalKey":{
            "type":"integer",
            "description":"The unique identifier of the reversal transaction.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PaymentMethodCode":{
            "maxLength":30,
            "type":"string",
            "description":"The method of payment used for a payment transaction, such as credit card, cash, personal check, or cashier???s check.",
            "nullable":false,
            "x-queryable":true
        },
        "DepositAccountKey":{
            "type":"integer",
            "description":"The unique identifier of the deposit account record.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReversalRequestId":{
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier assigned to each batch of reversal request records.",
            "nullable":true,
            "x-queryable":true
        },
        "MessageName":{
            "maxLength":120,
            "type":"string",
            "description":"The unique name of the message that is populated by the payment reversal process.",
            "nullable":true,
            "x-queryable":true
        },
        "ReceiptLineNumber":{
            "type":"integer",
            "description":"The line number assigned to each receipt on the cash drawer payment record.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":3
            },
            "x-queryable":true
        },
        "TokenValue":{
            "maxLength":960,
            "type":"string",
            "description":"The value of the token that is referenced in the message.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentReferenceId":{
            "maxLength":50,
            "type":"string",
            "description":"The reference ID of the payment stored on the payment reversal record.",
            "nullable":false,
            "x-queryable":true
        },
        "ReversalStatus":{
            "maxLength":30,
            "type":"string",
            "description":"The status of the reversal record.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceRecordKey":{
            "type":"integer",
            "description":"The unique identifier of the source record.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReversalTranType":{
            "maxLength":30,
            "type":"string",
            "description":"The value assigned to a reversal transaction to identify the type of transaction that is requested to be reversed.",
            "nullable":false,
            "x-queryable":true
        },
        "ReversalReasonCd":{
            "maxLength":30,
            "type":"string",
            "description":"The value assigned to a reversal transaction to identify the reason for requesting a reversal.",
            "nullable":false,
            "x-queryable":true
        },
        "Classification":{
            "maxLength":3,
            "type":"string",
            "description":"The identifier assigned to classify a source record.",
            "nullable":true,
            "x-queryable":true
        },
        "ReversalCurrency":{
            "maxLength":3,
            "type":"string",
            "description":"The currency code on the payment reversal record.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ReversalDate":{
            "type":"string",
            "description":"The date on the payment reversal record.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "ReversalAmount":{
            "type":"number",
            "description":"The amount on the payment reversal record.",
            "nullable":false,
            "x-queryable":true
        },
        "ReceiptNumber":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier assigned to each receipt on the cash drawer payment record.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top