Update a third party payment methods
patch
/fscmRestApi/resources/11.13.18.05/publicSectorThirdPartyPayments/{PaymentHeaderKey}/child/ThirdPartyPaymentMethod/{PaymentMethodKey}
Request
Path Parameters
-
PaymentHeaderKey(required): integer(int64)
Identifies the primary key value of the payment.
-
PaymentMethodKey(required): integer(int64)
Identifies payment method key for a record.
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
Root Schema : schema
Type:
Show Source
object
-
PayerAddress: string
Title:
Payer Address
Maximum Length:2000
Identifies the address associated with the payment instrument. -
PayerEmail: string
Title:
Payer Email
Maximum Length:480
Identifies the email associated with the payment instrument. -
PayerName: string
Title:
Payer Name
Maximum Length:480
Identifies the name associated with the payment instrument. -
PaymentAmount: number
Title:
Payment Amount
Identifies the amount received. -
PaymentCurrency: string
Maximum Length:
3
Identifies the payment currency. -
PaymentStatus: string
Title:
Payment Status
Maximum Length:30
Identifies the payment status for a record. -
PaymentTransactionId: string
Title:
Payment Transaction ID
Maximum Length:50
Identifies the reference number associated with the payment instrument. -
PrimaryTrackingData: string
Title:
Primary Tracking Data
Maximum Length:100
Identifies the tracking reference associated with payment. -
SecondaryTrackingData: string
Title:
Secondary Tracking Data
Maximum Length:100
Identifies the tracking reference associated with payment. -
ServiceChargeAmount: number
Title:
Service Charge Amount
Identifies the service amount charges for a payment. -
TertiaryTrackingData: string
Title:
Tertiary Tracking Data
Maximum Length:100
Identifies the tracking reference associated with payment. -
VoidByName: string
Title:
Void by Name
Maximum Length:240
Identifies the name who voided payment. -
VoidComments: string
Title:
Void Comments
Maximum Length:2000
Identifies the void comments.
Response
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 : publicSectorThirdPartyPayments-ThirdPartyPaymentMethod-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Read Only:
true
Default Value:1
Identifies the agency id associated with a payment. -
ExternalPaymentReference: string
Read Only:
true
Maximum Length:480
Identifies the payment reference provided by third party payment system. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PayerAddress: string
Title:
Payer Address
Maximum Length:2000
Identifies the address associated with the payment instrument. -
PayerEmail: string
Title:
Payer Email
Maximum Length:480
Identifies the email associated with the payment instrument. -
PayerName: string
Title:
Payer Name
Maximum Length:480
Identifies the name associated with the payment instrument. -
PaymentAmount: number
Title:
Payment Amount
Identifies the amount received. -
PaymentCreated: string
Title:
Payment Created
Read Only:true
Maximum Length:30
Default Value:ORA_CREATED
Identifies the payment created for a record. -
PaymentCurrency: string
Maximum Length:
3
Identifies the payment currency. -
PaymentHeaderId: string
Read Only:
true
Maximum Length:50
Identifies the unique alpha numeric reference of the payment. -
PaymentHeaderKey: integer
(int64)
Read Only:
true
Identifies the primary key value of the payment. -
PaymentHistoryKey: integer
(int64)
Title:
Payment History Key
Read Only:true
The unique identifier for the payment transaction. -
PaymentMethodCode: string
Title:
Payment Method Code
Maximum Length:30
The method of payment used for a payment transaction, such as credit card, cash, personal check, or cashier???s check. -
PaymentMethodKey: integer
(int64)
Title:
Payment Method Key
Identifies payment method key for a record. -
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. -
PaymentStatus: string
Title:
Payment Status
Maximum Length:30
Identifies the payment status for a record. -
PaymentTransactionId: string
Title:
Payment Transaction ID
Maximum Length:50
Identifies the reference number associated with the payment instrument. -
PrimaryTrackingData: string
Title:
Primary Tracking Data
Maximum Length:100
Identifies the tracking reference associated with payment. -
SecondaryTrackingData: string
Title:
Secondary Tracking Data
Maximum Length:100
Identifies the tracking reference associated with payment. -
ServiceChargeAmount: number
Title:
Service Charge Amount
Identifies the service amount charges for a payment. -
TertiaryTrackingData: string
Title:
Tertiary Tracking Data
Maximum Length:100
Identifies the tracking reference associated with payment. -
VoidAmount: number
Read Only:
true
Identifies the void amount. -
VoidByName: string
Title:
Void by Name
Maximum Length:240
Identifies the name who voided payment. -
VoidComments: string
Title:
Void Comments
Maximum Length:2000
Identifies the void comments. -
VoidDatetime: string
(date-time)
Title:
Void Date Time
Read Only:true
Identifies the void date time.
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.