Create payment preference
post
/fscmRestApi/resources/11.13.18.05/hedPaymentPreferences
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
-
PartyId: integer
(int64)
Unique identifier of the student setting up the refund preference.
-
Priority: integer
(int32)
Priority of the refund payment method.
-
SourceObjectId: integer
(int64)
Unique identifier of the refund method type.
-
SourceObjectTypeCode: string
Maximum Length:
30
Code of the refund method type. This can be a bank account or check.
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 : hedPaymentPreferences-item-response
Type:
Show Source
object
-
AccountNumber: string
Read Only:
true
Maximum Length:255
Unmasked full bank account number which is only visible to users with the appropriate permission. -
FormattedAddress: string
Read Only:
true
Maximum Length:255
The address that corresponds to the address type specified in the refund payment method. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaskedAccountNumber: string
Read Only:
true
Maximum Length:255
Bank account number which is masked for security purposes. -
PartyId: integer
(int64)
Unique identifier of the student setting up the refund preference.
-
PaymentPreferenceId: integer
(int64)
Read Only:
true
Unique identifier of refund payment preference. -
Priority: integer
(int32)
Priority of the refund payment method.
-
SourceObjectId: integer
(int64)
Unique identifier of the refund method type.
-
SourceObjectName: string
Read Only:
true
Maximum Length:255
Name of the refund payment. It can be the name of the bank account or address type. -
SourceObjectTypeCode: string
Maximum Length:
30
Code of the refund method type. This can be a bank account or check. -
SourceObjectTypeMeaning: string
Read Only:
true
Maximum Length:80
Full description of the refund payment method. This can be check or bank account.
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.
Links
- sourceObjectCodeLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HES_PAYMENT_CHANNEL
The following properties are defined on the LOV link relation:- Source Attribute: SourceObjectTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: