REST API for Oracle Public Sector Permitting and Licensing

Get payment data

get

/fscmRestApi/resources/11.13.18.05/publicSectorPaymentCommunications/{PaymentHistoryKey}

Request

Path Parameters

PaymentHistoryKey(required): integer

A unique identifier for the payment transaction.

Query Parameters

dependency: string

This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields 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 fields 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 fields. 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 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
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
onlyData: boolean

The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

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.

Root Schema : publicSectorPaymentCommunications-item-response

Type: object

Show Source

AmountDue: number

Title: Amount Due

Read Only: true

The total payment amount due, which is the sum total of the amounts on the payment history lines.
BusinessEntityDbaName: string

Read Only: true

Maximum Length: 100

Doing business as name of the business making the payment.
BusinessEntityName: string

Read Only: true

Maximum Length: 100

Entity name of the business making the payment.
BusinessEntityPartyId: integer (int64)

Read Only: true

The unique identifier for the business entity party associated with this transaction.
CreditAmountApplied: number

Title: Credit Amount Applied

Read Only: true

The amount of credit applied to the payment.
CreditAmountAvailable: number

Title: Credit Amount Available

Read Only: true

The amount available to apply a payment on account credit.
CreditAppliedFlag: string

Title: Credit Applied

Read Only: true

Maximum Length: 1

The payment on account credit is applied.
CreditCardDigits: integer (int32)

Title: Credit Card Digits

Read Only: true

The last four digits of the credit card number used for a payment.
CreditCardType: string

Title: Credit Card Type

Read Only: true

Maximum Length: 4

The type of credit card used for a payment. Examples are Mastercard and Visa.
DepartmentId: string

Title: Department ID List

Read Only: true

Maximum Length: 30

Indicates the department ID.
links: array Links

Title: Links

The link relations associated with the resource instance.
PartyId: integer (int64)

Read Only: true

The unique identifier for the party associated with this transaction.
PayerAddress: string

Read Only: true

Maximum Length: 240

The address of the person who made the payment.
PayerEmail: string

Title: Email

Read Only: true

Maximum Length: 320

Email address of the payer for a payment transaction.
PayerFirstName: string

Title: First Name

Read Only: true

Maximum Length: 150

The first name of the payer for a payment transaction.
PayerLastName: string

Title: Last Name

Read Only: true

Maximum Length: 150

The last name of the payer for a payment transaction.
PayerMiddleName: string

Title: Middle Name

Read Only: true

Maximum Length: 60

The middle name of the payer for a payment transaction.
PayerName: string

Read Only: true

Maximum Length: 100

The name of the person who made the payment.
PayerNameSuffix: string

Title: Suffix

Read Only: true

Maximum Length: 30

Suffix for the name of the payer for a payment transaction.
PaymentAmount: number

Title: Amount Paid

Read Only: true

Total payment amount authorized and settled by the payment gateway or verified by the trust account system.
PaymentCurrency: string

Title: Currency

Read Only: true

Maximum Length: 3

Currency used for the payment transaction.
PaymentDate: string (date)

Title: Receipt Date

Read Only: true

Date on which the payment transaction occurred.
PaymentHistoryKey: integer

Read Only: true

A unique identifier for the payment transaction.
PaymentMethod: string

Title: Payment Method

Read Only: true

Maximum Length: 80

Method of payment used for a payment transaction, such as credit card, cash, personal check, or cashier???s check.
PaymentReferenceId: string

Title: Payment Reference ID

Read Only: true

Maximum Length: 50

A reference value created by the payment module and sent as pass through data to the payment processor, trust account, and cash drawer.
PaymentTrackingData: string

Title: Reference

Read Only: true

Maximum Length: 50

The identifying attribute passed during checkout by the originator of the assessed fees.
PaymentTrackingDataPlus: string

Title: Additional Reference

Read Only: true

Maximum Length: 50

The additional identifying attribute passed during checkout by the originator of the assessed fees.
RecordType: string

Title: Record Type List

Read Only: true

Maximum Length: 30

Indicates the record type.
ServiceChargeAmount: number

Title: Service Charge Amount

Read Only: true

The convenience fee assessed by the department for using a specific payment method.
ServiceChargeCurrency: string

Title: Service Charge Currency

Read Only: true

Maximum Length: 3

The currency used for the service charge.
TrustAccountNumber: string

Title: Deposit Account Number

Read Only: true

Maximum Length: 30

An attribute that identifies the logical trust account number.

