Jump to

• Request
• Response

Get all refund data

get

/fscmRestApi/resources/11.13.18.05/publicSectorPaymentRefunds

Request

Query Parameters

• 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
• 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.
• 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.
• 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
  
• 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 fields. 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
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AccountPurpose; string; Indicates the account purpose associated with the payment.
  • AccountType; string; Indicates the account type associated with the payment.
  • AgencyId; integer; The unique identifier of the agency associated with the refund transaction.
  • BusinessEntityId; string; The unique identifier for the business entity associated with this transaction.
  • BusinessEntityPartyId; integer; The unique identifier for the business entity party associated with this transaction.
  • BusinessProfileId; integer; The unique identifier for the profile of the business entity associated with this transaction.
  • EmailId; string; Email ID used in the original payment transaction or new email ID if allowed by the agency.
  • FarReceiptStatus; string; The status of the receipt creation in Oracle Receivables.
  • PartyId; integer; 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; Currency code used for the original payment transaction.
  • PaymentDate; string; Payment date on which the original payment transaction occurred.
  • PaymentMethodCode; string; Payment method code used for the original payment transaction.
  • PaymentReferenceId; string; Payment reference of the original payment for which the refund is requested.
  • ProfileId; integer; Profile ID from the original payment transaction or a new profile ID if allowed by the agency.
  • PublishStatusName; string; Indicates whether reconciliation activity has been created for the transaction by name.
  • PublishedStatusCode; string; Indicates whether reconciliation activity has been created for the transaction by code
  • ReconHistoryKey; integer; 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; Typically, the same currency used for the payment.
  • RefundDate; string; Date on which the refund was requested.
  • RefundDttm; string; Date and time when the refund was processed.
  • RefundFailureCode; string; Failure code returned by the payment gateway.
  • RefundHistoryKey; integer; The unique identifier for the refund transaction.
  • RefundMethodCode; string; Refund method code. Defaults to the payment method code used in the original payment transaction.
  • RefundReasonCode; string; The reason code for the refund passed by the fee source application.
  • RefundReferenceId; string; 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; Pass through reference data from calling app. Should not contain PII information.
  • RefundReferenceSecondary; string; Additional pass through reference data from calling app. Should not contain PII information.
  • RefundRequestCode; string; Refund code or reference value returned by the payment gateway.
  • RefundStatus; string; The status of the refund. Values are pending, refunded or failed.
  • RefundTransactionId; string; Transaction ID received from the payment gateway, trust account system, or accounts payable system.
  • RefundTransactionType; string; The transaction type of the refund that has to be issued.
  • RefundType; string; Either chargeback (referenced transaction to the same payment method) or refund (referenced transaction but using a different payment method).
  • ResponseMessageAdditional; string; Response message returned by the payment gateway.
  • ResponseMessagePrimary; string; Response message returned by the payment gateway.
  • ResponseMessageSecondary; string; Response message returned by the payment gateway.
  • TrustAccountNumber; string; Indicates the deposit account number associated with the payment.
