Create a set of refund data
post
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentRefunds
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
-
AccountPurpose: string
Maximum Length:
30
Indicates the account purpose associated with the payment. -
AccountType: string
Maximum Length:
30
Indicates the account type associated with the payment. -
AgencyId: integer
(int32)
Default Value:
1
The unique identifier of the agency associated with the refund transaction. -
BusinessEntityId: string
Maximum Length:
50
The unique identifier for the business entity associated with this transaction. -
BusinessEntityPartyId: integer
(int64)
The unique identifier for the business entity party associated with this transaction.
-
BusinessProfileId: integer
(int64)
The unique identifier for the profile of the business entity associated with this transaction.
-
EmailId: string
Maximum Length:
100
Email ID used in the original payment transaction or new email ID if allowed by the agency. -
FarReceiptStatus: string
Maximum Length:
30
The status of the receipt creation in Oracle Receivables. -
PartyId(required): integer
(int64)
Party ID from the original payment transaction or a new party if allowed by the agency.
-
PaymentAmount: number
Total amount of the original payment.
-
PaymentCurrency: string
Maximum Length:
3
Currency code used for the original payment transaction. -
PaymentDate: string
(date)
Payment date on which the original payment transaction occurred.
-
PaymentMethodCode: string
Maximum Length:
30
Payment method code used for the original payment transaction. -
PaymentReferenceId(required): string
Maximum Length:
50
Payment reference of the original payment for which the refund is requested. -
ProfileId(required): integer
(int64)
Profile ID from the original payment transaction or a new profile ID if allowed by the agency.
-
PublishedStatusCode: string
Maximum Length:
30
Default Value:ORA_UNPUBLISHED
Indicates whether reconciliation activity has been created for the transaction by code -
ReconHistoryKey: integer
(int64)
Unique identifier for each bank reconciliation activity record.
-
RefundAmount(required): number
The total refund amount processed by the payment gateway or trust account system.
-
RefundCurrency(required): string
Maximum Length:
3
Typically, the same currency used for the payment. -
RefundDate: string
(date)
Date on which the refund was requested.
-
RefundDttm: string
(date-time)
Date and time when the refund was processed.
-
RefundFailureCode: string
Maximum Length:
100
Failure code returned by the payment gateway. -
RefundHistoryLine: array
Payment Refund Lines
Title:
Payment Refund Lines
The payment refund lines resource is used to view or create payment refund detail lines. -
RefundMethodCode(required): string
Maximum Length:
30
Refund method code. Defaults to the payment method code used in the original payment transaction. -
RefundReasonCode(required): string
Maximum Length:
20
The reason code for the refund passed by the fee source application. -
RefundReferencePrimary: string
Maximum Length:
50
Pass through reference data from calling app. Should not contain PII information. -
RefundReferenceSecondary: string
Maximum Length:
50
Additional pass through reference data from calling app. Should not contain PII information. -
RefundRequestCode: string
Maximum Length:
50
Refund code or reference value returned by the payment gateway. -
RefundStatus: string
Maximum Length:
10
The status of the refund. Values are pending, refunded or failed. -
RefundTransactionId: string
Maximum Length:
50
Transaction ID received from the payment gateway, trust account system, or accounts payable system. -
RefundTransactionType: string
Maximum Length:
30
Default Value:ORA_FEE_REFUND
The transaction type of the refund that has to be issued. -
RefundType: string
Maximum Length:
10
Either chargeback (referenced transaction to the same payment method) or refund (referenced transaction but using a different payment method). -
ResponseMessageAdditional: string
Maximum Length:
100
Response message returned by the payment gateway. -
ResponseMessagePrimary: string
Maximum Length:
100
Response message returned by the payment gateway. -
ResponseMessageSecondary: string
Maximum Length:
100
Response message returned by the payment gateway. -
TrustAccountNumber: string
Maximum Length:
30
Indicates the deposit account number associated with the payment.
Nested Schema : Payment Refund Lines
Type:
array
Title:
Payment Refund Lines
The payment refund lines resource is used to view or create payment refund detail lines.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
AgencyId: integer
(int32)
The unique identifier of the agency associated with the refund transaction.
-
Classification: string
Maximum Length:
3
Source application that generated the fee. -
FarCashReceiptId: integer
(int64)
Receipt identifier created in Oracle Receivables.
-
FarReceiptStatus: string
Maximum Length:
30
Status of the receipt creation in Oracle Receivables. -
ItemDescription: string
Maximum Length:
100
Item description used for the original payment for this item. -
ItemLine: integer
(int32)
Item line used for the original payment for this item.
-
ItemName: string
Maximum Length:
30
Item name used for the original payment for this item. -
ItemPaymentAmount: number
Title:
Item Payment Amount
Payment amount from the original payment transaction for this item. -
ItemPaymentCurrency: string
Title:
Item Payment Currency
Maximum Length:3
Currency code used from the original payment transaction for this item. -
ItemRefundAmount: number
Refund amount.
-
ItemRefundCurrency: string
Maximum Length:
3
Refund currency. -
ItemRefundReferencePrimary: string
Maximum Length:
50
Attribute identifying item level reference value provided by the refund source application. -
ItemRefundReferenceSecondary: string
Maximum Length:
50
Additional attribute identifying item level reference value provided by the refund source application. -
RecordId: string
Title:
Record ID
Maximum Length:50
Source application's record ID identifier. -
RecordTypeId: string
Maximum Length:
30
Source application's record type identifier. -
RefundRecordKey: integer
(int32)
The auto-sequencing generated value for the unique identification of each line row.
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 : publicSectorPaymentRefunds-item-response
Type:
Show Source
object
-
AccountPurpose: string
Maximum Length:
30
Indicates the account purpose associated with the payment. -
AccountType: string
Maximum Length:
30
Indicates the account type associated with the payment. -
AgencyId: integer
(int32)
Default Value:
1
The unique identifier of the agency associated with the refund transaction. -
BusinessEntityId: string
Maximum Length:
50
The unique identifier for the business entity associated with this transaction. -
BusinessEntityPartyId: integer
(int64)
The unique identifier for the business entity party associated with this transaction.
-
BusinessProfileId: integer
(int64)
The unique identifier for the profile of the business entity associated with this transaction.
-
EmailId: string
Maximum Length:
100
Email ID used in the original payment transaction or new email ID if allowed by the agency. -
FarReceiptStatus: string
Maximum Length:
30
The status of the receipt creation in Oracle Receivables. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartyId: integer
(int64)
Party ID from the original payment transaction or a new party if allowed by the agency.
-
PaymentAmount: number
Total amount of the original payment.
-
PaymentCurrency: string
Maximum Length:
3
Currency code used for the original payment transaction. -
PaymentDate: string
(date)
Payment date on which the original payment transaction occurred.
-
PaymentMethodCode: string
Maximum Length:
30
Payment method code used for the original payment transaction. -
PaymentReferenceId: string
Maximum Length:
50
Payment reference of the original payment for which the refund is requested. -
ProfileId: integer
(int64)
Profile ID from the original payment transaction or a new profile ID if allowed by the agency.
-
PublishedStatusCode: string
Maximum Length:
30
Default Value:ORA_UNPUBLISHED
Indicates whether reconciliation activity has been created for the transaction by code -
PublishStatusName: string
Read Only:
true
Maximum Length:80
Indicates whether reconciliation activity has been created for the transaction by name. -
ReconHistoryKey: integer
(int64)
Unique identifier for each bank reconciliation activity record.
-
RefundAmount: number
The total refund amount processed by the payment gateway or trust account system.
-
RefundCurrency: string
Maximum Length:
3
Typically, the same currency used for the payment. -
RefundDate: string
(date)
Date on which the refund was requested.
-
RefundDttm: string
(date-time)
Date and time when the refund was processed.
-
RefundFailureCode: string
Maximum Length:
100
Failure code returned by the payment gateway. -
RefundHistoryKey: integer
(int64)
Read Only:
true
The unique identifier for the refund transaction. -
RefundHistoryLine: array
Payment Refund Lines
Title:
Payment Refund Lines
The payment refund lines resource is used to view or create payment refund detail lines. -
RefundMethodCode: string
Maximum Length:
30
Refund method code. Defaults to the payment method code used in the original payment transaction. -
RefundReasonCode: string
Maximum Length:
20
The reason code for the refund passed by the fee source application. -
RefundReferenceId: string
Read Only:
true
Maximum Length:50
Combination value consisting of the RE- prefix and the value using the PSC GUID function. This value is passed to the calling application and displayed to the user. -
RefundReferencePrimary: string
Maximum Length:
50
Pass through reference data from calling app. Should not contain PII information. -
RefundReferenceSecondary: string
Maximum Length:
50
Additional pass through reference data from calling app. Should not contain PII information. -
RefundRequestCode: string
Maximum Length:
50
Refund code or reference value returned by the payment gateway. -
RefundStatus: string
Maximum Length:
10
The status of the refund. Values are pending, refunded or failed. -
RefundTransactionId: string
Maximum Length:
50
Transaction ID received from the payment gateway, trust account system, or accounts payable system. -
RefundTransactionType: string
Maximum Length:
30
Default Value:ORA_FEE_REFUND
The transaction type of the refund that has to be issued. -
RefundType: string
Maximum Length:
10
Either chargeback (referenced transaction to the same payment method) or refund (referenced transaction but using a different payment method). -
ResponseMessageAdditional: string
Maximum Length:
100
Response message returned by the payment gateway. -
ResponseMessagePrimary: string
Maximum Length:
100
Response message returned by the payment gateway. -
ResponseMessageSecondary: string
Maximum Length:
100
Response message returned by the payment gateway. -
TrustAccountNumber: string
Maximum Length:
30
Indicates the deposit account number associated with the payment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Payment Refund Lines
Type:
array
Title:
Payment Refund Lines
The payment refund lines resource is used to view or create payment refund detail lines.
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.
Nested Schema : publicSectorPaymentRefunds-RefundHistoryLine-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
The unique identifier of the agency associated with the refund transaction.
-
Classification: string
Maximum Length:
3
Source application that generated the fee. -
FarCashReceiptId: integer
(int64)
Receipt identifier created in Oracle Receivables.
-
FarReceiptStatus: string
Maximum Length:
30
Status of the receipt creation in Oracle Receivables. -
ItemDescription: string
Maximum Length:
100
Item description used for the original payment for this item. -
ItemLine: integer
(int32)
Item line used for the original payment for this item.
-
ItemName: string
Maximum Length:
30
Item name used for the original payment for this item. -
ItemPaymentAmount: number
Title:
Item Payment Amount
Payment amount from the original payment transaction for this item. -
ItemPaymentCurrency: string
Title:
Item Payment Currency
Maximum Length:3
Currency code used from the original payment transaction for this item. -
ItemRefundAmount: number
Refund amount.
-
ItemRefundCurrency: string
Maximum Length:
3
Refund currency. -
ItemRefundReferencePrimary: string
Maximum Length:
50
Attribute identifying item level reference value provided by the refund source application. -
ItemRefundReferenceSecondary: string
Maximum Length:
50
Additional attribute identifying item level reference value provided by the refund source application. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RecordId: string
Title:
Record ID
Maximum Length:50
Source application's record ID identifier. -
RecordTypeId: string
Maximum Length:
30
Source application's record type identifier. -
RefundHistoryKey: integer
(int64)
Read Only:
true
The parent history key. -
RefundRecordKey: integer
(int32)
The auto-sequencing generated value for the unique identification of each line row.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- RefundHistoryLine
-
Parameters:
- RefundHistoryKey:
$request.path.RefundHistoryKey
The payment refund lines resource is used to view or create payment refund detail lines. - RefundHistoryKey: