Create a set of refund data
post
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentRefunds
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorPaymentRefunds-item
Type:
Show Source
object-
AgencyId(optional):
integer(int32)
The unique identifier of the agency associated with the refund transaction.
-
BusinessEntityId(optional):
string
Maximum Length:
50The unique identifier for the business entity associated with this transaction. -
BusinessEntityPartyId(optional):
integer(int64)
The unique identifier for the business entity party associated with this transaction.
-
BusinessProfileId(optional):
integer(int64)
The unique identifier for the profile of the business entity associated with this transaction
-
EmailId(optional):
string
Maximum Length:
100Email ID used in the original payment transaction or new email ID if allowed by the agency. -
links(optional):
array Items
Title:
ItemsLink Relations -
PartyId(optional):
integer(int64)
Party ID from the original payment transaction or a new party if allowed by the agency.
-
PaymentAmount(optional):
number
Total amount of the original payment.
-
PaymentCurrency(optional):
string
Maximum Length:
3Currency code used for the original payment transaction. -
PaymentDate(optional):
string(date)
Payment date on which the original payment transaction occurred.
-
PaymentMethodCode(optional):
string
Maximum Length:
30Payment method code used for the original payment transaction. -
PaymentReferenceId(optional):
string
Maximum Length:
50Payment reference of the original payment for which the refund is requested. -
ProfileId(optional):
integer(int64)
Profile ID from the original payment transaction or a new profile ID if allowed by the agency.
-
RefundAmount(optional):
number
Total refund amount processed by the payment gateway or trust account system.
-
RefundCurrency(optional):
string
Maximum Length:
3Typically, the same currency used for the payment. -
RefundDate(optional):
string(date)
Date on which the refund was requested.
-
RefundDttm(optional):
string(date-time)
Date and time when the refund was processed.
-
RefundFailureCode(optional):
string
Maximum Length:
100Failure code returned by the payment gateway. -
RefundHistoryKey(optional):
integer(int64)
The unique identifier for the refund transaction.
-
RefundHistoryLine(optional):
array Payment Refund Lines
Title:
Payment Refund LinesThe payment refunds resource is used to view or create payment refunds. -
RefundMethodCode(optional):
string
Maximum Length:
30Refund method code. Defaults to the payment method code used in the original payment transaction. -
RefundReasonCode(optional):
string
Maximum Length:
20Reason code for the refund passed by the fee source application. -
RefundReferenceId(optional):
string
Maximum Length:
50Combination 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(optional):
string
Maximum Length:
50Pass through reference data from calling app. Should not contain PII information. -
RefundReferenceSecondary(optional):
string
Maximum Length:
50Additional pass through reference data from calling app. Should not contain PII information. -
RefundRequestCode(optional):
string
Maximum Length:
50Refund code or reference value returned by the payment gateway. -
RefundStatus(optional):
string
Maximum Length:
10The status of the refund. Values are pending, refunded or failed. -
RefundTransactionId(optional):
string
Maximum Length:
50Transaction ID received from the payment gateway, trust account system, or accounts payable system. -
RefundType(optional):
string
Maximum Length:
10Either chargeback (referenced transaction to the same payment method) or refund (referenced transaction but using a different payment method). -
ResponseMessageAdditional(optional):
string
Maximum Length:
100Response message returned by the payment gateway. -
ResponseMessagePrimary(optional):
string
Maximum Length:
100Response message returned by the payment gateway. -
ResponseMessageSecondary(optional):
string
Maximum Length:
100Response message returned by the payment gateway.
Nested Schema : Payment Refund Lines
Type:
arrayTitle:
Payment Refund LinesThe payment refunds resource is used to view or create payment refunds.
Show Source
Nested Schema : link
Type:
Show Source
object-
href(optional):
string
Title:
hyperlink referenceThe URI to the related resource. -
rel(optional):
string
Title:
relationThe name of the relation to the resource instance. Example: self.
Nested Schema : publicSectorPaymentRefunds-RefundHistoryLine-item
Type:
Show Source
object-
AgencyId(optional):
integer(int32)
The unique identifier of the agency associated with the refund transaction.
-
Classification(optional):
string
Maximum Length:
3Source application that generated the fee. -
ItemDescription(optional):
string
Maximum Length:
100Item description used for the original payment for this item. -
ItemLine(optional):
integer(int32)
Item line used for the original payment for this item.
-
ItemName(optional):
string
Maximum Length:
30Item name used for the original payment for this item. -
ItemPaymentAmount(optional):
number
Payment amount from the original payment transaction for this item.
-
ItemPaymentCurrency(optional):
string
Maximum Length:
3Currency code used from the original payment transaction for this item. -
ItemRefundAmount(optional):
number
Refund amount.
-
ItemRefundCurrency(optional):
string
Maximum Length:
3Refund currency. -
ItemRefundReferencePrimary(optional):
string
Maximum Length:
50Attribute identifying item level reference value provided by the refund source application. -
ItemRefundReferenceSecondary(optional):
string
Maximum Length:
50Additional attribute identifying item level reference value provided by the refund source application. -
links(optional):
array Items
Title:
ItemsLink Relations -
RecordId(optional):
string
Maximum Length:
50Source application's record ID identifier. -
RecordTypeId(optional):
string
Maximum Length:
30Source application's record type identifier. -
RefundHistoryKey(optional):
integer(int64)
Parent history key.
-
RefundRecordKey(optional):
integer(int32)
Auto-sequencing generated value for the unique identification of each line row.
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorPaymentRefunds-item
Type:
Show Source
object-
AgencyId(optional):
integer(int32)
The unique identifier of the agency associated with the refund transaction.
-
BusinessEntityId(optional):
string
Maximum Length:
50The unique identifier for the business entity associated with this transaction. -
BusinessEntityPartyId(optional):
integer(int64)
The unique identifier for the business entity party associated with this transaction.
-
BusinessProfileId(optional):
integer(int64)
The unique identifier for the profile of the business entity associated with this transaction
-
EmailId(optional):
string
Maximum Length:
100Email ID used in the original payment transaction or new email ID if allowed by the agency. -
links(optional):
array Items
Title:
ItemsLink Relations -
PartyId(optional):
integer(int64)
Party ID from the original payment transaction or a new party if allowed by the agency.
-
PaymentAmount(optional):
number
Total amount of the original payment.
-
PaymentCurrency(optional):
string
Maximum Length:
3Currency code used for the original payment transaction. -
PaymentDate(optional):
string(date)
Payment date on which the original payment transaction occurred.
-
PaymentMethodCode(optional):
string
Maximum Length:
30Payment method code used for the original payment transaction. -
PaymentReferenceId(optional):
string
Maximum Length:
50Payment reference of the original payment for which the refund is requested. -
ProfileId(optional):
integer(int64)
Profile ID from the original payment transaction or a new profile ID if allowed by the agency.
-
RefundAmount(optional):
number
Total refund amount processed by the payment gateway or trust account system.
-
RefundCurrency(optional):
string
Maximum Length:
3Typically, the same currency used for the payment. -
RefundDate(optional):
string(date)
Date on which the refund was requested.
-
RefundDttm(optional):
string(date-time)
Date and time when the refund was processed.
-
RefundFailureCode(optional):
string
Maximum Length:
100Failure code returned by the payment gateway. -
RefundHistoryKey(optional):
integer(int64)
The unique identifier for the refund transaction.
-
RefundHistoryLine(optional):
array Payment Refund Lines
Title:
Payment Refund LinesThe payment refunds resource is used to view or create payment refunds. -
RefundMethodCode(optional):
string
Maximum Length:
30Refund method code. Defaults to the payment method code used in the original payment transaction. -
RefundReasonCode(optional):
string
Maximum Length:
20Reason code for the refund passed by the fee source application. -
RefundReferenceId(optional):
string
Maximum Length:
50Combination 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(optional):
string
Maximum Length:
50Pass through reference data from calling app. Should not contain PII information. -
RefundReferenceSecondary(optional):
string
Maximum Length:
50Additional pass through reference data from calling app. Should not contain PII information. -
RefundRequestCode(optional):
string
Maximum Length:
50Refund code or reference value returned by the payment gateway. -
RefundStatus(optional):
string
Maximum Length:
10The status of the refund. Values are pending, refunded or failed. -
RefundTransactionId(optional):
string
Maximum Length:
50Transaction ID received from the payment gateway, trust account system, or accounts payable system. -
RefundType(optional):
string
Maximum Length:
10Either chargeback (referenced transaction to the same payment method) or refund (referenced transaction but using a different payment method). -
ResponseMessageAdditional(optional):
string
Maximum Length:
100Response message returned by the payment gateway. -
ResponseMessagePrimary(optional):
string
Maximum Length:
100Response message returned by the payment gateway. -
ResponseMessageSecondary(optional):
string
Maximum Length:
100Response message returned by the payment gateway.
Nested Schema : Payment Refund Lines
Type:
arrayTitle:
Payment Refund LinesThe payment refunds resource is used to view or create payment refunds.
Show Source
Nested Schema : link
Type:
Show Source
object-
href(optional):
string
Title:
hyperlink referenceThe URI to the related resource. -
rel(optional):
string
Title:
relationThe name of the relation to the resource instance. Example: self.
Nested Schema : publicSectorPaymentRefunds-RefundHistoryLine-item
Type:
Show Source
object-
AgencyId(optional):
integer(int32)
The unique identifier of the agency associated with the refund transaction.
-
Classification(optional):
string
Maximum Length:
3Source application that generated the fee. -
ItemDescription(optional):
string
Maximum Length:
100Item description used for the original payment for this item. -
ItemLine(optional):
integer(int32)
Item line used for the original payment for this item.
-
ItemName(optional):
string
Maximum Length:
30Item name used for the original payment for this item. -
ItemPaymentAmount(optional):
number
Payment amount from the original payment transaction for this item.
-
ItemPaymentCurrency(optional):
string
Maximum Length:
3Currency code used from the original payment transaction for this item. -
ItemRefundAmount(optional):
number
Refund amount.
-
ItemRefundCurrency(optional):
string
Maximum Length:
3Refund currency. -
ItemRefundReferencePrimary(optional):
string
Maximum Length:
50Attribute identifying item level reference value provided by the refund source application. -
ItemRefundReferenceSecondary(optional):
string
Maximum Length:
50Additional attribute identifying item level reference value provided by the refund source application. -
links(optional):
array Items
Title:
ItemsLink Relations -
RecordId(optional):
string
Maximum Length:
50Source application's record ID identifier. -
RecordTypeId(optional):
string
Maximum Length:
30Source application's record type identifier. -
RefundHistoryKey(optional):
integer(int64)
Parent history key.
-
RefundRecordKey(optional):
integer(int32)
Auto-sequencing generated value for the unique identification of each line row.