Create a higher education payment
post
/fscmRestApi/resources/11.13.18.05/hedPayments
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
-
AccountType: string
Type of the account specified.
-
AllowDiscountFlag: boolean
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
Amount to be stored if any.
-
AmountDue: number
Amount due is the fee amount after the discount is applied.
-
ApplicationRegistrationCode: string
The API key assigned to the registered application.
-
AppliedDiscountId: integer
The unique identifier of an automatic discount.
-
AppliedDiscountName: string
The name of an automatic discount.
-
AutoSubmitFlag: boolean
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
Bank account number specified.
-
BranchNumber: string
Branch number specified.
-
BusinessUnit: string
Business unit specified.
-
BuyerPartyId: integer
Party identifier of the student.
-
CountryCode: string
A short alphabetic code representing the country that is used as the default address.
-
CurrencyCode: string
The currency that the fee will be charged in.
-
CurrencySymbol: string
Currency symbol of the currency code in which the transactions are charged in.
-
DiscountAmount: number
Discount amount to be stored if any.
-
DiscountPercent: number
The percentage by which a fee is reduced.
-
ExternalTrxReference: string
Transaction number for third party payment transactions. This value is passed from the external system once the payment is successful.
-
ExternalTrxReferenceDate: string
(date)
Transaction date for third party payment transactions. This value is passed from the external system once the payment is successful.
-
InstrumentPaymentUseId: integer
The unique identifier of the payment method.
-
InvoiceConfirmationMessage: string
Invoice confirmation message passed to the consumer with invoice details.
-
InvoiceStatus: string
Status of the processed invoice such as ORA_PENDING, ORA_SUCCESS, ORA_ERROR, or ORA_MESSAGES.
-
ManualDiscountId: integer
The unique identifier of a manual discount.
-
ManualOverrideAmount: number
The amount that is manually provided to override the current discount.
-
ObjectId: integer
Identifier of the object that initiates the transaction.
-
OrderId: integer
Identifier passed by the credit card payment provider.
-
OverallAmount: number
Overall amount is the actual fee before the discount is applied.
-
PayerPartyId: integer
Party identifier of the proxy.
-
PaymentAmountFlag: boolean
Indicator to identify whether payment is required or not.
-
PaymentConfirmationMessage: string
Payment confirmation message passed to the consumer with receipt details.
-
PaymentId: integer
Identifier of the payment request.
-
PaymentStatus: string
Status of the processed payment such as ORA_PENDING, ORA_SUCCESS, ORA_ERROR, or ORA_MESSAGES.
-
PayPointCode: string
Code that identifies the pay point. A pay point can be an instance of the shopping cart, My Finances, and so on.
-
PayPointOption: string
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
Code that must be entered by the user to obtain a promotion type discount.
-
ReceiptConfirmationMessage: string
Receipt confirmation message passed to the consumer with receipt details.
-
ReceiptStatus: string
Status of the receipt such as ORA_PENDING, ORA_SUCCESS, ORA_ERROR, or ORA_MESSAGES.
-
ReferenceKey: string
Randomly generated transaction reference key used by student to make a payment using a third party payment service provider.
-
RelatedPartyId: integer
Party identifier of the learner.
-
TransactionConfirmationMessage: string
Transaction confirmation message passed to the consumer with transaction details.
-
TransactionReferenceId: integer
Transaction identifier for third party payment transactions.
-
TransactionStatus: string
Status of the reference key that is generated such as ORA_PENDING, ORA_VALIDATED, ORA_EXPIRED, ORA_POSTED, ORA_ERROR, or ORA_MESSAGES.
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 : hedPayments-item-response
Type:
Show Source
object
-
AccountType: string
Type of the account specified.
-
AllowDiscountFlag: boolean
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
Amount to be stored if any.
-
AmountDue: number
Amount due is the fee amount after the discount is applied.
-
ApplicationRegistrationCode: string
The API key assigned to the registered application.
-
AppliedDiscountId: integer
The unique identifier of an automatic discount.
-
AppliedDiscountName: string
The name of an automatic discount.
-
AutoSubmitFlag: boolean
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
Bank account number specified.
-
BranchNumber: string
Branch number specified.
-
BusinessUnit: string
Business unit specified.
-
BuyerPartyId: integer
Party identifier of the student.
-
CountryCode: string
A short alphabetic code representing the country that is used as the default address.
-
CurrencyCode: string
The currency that the fee will be charged in.
-
CurrencySymbol: string
Currency symbol of the currency code in which the transactions are charged in.
-
DiscountAmount: number
Discount amount to be stored if any.
-
DiscountPercent: number
The percentage by which a fee is reduced.
-
ExternalTrxReference: string
Transaction number for third party payment transactions. This value is passed from the external system once the payment is successful.
-
ExternalTrxReferenceDate: string
(date)
Transaction date for third party payment transactions. This value is passed from the external system once the payment is successful.
-
InstrumentPaymentUseId: integer
The unique identifier of the payment method.
-
InvoiceConfirmationMessage: string
Invoice confirmation message passed to the consumer with invoice details.
-
InvoiceStatus: string
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
The unique identifier of a manual discount.
-
ManualOverrideAmount: number
The amount that is manually provided to override the current discount.
-
ObjectId: integer
Identifier of the object that initiates the transaction.
-
OrderId: integer
Identifier passed by the credit card payment provider.
-
OverallAmount: number
Overall amount is the actual fee before the discount is applied.
-
PayerPartyId: integer
Party identifier of the proxy.
-
PaymentAmountFlag: boolean
Indicator to identify whether payment is required or not.
-
PaymentConfirmationMessage: string
Payment confirmation message passed to the consumer with receipt details.
-
PaymentId: integer
Identifier of the payment request.
-
PaymentStatus: string
Status of the processed payment such as ORA_PENDING, ORA_SUCCESS, ORA_ERROR, or ORA_MESSAGES.
-
PayPointCode: string
Code that identifies the pay point. A pay point can be an instance of the shopping cart, My Finances, and so on.
-
PayPointOption: string
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
Code that must be entered by the user to obtain a promotion type discount.
-
ReceiptConfirmationMessage: string
Receipt confirmation message passed to the consumer with receipt details.
-
ReceiptStatus: string
Status of the receipt such as ORA_PENDING, ORA_SUCCESS, ORA_ERROR, or ORA_MESSAGES.
-
ReferenceKey: string
Randomly generated transaction reference key used by student to make a payment using a third party payment service provider.
-
RelatedPartyId: integer
Party identifier of the learner.
-
TransactionConfirmationMessage: string
Transaction confirmation message passed to the consumer with transaction details.
-
TransactionReferenceId: integer
Transaction identifier for third party payment transactions.
-
TransactionStatus: string
Status of the reference key that is generated such as ORA_PENDING, ORA_VALIDATED, ORA_EXPIRED, ORA_POSTED, ORA_ERROR, or ORA_MESSAGES.
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.