Get all refund data
get
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentRefunds
Request
Query Parameters
-
dependency: string
This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes 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 attributes 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 attributes. 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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds refunds that match the primary key criteria specified. Finder Variables:
- RefundHistoryKey; integer; The unique identifier for the refund transaction.
- PrimaryKey: Finds refunds that match the primary key criteria specified. Finder Variables:
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2 -
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Response
Supported Media Types
- application/vnd.oracle.adf.resourcecollection+json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorPaymentRefunds
Type:
Show Source
object
-
count(optional):
integer
Title:
Count
The number of resource instances returned in the current range. -
hasMore(optional):
boolean
Title:
HasMore
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false. -
items(optional):
array Items
Title:
Items
The items in the collection. -
limit(optional):
integer
Title:
Limit
The actual paging size used by the server. -
links(optional):
array Items
Title:
Items
The link relations associated with the resource instance. -
offset(optional):
integer
Title:
Offset
The offset value used in the current page.
Nested Schema : Items
Type:
array
Title:
Items
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorPaymentRefunds-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
The unique identifier of the agency associated with the refund transaction.
-
EmailId(optional):
string
Maximum Length:
100
Email ID used in the original payment transaction or new email ID if allowed by the agency. -
links(optional):
array Items
Title:
Items
Link 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:
3
Currency 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:
30
Payment method code used for the original payment transaction. -
PaymentReferenceId(optional):
string
Maximum Length:
50
Payment 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:
3
Typically, 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:
100
Failure 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 Lines
The payment refunds resource is used to view or create payment refunds. -
RefundMethodCode(optional):
string
Maximum Length:
30
Refund method code. Defaults to the payment method code used in the original payment transaction. -
RefundReasonCode(optional):
string
Maximum Length:
20
Reason code for the refund passed by the fee source application. -
RefundReferenceId(optional):
string
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(optional):
string
Maximum Length:
50
Pass through reference data from calling app. Should not contain PII information. -
RefundReferenceSecondary(optional):
string
Maximum Length:
50
Additional pass through reference data from calling app. Should not contain PII information. -
RefundRequestCode(optional):
string
Maximum Length:
50
Refund code or reference value returned by the payment gateway. -
RefundStatus(optional):
string
Maximum Length:
10
The status of the refund. Values are pending, refunded or failed. -
RefundTransactionId(optional):
string
Maximum Length:
50
Transaction ID received from the payment gateway, trust account system, or accounts payable system. -
RefundType(optional):
string
Maximum Length:
10
Either chargeback (referenced transaction to the same payment method) or refund (referenced transaction but using a different payment method). -
ResponseMessageAdditional(optional):
string
Maximum Length:
100
Response message returned by the payment gateway. -
ResponseMessagePrimary(optional):
string
Maximum Length:
100
Response message returned by the payment gateway. -
ResponseMessageSecondary(optional):
string
Maximum Length:
100
Response message returned by the payment gateway.
Nested Schema : Payment Refund Lines
Type:
array
Title:
Payment Refund Lines
The 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 reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The 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:
3
Source application that generated the fee. -
ItemDescription(optional):
string
Maximum Length:
100
Item 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:
30
Item 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:
3
Currency code used from the original payment transaction for this item. -
ItemRefundAmount(optional):
number
Refund amount.
-
ItemRefundCurrency(optional):
string
Maximum Length:
3
Refund currency. -
ItemRefundReferencePrimary(optional):
string
Maximum Length:
50
Attribute identifying item level reference value provided by the refund source application. -
ItemRefundReferenceSecondary(optional):
string
Maximum Length:
50
Additional attribute identifying item level reference value provided by the refund source application. -
links(optional):
array Items
Title:
Items
Link Relations -
RecordId(optional):
string
Maximum Length:
50
Source application's record ID identifier. -
RecordTypeId(optional):
string
Maximum Length:
30
Source 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.