Get a set of payment checkout data
get
/fscmRestApi/resources/11.13.18.05/publicSectorCheckouts/{CheckoutId}
Request
Path Parameters
-
CheckoutId: integer
Unique identifier for the checkout data. Generated using the Fusion unique ID API.
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : publicSectorCheckouts-item
Type:
Show Source
object-
Address1(optional):
string
Maximum Length:
240First line of the payer billing address. Requires a valid street number and name. -
Address2(optional):
string
Maximum Length:
240Second line of the payer billing address such as apartment, suite, unit, building, floor, or village information. -
Address3(optional):
string
Maximum Length:
240Third line of the payer billing address. -
Address4(optional):
string
Maximum Length:
240Fourth line of the payer billing address. -
AgencyId(optional):
integer(int64)
Unique identifier for the agency associated with the row.
-
Amount(optional):
number
Sum of all money required for payment.
-
ApplicationReferenceId(optional):
string
Maximum Length:
50Information to cross-reference key field values back to the source application or module data. -
BusinessEntityDbaName(optional):
string
Maximum Length:
100Doing business as name of the business making the payment. -
BusinessEntityId(optional):
string
Maximum Length:
50The unique identifier for the business entity associated with this transaction. -
BusinessEntityName(optional):
string
Maximum Length:
100Entity name of the business making the payment. -
BusinessEntityPartyId(optional):
integer(int64)
The unique identifier for the business entity party associated with this transaction.
-
BusinessLocationId(optional):
string
Maximum Length:
50The unique identifier for the location of the business entity. -
BusinessLocationPartyId(optional):
integer(int64)
The unique identifier for the party associated with the business entity location.
-
BusinessProfileId(optional):
integer(int64)
The unique identifier for the profile of the business entity associated with this transaction.
-
CallbackURL(optional):
string
Maximum Length:
255Callback URL used to post payload response data to the consuming application. -
CancelURLCheckout(optional):
string
Maximum Length:
255URL provided by the consuming application. The user redirected to this URL when the payment is canceled. -
CancelURLPayment(optional):
string
Maximum Length:
255URL used by the payment gateway to redirect after a payment is canceled or not completed. Oracle internal use only. -
CheckoutId(optional):
integer(int64)
Unique identifier for the checkout data. Generated using the Fusion unique ID API.
-
CheckoutLin(optional):
array Checkout Lines
Title:
Checkout LinesThe checkout lines resource is used to view, create, delete or update checkout lines. -
CheckoutMessage(optional):
string
Maximum Length:
255Additional information regarding the status of the checkout transaction. -
CheckoutStatus(optional):
string
Maximum Length:
1Current status of the checkout transaction. Valid values are paid, canceled, or error. -
CreationDate(optional):
string(date-time)
The date and time when the row was created.
-
CurrencyCode(optional):
string
Maximum Length:
3Currency code for the amount field. -
Description(optional):
string
Maximum Length:
100Description of the checkout transaction. -
LastUpdateDate(optional):
string(date-time)
The date and time when the row was last updated.
-
links(optional):
array Items
Title:
ItemsLink Relations -
PartyId(optional):
integer(int64)
The unique identifier for the party associated with this transaction.
-
PayerCity(optional):
string
Maximum Length:
60City of the payer billing address. -
PayerCountryThreeCharacterCode(optional):
string
Maximum Length:
3International three-digit country code call prefix of the payer's phone number. -
PayerCountryTwoCharacterCode(optional):
string
Maximum Length:
2International two-digit country code call prefix of the payer's phone number. -
PayerCounty(optional):
string
Maximum Length:
60County of the payer billing address. This is a geographical subdivision within a state or region and encompasses multiple cities. -
PayerEmail(optional):
string
Maximum Length:
320Email address of the person making the payment. -
PayerFirstName(optional):
string
Maximum Length:
150First name of the person making the payment. -
PayerLastName(optional):
string
Maximum Length:
150Last name of the person making the payment. -
PayerMiddleName(optional):
string
Maximum Length:
60Middle name of the person making the payment. -
PayerNameSuffix(optional):
string
Maximum Length:
30The suffix of the name of the person making the payment. -
PayerPhone(optional):
string
Maximum Length:
60Phone number of the person making the payment. -
PayerPostalAddOnCode(optional):
string
Maximum Length:
10Additional digits used to identify a specific mail delivery route. -
PayerPostalCode(optional):
string
Maximum Length:
60Postal code of the payer billing address. Can be a series of digits or letters or both. -
PayerProvince(optional):
string
Maximum Length:
60Region code for the payer billing address in non-US countries. In Canada, this is the two character province abbreviation by the Canada Post. -
PayerState(optional):
string
Maximum Length:
60State code of the payer billing address. In the U.S, this is the two character USPS state abbreviation. For example, NY for New York. -
PaymentTrackingData(optional):
string
Maximum Length:
50First checkout reference or tracking number passed by the consuming application. -
PaymentTrackingDataPlus(optional):
string
Maximum Length:
50Second checkout reference or tracking number passed by the consuming application. -
ProfileId(optional):
integer(int64)
The unique identifier for the profile of the user associated with this transaction.
-
ReturnURLCheckout(optional):
string
Maximum Length:
255URL provided by the consuming application. The user is redirected to this URL after the payment is complete. -
ReturnURLPayment(optional):
string
Maximum Length:
255URL used by the payment gateway to redirect after a successful payment. Oracle internal use only.
Nested Schema : Checkout Lines
Type:
arrayTitle:
Checkout LinesThe checkout lines resource is used to view, create, delete or update checkout lines.
Show Source
Nested Schema : publicSectorCheckouts-CheckoutLin-item
Type:
Show Source
object-
AdapterId(optional):
string
Maximum Length:
100Unique identifier of the payment adapter associated with the agency and payment method. -
AgencyId(optional):
integer(int64)
Unique identifier of the agency associated with the row.
-
ApplicationReferenceId(optional):
string
Maximum Length:
50Key identifier as the header passed by the consuming application. For example, the CART_ID value from the Pay Cart. -
ApplicationReferenceIdPlus(optional):
string
Maximum Length:
50Additional key identifier passed by the consuming application. -
BillAgencyId(optional):
integer(int64)
Unique identifier of the agency associated with the invoice.
-
BillType(optional):
string
Maximum Length:
15Determines the default invoice values for invoice form and invoice number ID. -
CaseId(optional):
string
Maximum Length:
50Case identifier for a code enforcement fee. -
CheckoutId(optional):
string
Maximum Length:
50Unique identifier for the checkout data. Generated using the Fusion unique ID API. -
CheckoutLineId(optional):
integer(int64)
Unique sequence number for the checkout row generated using the Fusion unique ID API.
-
Classification(optional):
string
Maximum Length:
3Source application that generated the fee. -
CreationDate(optional):
string(date-time)
The date and time when the row was created.
-
CurrencyCode(optional):
string
Maximum Length:
3Currency code in relation to the item unit price and tax amount. -
Department(optional):
string
Maximum Length:
30A division within the agency devoted to a specific function. -
FeeItemId(optional):
string
Maximum Length:
30The unique identifier for the fee item. -
FeeReferenceId(optional):
string
Maximum Length:
50The reference identifier for the fee item. -
FeeReferencePuid(optional):
string
Maximum Length:
480The PUID reference identifier for the fee item. -
Invoice(optional):
string
Maximum Length:
50Unique billing identifier. -
ItemDescription(optional):
string
Maximum Length:
50Relevant details related to the line item. -
ItemId(optional):
string
Maximum Length:
30Unique identifier of the item to be paid. -
ItemQuantity(optional):
integer(int64)
Quantity of line items. This value cannot be negative.
-
ItemTaxAmount(optional):
number
Tax amount to apply to the line item.
-
ItemUnitPrice(optional):
number
Price per unit of the line item. This value multiplied by the item quantity value equals the total line item amount.
-
LastUpdateDate(optional):
string(date-time)
The date and time when the row was last updated.
-
links(optional):
array Items
Title:
ItemsLink Relations -
PaymentDate(optional):
string(date)
Date when checkout was initiated.
-
PaymentHistoryKey(optional):
integer(int64)
Unique payment history value generated using the Fusion unique ID API.
-
PaymentMethodCode(optional):
string
Maximum Length:
30Type of payment selected during checkout. -
PaymentReferenceId(optional):
string
Maximum Length:
50Global unique payment identifier that comprises a 4-character prefix and random digits. -
PaymentStatus(optional):
string
Maximum Length:
1Status of the payment request. Valid values are paid, cancelled or error. -
RecordTypeId(optional):
string
Maximum Length:
30Source application's record identifier.
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.