Jump to

• Request
• Response

Update a payment preference

patch

/fscmRestApi/resources/11.13.18.05/hedPaymentPreferences/{PaymentPreferenceId}

Request

Path Parameters

• PaymentPreferenceId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

• Metadata-Context: string
  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: string
  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 ()

Root Schema : schema

Type: object

Show Source

• Priority: integer (int32)
  Title: Priority

  Priority of the refund payment method.

{
    "type":"object",
    "properties":{
        "Priority":{
            "title":"Priority",
            "type":"integer",
            "description":"Priority of the refund payment method.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":4
            }
        }
    }
}

Back to Top

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.

Body ()

Root Schema : hedPaymentPreferences-item-response

Type: object

Show Source

• AccountNumber: string
  Title: Account Number

  Read Only: true

  Maximum Length: 255

  Unmasked full bank account number which is only visible to users with the appropriate permission.
• FormattedAddress: string
  Title: Formatted Multiline Address

  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
  Title: Masked Account Number

  Read Only: true

  Maximum Length: 255

  Bank account number which is masked for security purposes.
• PartyId: integer (int64)
  Title: Party ID

  Unique identifier of the student setting up the refund preference.
• PaymentPreferenceId: integer (int64)
  Title: Payment Preference ID

  Read Only: true

  Unique identifier of refund payment preference.
• Priority: integer (int32)
  Title: Priority

  Priority of the refund payment method.
• SourceObjectId: integer (int64)
  Title: Source Object ID

  Unique identifier of the refund method type.
• SourceObjectName: string
  Title: Source Object Meaning

  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
  Title: Source Object Type Code

  Maximum Length: 30

  Code of the refund method type. This can be a bank account or check.
• SourceObjectTypeMeaning: string
  Title: Source Object Type

  Read Only: true

  Maximum Length: 80

  Full description of the refund payment method. This can be check or bank account.

{
    "type":"object",
    "properties":{
        "SourceObjectName":{
            "title":"Source Object Meaning",
            "maxLength":255,
            "type":"string",
            "description":"Name of the refund payment. It can be the name of the bank account or address type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PartyId",
                    "SourceObjectId",
                    "SourceObjectTypeCode"
                ]
            }
        },
        "MaskedAccountNumber":{
            "title":"Masked Account Number",
            "maxLength":255,
            "type":"string",
            "description":"Bank account number which is masked for security purposes.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "SourceObjectId",
                    "SourceObjectTypeCode"
                ]
            }
        },
        "SourceObjectTypeCode":{
            "title":"Source Object Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Code of the refund method type. This can be a bank account or check.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SourceObjectId":{
            "title":"Source Object ID",
            "type":"integer",
            "description":"Unique identifier of the refund method type.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"Unique identifier of the student setting up the refund preference.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceObjectTypeMeaning":{
            "title":"Source Object Type",
            "maxLength":80,
            "type":"string",
            "description":"Full description of the refund payment method. This can be check or bank account.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Priority":{
            "title":"Priority",
            "type":"integer",
            "description":"Priority of the refund payment method.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":4
            },
            "x-queryable":true
        },
        "FormattedAddress":{
            "title":"Formatted Multiline Address",
            "maxLength":255,
            "type":"string",
            "description":"The address that corresponds to the address type specified in the refund payment method.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PartyId",
                    "SourceObjectId",
                    "SourceObjectTypeCode"
                ]
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PaymentPreferenceId":{
            "title":"Payment Preference ID",
            "type":"integer",
            "description":"Unique identifier of refund payment preference.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AccountNumber":{
            "title":"Account Number",
            "maxLength":255,
            "type":"string",
            "description":"Unmasked full bank account number which is only visible to users with the appropriate permission.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "SourceObjectId",
                    "SourceObjectTypeCode"
                ]
            }
        }
    }
}

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."
        }
    }
}

Links

sourceObjectCodeLOV

Operation: /fscmRestApi/resources/11.13.18.05/genericLookupsLOV

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

Back to Top