Jump to

• Request
• Response

Get a single higher education payment

get

/fscmRestApi/resources/11.13.18.05/hedPayments/{PaymentId}

Request

Path Parameters

• PaymentId(required): integer
  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=

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

There's no request body for this operation.

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 : hedPayments-item-response

Type: object

Show Source

• AccountType: string
  Title: Account Type

  Type of the account specified.
• AllowDiscountFlag: boolean
  Title: Allow Discount Flag

  Indicates whether a discount can be applied to a chargeable item in the current request. The default value is based on the current system and fee settings.
• Amount: number
  Title: Amount

  Amount to be stored if any.
• AmountDue: number
  Title: Amount Due

  Amount due is the fee amount after the discount is applied.
• ApplicationRegistrationCode: string
  Title: Application Registration Code

  The API key assigned to the registered application.
• AppliedDiscountId: integer
  Title: Applied Discount ID

  The unique identifier of an automatic discount.
• AppliedDiscountName: string
  Title: Applied Discount Name

  The name of an automatic discount.
• AutoSubmitFlag: boolean
  Title: Autosubmit Flag

  Default Value: true

  This indicates that the service has determined the admissions application doesn't require payment, so it automatically completes the transaction. The default setting is true.
• BankAccountNumber: string
  Title: Bank Account Number

  Bank account number specified.
• BranchNumber: string
  Title: Branch Number

  Branch number specified.
• BusinessUnit: string
  Title: Business Unit

  Business unit specified.
• BuyerPartyId: integer
  Title: Buyer Party ID

  Party identifier of the student.
• CountryCode: string
  Title: Country Code

  A short alphabetic code representing the country that's used as the default address.
• CurrencyCode: string
  Title: Currency Code

  The currency that the fee will be charged in.
• CurrencySymbol: string
  Title: Currency Symbol

  Currency symbol of the currency code in which the transactions are charged in.
• DiscountAmount: number
  Title: Discount Amount

  Discount amount to be stored if any.
• DiscountPercent: number
  Title: Discount Percentage

  The percentage by which a fee is reduced.
• ExternalTrxReference: string
  Title: External Transaction Reference

  Transaction number for third party payment transactions. This value is passed from the external system once the payment is successful.
• ExternalTrxReferenceDate: string (date)
  Title: External Transaction Reference Date

  Transaction date for third party payment transactions. This value is passed from the external system once the payment is successful.
• InstrumentPaymentUseId: integer
  Title: Instrument Payment Use ID

  The unique identifier of the payment method.
• InvoiceConfirmationMessage: string
  Title: Invoice Confirmation Message

  Invoice confirmation message passed to the consumer with invoice details.
• InvoiceStatus: string
  Title: Invoice Status

  Status of the processed invoice such as ORA_PENDING, ORA_SUCCESS, ORA_ERROR, or ORA_MESSAGES.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ManualDiscountId: integer
  Title: Manual Discount ID

  The unique identifier of a manual discount.
• ManualOverrideAmount: number
  Title: Manual Override Amount

  The amount that's manually provided to override the current discount.
• ObjectId: integer
  Title: Object ID

  Identifier of the object that initiates the transaction.
• OrderId: integer
  Title: Order ID

  Identifier passed by the credit card payment provider.
• OverallAmount: number
  Title: Overall Amount

  Overall amount is the actual fee before the discount is applied.
• PayerPartyId: integer
  Title: Payer Party ID

  Party identifier of the proxy.
• PaymentAmountFlag: boolean
  Title: Payment Amount Flag

  Indicator to identify whether payment is required or not.
• PaymentConfirmationMessage: string
  Title: Payment Confirmation Message

  Payment confirmation message passed to the consumer with receipt details.
• PaymentId: integer
  Title: Payment ID

  Identifier of the payment request.
• PaymentStatus: string
  Title: Payment Status

  Status of the processed payment such as ORA_PENDING, ORA_SUCCESS, ORA_ERROR, or ORA_MESSAGES.
• PayPointCode: string
  Title: Pay Point Code

  Code that identifies the pay point. A pay point can be an instance of the shopping cart, My Finances, and so on.
• PayPointOption: string
  Title: Pay Point Option

  Payment option depending on the selected pay point. A payment option for My Finances can be paying the billed amount, total amount, or another amount.
• PromotionCode: string
  Title: Promotion Code

  Code that must be entered by the user to obtain a promotion type discount.
• ReceiptConfirmationMessage: string
  Title: Receipt Confirmation Message

  Receipt confirmation message passed to the consumer with receipt details.