• 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".

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.

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

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  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: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"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."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/publicSectorPaymentRefunds-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"BillingandPayment",
        "usage":"BusinessObject",
        "group":"psc"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorPaymentRefunds-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/publicSectorPaymentRefunds-item-response"
    }
}

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

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "ProfileId":{
            "type":"integer",
            "description":"Profile ID from the original payment transaction or a new profile ID if allowed by the agency.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RefundMethodCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Refund method code. Defaults to the payment method code used in the original payment transaction.",
            "nullable":false,
            "x-queryable":true
        },
        "ReconHistoryKey":{
            "type":"integer",
            "description":"Unique identifier for each bank reconciliation activity record.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BusinessEntityId":{
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier for the business entity associated with this transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the agency associated with the refund transaction.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "BusinessProfileId":{
            "type":"integer",
            "description":"The unique identifier for the profile of the business entity associated with this transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PaymentCurrency":{
            "maxLength":"3",
            "type":"string",
            "description":"Currency code used for the original payment transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentAmount":{
            "type":"number",
            "description":"Total amount of the original payment.",
            "nullable":true,
            "x-queryable":true
        },
        "RefundDttm":{
            "type":"string",
            "description":"Date and time when the refund was processed.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "FarReceiptStatus":{
            "maxLength":"30",
            "type":"string",
            "description":"The status of the receipt creation in Oracle Receivables.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentReferenceId":{
            "maxLength":"50",
            "type":"string",
            "description":"Payment reference of the original payment for which the refund is requested.",
            "nullable":false,
            "x-queryable":true
        },
        "RefundFailureCode":{
            "maxLength":"100",
            "type":"string",
            "description":"Failure code returned by the payment gateway.",
            "nullable":true,
            "x-queryable":true
        },
        "RefundReferenceSecondary":{
            "maxLength":"50",
            "type":"string",
            "description":"Additional pass through reference data from calling app. Should not contain PII information.",
            "nullable":true,
            "x-queryable":true
        },
        "RefundReasonCode":{
            "maxLength":"20",
            "type":"string",
            "description":"The reason code for the refund passed by the fee source application.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RefundTransactionId":{
            "maxLength":"50",
            "type":"string",
            "description":"Transaction ID received from the payment gateway, trust account system, or accounts payable system.",
            "nullable":true,
            "x-queryable":true
        },
        "ResponseMessageAdditional":{
            "maxLength":"100",
            "type":"string",
            "description":"Response message returned by the payment gateway.",
            "nullable":true,
            "x-queryable":true
        },
        "ResponseMessageSecondary":{
            "maxLength":"100",
            "type":"string",
            "description":"Response message returned by the payment gateway.",
            "nullable":true,
            "x-queryable":true
        },
        "ResponseMessagePrimary":{
            "maxLength":"100",
            "type":"string",
            "description":"Response message returned by the payment gateway.",
            "nullable":true,
            "x-queryable":true
        },
        "EmailId":{
            "maxLength":"100",
            "type":"string",
            "description":"Email ID used in the original payment transaction or new email ID if allowed by the agency.",
            "nullable":true,
            "x-queryable":true
        },
        "RefundHistoryLine":{
            "title":"Payment Refund Lines",
            "type":"array",
            "description":"The payment refund lines resource is used to view or create payment refund detail lines.",
            "items":{
                "$ref":"#/components/schemas/publicSectorPaymentRefunds-RefundHistoryLine-item-response"
            }
        },
        "RefundStatus":{
            "maxLength":"10",
            "type":"string",
            "description":"The status of the refund. Values are pending, refunded or failed.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentDate":{
            "type":"string",
            "description":"Payment date on which the original payment transaction occurred.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "RefundType":{
            "maxLength":"10",
            "type":"string",
            "description":"Either chargeback (referenced transaction to the same payment method) or refund (referenced transaction but using a different payment method).",
            "nullable":true,
            "x-queryable":true
        },
        "TrustAccountNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the deposit account number associated with the payment.",
            "nullable":true,
            "x-queryable":true
        },
        "RefundAmount":{
            "type":"number",
            "description":"The total refund amount processed by the payment gateway or trust account system.",
            "nullable":false,
            "x-queryable":true
        },
        "RefundDate":{
            "type":"string",
            "description":"Date on which the refund was requested.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "RefundReferenceId":{
            "maxLength":"50",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PaymentMethodCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Payment method code used for the original payment transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "AccountType":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the account type associated with the payment.",
            "nullable":true,
            "x-queryable":true
        },
        "BusinessEntityPartyId":{
            "type":"integer",
            "description":"The unique identifier for the business entity party associated with this transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RefundHistoryKey":{
            "type":"integer",
            "description":"The unique identifier for the refund transaction.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "RefundCurrency":{
            "maxLength":"3",
            "type":"string",
            "description":"Typically, the same currency used for the payment.",
            "nullable":false,
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"Party ID from the original payment transaction or a new party if allowed by the agency.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PublishStatusName":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates whether reconciliation activity has been created for the transaction by name.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PublishedStatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether reconciliation activity has been created for the transaction by code",
            "nullable":false,
            "default":"ORA_UNPUBLISHED",
            "x-queryable":true
        },
        "RefundTransactionType":{
            "maxLength":"30",
            "type":"string",
            "description":"The transaction type of the refund that has to be issued.",
            "nullable":false,
            "default":"ORA_FEE_REFUND",
            "x-queryable":true
        },
        "RefundReferencePrimary":{
            "maxLength":"50",
            "type":"string",
            "description":"Pass through reference data from calling app. Should not contain PII information.",
            "nullable":true,
            "x-queryable":true
        },
        "RefundRequestCode":{
            "maxLength":"50",
            "type":"string",
            "description":"Refund code or reference value returned by the payment gateway.",
            "nullable":true,
            "x-queryable":true
        },
        "AccountPurpose":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the account purpose associated with the payment.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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

• Array of: object publicSectorPaymentRefunds-RefundHistoryLine-item-response

{
    "title":"Payment Refund Lines",
    "type":"array",
    "description":"The payment refund lines resource is used to view or create payment refund detail lines.",
    "items":{
        "$ref":"#/components/schemas/publicSectorPaymentRefunds-RefundHistoryLine-item-response"
    }
}

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."
        }
    }
}

Nested Schema : publicSectorPaymentRefunds-RefundHistoryLine-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "ItemLine":{
            "type":"integer",
            "description":"Item line used for the original payment for this item.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the agency associated with the refund transaction.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "ItemRefundReferencePrimary":{
            "maxLength":"50",
            "type":"string",
            "description":"Attribute identifying item level reference value provided by the refund source application.",
            "nullable":false,
            "x-queryable":true
        },
        "ItemPaymentCurrency":{
            "title":"Item Payment Currency",
            "maxLength":"3",
            "type":"string",
            "description":"Currency code used from the original payment transaction for this item.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemRefundAmount":{
            "type":"number",
            "description":"Refund amount.",
            "nullable":false,
            "x-queryable":true
        },
        "ItemDescription":{
            "maxLength":"100",
            "type":"string",
            "description":"Item description used for the original payment for this item.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemRefundReferenceSecondary":{
            "maxLength":"50",
            "type":"string",
            "description":"Additional attribute identifying item level reference value provided by the refund source application.",
            "nullable":true,
            "x-queryable":true
        },
        "FarReceiptStatus":{
            "maxLength":"30",
            "type":"string",
            "description":"Status of the receipt creation in Oracle Receivables.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemPaymentAmount":{
            "title":"Item Payment Amount",
            "type":"number",
            "description":"Payment amount from the original payment transaction for this item.",
            "nullable":true,
            "x-queryable":true
        },
        "RefundHistoryKey":{
            "type":"integer",
            "description":"The parent history key.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Classification":{
            "maxLength":"3",
            "type":"string",
            "description":"Source application that generated the fee.",
            "nullable":false,
            "x-queryable":true
        },
        "ItemRefundCurrency":{
            "maxLength":"3",
            "type":"string",
            "description":"Refund currency.",
            "nullable":false,
            "x-queryable":true
        },
        "RecordTypeId":{
            "maxLength":"30",
            "type":"string",
            "description":"Source application's record type identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemName":{
            "maxLength":"30",
            "type":"string",
            "description":"Item name used for the original payment for this item.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RefundRecordKey":{
            "type":"integer",
            "description":"The auto-sequencing generated value for the unique identification of each line row.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "RecordId":{
            "title":"Record ID",
            "maxLength":"50",
            "type":"string",
            "description":"Source application's record ID identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "FarCashReceiptId":{
            "type":"integer",
            "description":"Receipt identifier created in Oracle Receivables.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

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"
    }
}

Back to Top