Get a third party payment methods
get
/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.
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 : 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.