• ReceiptStatus: string
  Title: Receipt Status

  Status of the receipt such as ORA_PENDING, ORA_SUCCESS, ORA_ERROR, or ORA_MESSAGES.
• ReferenceKey: string
  Title: Reference Key

  Randomly generated transaction reference key used by student to make a payment using a third party payment service provider.
• RelatedPartyId: integer
  Title: Related Party ID

  Party identifier of the learner.
• TransactionConfirmationMessage: string
  Title: Transaction Confirmation Message

  Transaction confirmation message passed to the consumer with transaction details.
• TransactionReferenceId: integer
  Title: Transaction Reference ID

  Transaction identifier for third party payment transactions.
• TransactionStatus: string
  Title: Transaction Status

  Status of the reference key that's generated such as ORA_PENDING, ORA_VALIDATED, ORA_EXPIRED, ORA_POSTED, ORA_ERROR, or ORA_MESSAGES.

{
    "type":"object",
    "properties":{
        "AccountType":{
            "title":"Account Type",
            "type":"string",
            "description":"Type of the account specified.",
            "nullable":true,
            "x-queryable":false
        },
        "AllowDiscountFlag":{
            "title":"Allow Discount Flag",
            "type":"boolean",
            "description":"Indicates whether a discount can be applied to a chargeable item in the current request. The default value is based on the current system and fee settings.",
            "nullable":true,
            "x-queryable":false
        },
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"Amount to be stored if any.",
            "nullable":true,
            "x-queryable":false
        },
        "AmountDue":{
            "title":"Amount Due",
            "type":"number",
            "description":"Amount due is the fee amount after the discount is applied.",
            "nullable":true,
            "x-queryable":true
        },
        "ApplicationRegistrationCode":{
            "title":"Application Registration Code",
            "type":"string",
            "description":"The API key assigned to the registered application.",
            "nullable":true,
            "x-queryable":true
        },
        "AppliedDiscountId":{
            "title":"Applied Discount ID",
            "type":"integer",
            "description":"The unique identifier of an automatic discount.",
            "nullable":true,
            "x-queryable":false
        },
        "AppliedDiscountName":{
            "title":"Applied Discount Name",
            "type":"string",
            "description":"The name of an automatic discount.",
            "nullable":true,
            "x-queryable":false
        },
        "AutoSubmitFlag":{
            "title":"Autosubmit Flag",
            "type":"boolean",
            "description":"This indicates that the service has determined the admissions application doesn't require payment, so it automatically completes the transaction. The default setting is true.",
            "nullable":true,
            "default":true,
            "x-queryable":false
        },
        "BankAccountNumber":{
            "title":"Bank Account Number",
            "type":"string",
            "description":"Bank account number specified.",
            "nullable":true,
            "x-queryable":false
        },
        "BranchNumber":{
            "title":"Branch Number",
            "type":"string",
            "description":"Branch number specified.",
            "nullable":true,
            "x-queryable":false
        },
        "BusinessUnit":{
            "title":"Business Unit",
            "type":"string",
            "description":"Business unit specified.",
            "nullable":true,
            "x-queryable":false
        },
        "BuyerPartyId":{
            "title":"Buyer Party ID",
            "type":"integer",
            "description":"Party identifier of the student.",
            "nullable":true,
            "x-queryable":false
        },
        "CountryCode":{
            "title":"Country Code",
            "type":"string",
            "description":"A short alphabetic code representing the country that's used as the default address.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "type":"string",
            "description":"The currency that the fee will be charged in.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencySymbol":{
            "title":"Currency Symbol",
            "type":"string",
            "description":"Currency symbol of the currency code in which the transactions are charged in.",
            "nullable":true,
            "x-queryable":true
        },
        "DiscountAmount":{
            "title":"Discount Amount",
            "type":"number",
            "description":"Discount amount to be stored if any.",
            "nullable":true,
            "x-queryable":true
        },
        "DiscountPercent":{
            "title":"Discount Percentage",
            "type":"number",
            "description":"The percentage by which a fee is reduced.",
            "nullable":true,
            "x-queryable":false
        },
        "ExternalTrxReference":{
            "title":"External Transaction Reference",
            "type":"string",
            "description":"Transaction number for third party payment transactions. This value is passed from the external system once the payment is successful.",
            "nullable":true,
            "x-queryable":false
        },
        "ExternalTrxReferenceDate":{
            "title":"External Transaction Reference Date",
            "type":"string",
            "description":"Transaction date for third party payment transactions. This value is passed from the external system once the payment is successful.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "InstrumentPaymentUseId":{
            "title":"Instrument Payment Use ID",
            "type":"integer",
            "description":"The unique identifier of the payment method.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceConfirmationMessage":{
            "title":"Invoice Confirmation Message",
            "type":"string",
            "description":"Invoice confirmation message passed to the consumer with invoice details.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "InvoiceStatus":{
            "title":"Invoice Status",
            "type":"string",
            "description":"Status of the processed invoice such as ORA_PENDING, ORA_SUCCESS, ORA_ERROR, or ORA_MESSAGES.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ManualDiscountId":{
            "title":"Manual Discount ID",
            "type":"integer",
            "description":"The unique identifier of a manual discount.",
            "nullable":true,
            "x-queryable":true
        },
        "ManualOverrideAmount":{
            "title":"Manual Override Amount",
            "type":"number",
            "description":"The amount that's manually provided to override the current discount.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectId":{
            "title":"Object ID",
            "type":"integer",
            "description":"Identifier of the object that initiates the transaction.",
            "nullable":true,
            "x-queryable":false
        },
        "OrderId":{
            "title":"Order ID",
            "type":"integer",
            "description":"Identifier passed by the credit card payment provider.",
            "nullable":true,
            "x-queryable":false
        },
        "OverallAmount":{
            "title":"Overall Amount",
            "type":"number",
            "description":"Overall amount is the actual fee before the discount is applied.",
            "nullable":true,
            "x-queryable":true
        },
        "PayPointCode":{
            "title":"Pay Point Code",
            "type":"string",
            "description":"Code that identifies the pay point. A pay point can be an instance of the shopping cart, My Finances, and so on.",
            "nullable":true,
            "x-queryable":false
        },
        "PayPointOption":{
            "title":"Pay Point Option",
            "type":"string",
            "description":"Payment option depending on the selected pay point. A payment option for My Finances can be paying the billed amount, total amount, or another amount.",
            "nullable":true,
            "x-queryable":false
        },
        "PayerPartyId":{
            "title":"Payer Party ID",
            "type":"integer",
            "description":"Party identifier of the proxy.",
            "nullable":true,
            "x-queryable":false
        },
        "PaymentAmountFlag":{
            "title":"Payment Amount Flag",
            "type":"boolean",
            "description":"Indicator to identify whether payment is required or not.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentConfirmationMessage":{
            "title":"Payment Confirmation Message",
            "type":"string",
            "description":"Payment confirmation message passed to the consumer with receipt details.",
            "nullable":true,
            "x-queryable":false
        },
        "PaymentId":{
            "title":"Payment ID",
            "type":"integer",
            "description":"Identifier of the payment request.",
            "nullable":false,
            "x-queryable":true
        },
        "PaymentStatus":{
            "title":"Payment Status",
            "type":"string",
            "description":"Status of the processed payment such as ORA_PENDING, ORA_SUCCESS, ORA_ERROR, or ORA_MESSAGES.",
            "nullable":true,
            "x-queryable":false
        },
        "PromotionCode":{
            "title":"Promotion Code",
            "type":"string",
            "description":"Code that must be entered by the user to obtain a promotion type discount.",
            "nullable":true,
            "x-queryable":false
        },
        "ReceiptConfirmationMessage":{
            "title":"Receipt Confirmation Message",
            "type":"string",
            "description":"Receipt confirmation message passed to the consumer with receipt details.",
            "nullable":true,
            "x-queryable":true
        },
        "ReceiptStatus":{
            "title":"Receipt Status",
            "type":"string",
            "description":"Status of the receipt such as ORA_PENDING, ORA_SUCCESS, ORA_ERROR, or ORA_MESSAGES.",
            "nullable":true,
            "x-queryable":true
        },
        "ReferenceKey":{
            "title":"Reference Key",
            "type":"string",
            "description":"Randomly generated transaction reference key used by student to make a payment using a third party payment service provider.",
            "nullable":true,
            "x-queryable":false
        },
        "RelatedPartyId":{
            "title":"Related Party ID",
            "type":"integer",
            "description":"Party identifier of the learner.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionConfirmationMessage":{
            "title":"Transaction Confirmation Message",
            "type":"string",
            "description":"Transaction confirmation message passed to the consumer with transaction details.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionReferenceId":{
            "title":"Transaction Reference ID",
            "type":"integer",
            "description":"Transaction identifier for third party payment transactions.",
            "nullable":true,
            "x-queryable":false
        },
        "TransactionStatus":{
            "title":"Transaction Status",
            "type":"string",
            "description":"Status of the reference key that's generated such as ORA_PENDING, ORA_VALIDATED, ORA_EXPIRED, ORA_POSTED, ORA_ERROR, or ORA_MESSAGES.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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