{
    "type":"object",
    "properties":{
        "CreditAmountAvailable":{
            "title":"Credit Amount Available",
            "type":"number",
            "description":"The amount available to apply a payment on account credit.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Amount":"Y"
            },
            "x-queryable":true
        },
        "ServiceChargeAmount":{
            "title":"Service Charge Amount",
            "type":"number",
            "description":"The convenience fee assessed by the department for using a specific payment method.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Amount":"Y"
            },
            "x-queryable":true
        },
        "PayerAddress":{
            "maxLength":"240",
            "type":"string",
            "description":"The address of the person who made the payment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PaymentCurrency":{
            "title":"Currency",
            "maxLength":"3",
            "type":"string",
            "description":"Currency used for the payment transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PayerEmail":{
            "title":"Email",
            "maxLength":"320",
            "type":"string",
            "description":"Email address of the payer for a payment transaction.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Email":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "PaymentAmount":{
            "title":"Amount Paid",
            "type":"number",
            "description":"Total payment amount authorized and settled by the payment gateway or verified by the trust account system.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "Amount":"Y"
            },
            "x-queryable":true
        },
        "ServiceChargeCurrency":{
            "title":"Service Charge Currency",
            "maxLength":"3",
            "type":"string",
            "description":"The currency used for the service charge.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PaymentReferenceId":{
            "title":"Payment Reference ID",
            "maxLength":"50",
            "type":"string",
            "description":"A reference value created by the payment module and sent as pass through data to the payment processor, trust account, and cash drawer.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PayerFirstName":{
            "title":"First Name",
            "maxLength":"150",
            "type":"string",
            "description":"The first name of the payer for a payment transaction.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "RecordType":{
            "title":"Record Type List",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the record type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PayerMiddleName":{
            "title":"Middle Name",
            "maxLength":"60",
            "type":"string",
            "description":"The middle name of the payer for a payment transaction.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "CreditAppliedFlag":{
            "title":"Credit Applied",
            "maxLength":"1",
            "type":"string",
            "description":"The payment on account credit is applied.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BusinessEntityDbaName":{
            "maxLength":"100",
            "type":"string",
            "description":"Doing business as name of the business making the payment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AmountDue":{
            "title":"Amount Due",
            "type":"number",
            "description":"The total payment amount due, which is the sum total of the amounts on the payment history lines.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Amount":"Y"
            },
            "x-queryable":true
        },
        "CreditAmountApplied":{
            "title":"Credit Amount Applied",
            "type":"number",
            "description":"The amount of credit applied to the payment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Amount":"Y"
            },
            "x-queryable":true
        },
        "CreditCardDigits":{
            "title":"Credit Card Digits",
            "type":"integer",
            "description":"The last four digits of the credit card number used for a payment.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"4"
            },
            "x-queryable":true
        },
        "PaymentDate":{
            "title":"Receipt Date",
            "type":"string",
            "description":"Date on which the payment transaction occurred.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PaymentTrackingDataPlus":{
            "title":"Additional Reference",
            "maxLength":"50",
            "type":"string",
            "description":"The additional identifying attribute passed during checkout by the originator of the assessed fees.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PaymentTrackingData":{
            "title":"Reference",
            "maxLength":"50",
            "type":"string",
            "description":"The identifying attribute passed during checkout by the originator of the assessed fees.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TrustAccountNumber":{
            "title":"Deposit Account Number",
            "maxLength":"30",
            "type":"string",
            "description":"An attribute that identifies the logical trust account number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PayerName":{
            "maxLength":"100",
            "type":"string",
            "description":"The name of the person who made the payment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditCardType":{
            "title":"Credit Card Type",
            "maxLength":"4",
            "type":"string",
            "description":"The type of credit card used for a payment. Examples are Mastercard and Visa.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PayerNameSuffix":{
            "title":"Suffix",
            "maxLength":"30",
            "type":"string",
            "description":"Suffix for the name of the payer for a payment transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessEntityPartyId":{
            "type":"integer",
            "description":"The unique identifier for the business entity party associated with this transaction.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PayerLastName":{
            "title":"Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"The last name of the payer for a payment transaction.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "PaymentHistoryKey":{
            "type":"integer",
            "description":"A unique identifier for the payment transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier for the party associated with this transaction.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "precision":"18",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "PaymentMethod":{
            "title":"Payment Method",
            "maxLength":"80",
            "type":"string",
            "description":"Method of payment used for a payment transaction, such as credit card, cash, personal check, or cashier???s check.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessEntityName":{
            "maxLength":"100",
            "type":"string",
            "description":"Entity name of the business making the payment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DepartmentId":{
            "title":"Department ID List",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the department ID.",
            "nullable":true,
            "readOnly":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 : 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."
        }
    }
}