Create a set of payment checkout data
post
/fscmRestApi/resources/11.13.18.05/publicSectorCheckouts
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AccountPurpose: string
Maximum Length:
30
The account purpose associated with the payment. -
AccountType: string
Maximum Length:
30
The account type associated with the payment. -
ActivityType: string
Maximum Length:
30
Default Value:ORA_FEE
The activity type. -
Address1: string
Maximum Length:
240
The first line of the payer billing address. Requires a valid street number and name. -
Address2: string
Maximum Length:
240
The second line of the payer billing address such as apartment, suite, unit, building, floor, or village information. -
Address3: string
Maximum Length:
240
The third line of the payer billing address. -
Address4: string
Maximum Length:
240
The fourth line of the payer billing address. -
AgencyId(required): integer
(int32)
The unique identifier for the agency associated with the row.
-
Amount(required): number
The sum of all money required for payment.
-
ApplicationReferenceId(required): string
Maximum Length:
50
Information to cross-reference key field values back to the source application or module data. -
AutopayMethod: string
Maximum Length:
30
The auto pay method. -
BusinessEntityDbaName: string
Maximum Length:
100
Doing business as the name of the business making the payment. -
BusinessEntityId: string
Maximum Length:
50
The unique identifier for the business entity associated with this transaction. -
BusinessEntityName: string
Maximum Length:
100
The entity name of the business making the payment. -
BusinessEntityPartyId: integer
(int64)
The unique identifier for the business entity party associated with this transaction.
-
BusinessLocationId: string
Maximum Length:
50
The unique identifier for the location of the business entity. -
BusinessLocationPartyId: integer
(int64)
The unique identifier for the party associated with the business entity location.
-
BusinessProfileId: integer
(int64)
The unique identifier for the profile of the business entity associated with this transaction.
-
CallbackURL: string
Maximum Length:
255
The callback URL used to post payload response data to the consuming application. -
CancelURLCheckout: string
Maximum Length:
255
The URL provided by the consuming application. The user is redirected to this URL when the payment is canceled. -
CancelURLPayment: string
Maximum Length:
255
The URL used by the payment gateway to redirect after a payment is canceled or not completed. Oracle internal use only. -
CheckoutId: string
Maximum Length:
18
The unique identifier for the checkout data. Generated using the Fusion unique ID API. -
CheckoutLin: array
Checkout Lines
Title:
Checkout Lines
The checkout lines resource is used to view, create, delete, or update checkout lines. -
CheckoutMessage: string
Maximum Length:
255
Additional information regarding the status of the checkout transaction. -
CheckoutStatus: string
Maximum Length:
1
The current status of the checkout transaction. Valid values are paid, canceled, or error. -
CreditAmountApplied: number
Default Value:
0
The amount of the credit applied to the payment. -
CreditAmountAvailable: number
Default Value:
0
The amount available to apply the payment on account credit. -
CreditAppliedFlag: string
Maximum Length:
1
Default Value:N
The payment on account credit is applied. -
CurrencyCode(required): string
Maximum Length:
3
The currency code for the amount field. -
Description: string
Maximum Length:
100
The description of the checkout transaction. -
PartyId: integer
(int64)
The unique identifier for the party associated with this transaction.
-
PayerCity: string
Maximum Length:
60
The city of the payer billing address. -
PayerCountryThreeCharacterCode: string
Maximum Length:
3
International three-digit country code call prefix of the payer's phone number. -
PayerCountryTwoCharacterCode: string
Maximum Length:
2
International two-digit country code call prefix of the payer's phone number. -
PayerCounty: string
Maximum Length:
60
The county of the payer billing address. This is a geographical subdivision within a state or region and encompasses multiple cities. -
PayerEmail: string
Maximum Length:
320
The email address of the person making the payment. -
PayerFirstName: string
Maximum Length:
150
The first name of the person making the payment. -
PayerLastName: string
Maximum Length:
150
The last name of the person making the payment. -
PayerMiddleName: string
Maximum Length:
60
The middle name of the person making the payment. -
PayerNameSuffix: string
Maximum Length:
30
The suffix of the name of the person making the payment. -
PayerPhone: string
Maximum Length:
60
The phone number of the person making the payment. -
PayerPostalAddOnCode: string
Maximum Length:
10
Additional digits used to identify a specific mail delivery route. -
PayerPostalCode: string
Maximum Length:
60
Postal code of the payer billing address. Can be a series of digits or letters or both. -
PayerProvince: string
Maximum Length:
60
Region code for the payer billing address in non-US countries. In Canada, this is the two character province abbreviation by the Canada Post. -
PayerState: string
Maximum Length:
60
State code of the payer billing address. In the US, this is the two character USPS state abbreviation. For example, NY for New York. -
PaymentTrackingData: string
Maximum Length:
50
First checkout reference or tracking number passed by the consuming application. -
PaymentTrackingDataPlus: string
Maximum Length:
50
Second checkout reference or tracking number passed by the consuming application. -
ProfileId: integer
(int64)
The unique identifier for the profile of the user associated with this transaction.
-
ReconcileDatetime: string
(date-time)
The date and time of the payment reconciliation.
-
ReconcileStatus: string
Maximum Length:
30
The payment reconciliation status. -
ReconcileType: string
Maximum Length:
30
Indicates whether the payment was reconciled through an online API or by the ESS job. -
ReturnURLCheckout: string
Maximum Length:
255
The URL provided by the consuming application. The user is redirected to this URL after the payment is complete. -
ReturnURLPayment: string
Maximum Length:
255
The URL used by the payment gateway to redirect after a successful payment. Oracle internal use only. -
ReversalTransactionType: string
Maximum Length:
30
Default Value:ORA_NONE
Indicates the type of the reversal transaction. -
TrustAccountNumber: string
Maximum Length:
30
The deposit account number associated with the payment. -
UnappliedFlag: string
Maximum Length:
1
Default Value:N
Identifies an unapplied payment record.
Nested Schema : Checkout Lines
Type:
array
Title:
Checkout Lines
The checkout lines resource is used to view, create, delete, or update checkout lines.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
AdapterId: string
Maximum Length:
100
The unique identifier of the payment adapter associated with the agency and payment method. -
Address1: string
Maximum Length:
240
The first line of the permit address. -
Address2: string
Maximum Length:
240
The second line of the permit address, if present. -
Address3: string
Maximum Length:
240
The third line of the permit address, if present. -
Address4: string
Maximum Length:
240
The fourth line of the permit address, if present. -
AgencyId: integer
(int32)
The unique identifier of the agency associated with the row.
-
ApplicationReferenceId: string
Maximum Length:
50
The key identifier as the header passed by the consuming application. For example, the CART_ID value from the Pay Cart. -
ApplicationReferenceIdPlus: string
Maximum Length:
50
Additional key identifier passed by the consuming application. -
BillAgencyId: integer
(int64)
The unique identifier of the agency associated with the invoice.
-
BillType: string
Maximum Length:
15
Determines the default invoice values for invoice form and invoice number ID. -
BusBusinessLegalName: string
Maximum Length:
240
The legal name of a business. -
BusBusinessName: string
Maximum Length:
100
The name of a business. -
BusDbaBusinessName: string
Maximum Length:
100
The doing business as name of a business. -
BusinessEntityId: string
Maximum Length:
50
The unique identifier of a business. -
BusinessLocationId: string
Maximum Length:
50
The unique identifier of a business location. -
BusinessLocationPartyId: integer
(int64)
The party identifier of a business location.
-
BusPartyId: integer
(int64)
The party identifier of a business.
-
CaseId: string
Maximum Length:
50
The case identifier for a code enforcement fee. -
CheckoutId: string
Maximum Length:
50
The unique identifier for the checkout data. Generated using the Fusion unique ID API. -
CheckoutLineId: integer
(int64)
The unique sequence number for the checkout row generated using the Fusion unique ID API.
-
City: string
Maximum Length:
60
The city in the permit address. -
Classification: string
Maximum Length:
3
The source application that generated the fee. -
Country: string
Maximum Length:
60
The country in the permit address. -
County: string
Maximum Length:
60
The county in the permit address. -
CurrencyCode: string
Maximum Length:
3
The currency code in relation to the item unit price and tax amount. -
Department: string
Maximum Length:
30
A division within the agency devoted to a specific function. -
FeeItemId: string
Maximum Length:
30
The unique identifier for the fee item. -
FeeReferenceId: string
Maximum Length:
50
The reference identifier for the fee item. -
FeeReferencePuid: string
Maximum Length:
480
The PUID reference identifier for the fee item. -
Invoice: string
Maximum Length:
50
The unique billing identifier. -
ItemDescription: string
Maximum Length:
50
Relevant details related to the line item. -
ItemId: string
Maximum Length:
30
The unique identifier of the item to be paid. -
ItemQuantity: integer
Quantity of line items. This value cannot be negative.
-
ItemTaxAmount: number
Default Value:
0
The tax amount to apply to the line item. -
ItemUnitPrice: number
Price per unit of the line item. This value multiplied by the item quantity value equals the total line item amount.
-
OrganizationName: string
Maximum Length:
360
The name of an organization. -
PaymentDate: string
(date)
The date when the checkout was initiated.
-
PaymentHistoryKey: integer
(int64)
The unique payment history value generated using the Fusion unique ID API.
-
PaymentMethodCode: string
Maximum Length:
30
The type of payment selected during checkout. -
PaymentReferenceId: string
Maximum Length:
50
The global unique payment identifier that comprises a 4-character prefix and random digits. -
PaymentStatus: string
Maximum Length:
1
The status of the payment request. Valid values are paid, cancelled, or error. -
PostalCode: string
Maximum Length:
60
The postal code in the permit address. -
PostalPlus4Code: string
Maximum Length:
20
The extended postal code in the permit address. -
Province: string
Maximum Length:
60
The province in the permit address. -
RecordId: string
Maximum Length:
50
The source application's record identifier. -
RecordTypeId: string
Maximum Length:
30
The source application's record identifier. -
State: string
Maximum Length:
60
The state in the permit address.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : publicSectorCheckouts-item-response
Type:
Show Source
object
-
AccountPurpose: string
Maximum Length:
30
The account purpose associated with the payment. -
AccountType: string
Maximum Length:
30
The account type associated with the payment. -
ActivityType: string
Maximum Length:
30
Default Value:ORA_FEE
The activity type. -
Address1: string
Maximum Length:
240
The first line of the payer billing address. Requires a valid street number and name. -
Address2: string
Maximum Length:
240
The second line of the payer billing address such as apartment, suite, unit, building, floor, or village information. -
Address3: string
Maximum Length:
240
The third line of the payer billing address. -
Address4: string
Maximum Length:
240
The fourth line of the payer billing address. -
AgencyId: integer
(int32)
The unique identifier for the agency associated with the row.
-
Amount: number
The sum of all money required for payment.
-
ApplicationReferenceId: string
Maximum Length:
50
Information to cross-reference key field values back to the source application or module data. -
AutopayMethod: string
Maximum Length:
30
The auto pay method. -
BusinessEntityDbaName: string
Maximum Length:
100
Doing business as the name of the business making the payment. -
BusinessEntityId: string
Maximum Length:
50
The unique identifier for the business entity associated with this transaction. -
BusinessEntityName: string
Maximum Length:
100
The entity name of the business making the payment. -
BusinessEntityPartyId: integer
(int64)
The unique identifier for the business entity party associated with this transaction.
-
BusinessLocationId: string
Maximum Length:
50
The unique identifier for the location of the business entity. -
BusinessLocationPartyId: integer
(int64)
The unique identifier for the party associated with the business entity location.
-
BusinessProfileId: integer
(int64)
The unique identifier for the profile of the business entity associated with this transaction.
-
CallbackURL: string
Maximum Length:
255
The callback URL used to post payload response data to the consuming application. -
CancelURLCheckout: string
Maximum Length:
255
The URL provided by the consuming application. The user is redirected to this URL when the payment is canceled. -
CancelURLPayment: string
Maximum Length:
255
The URL used by the payment gateway to redirect after a payment is canceled or not completed. Oracle internal use only. -
CheckoutId: string
Maximum Length:
18
The unique identifier for the checkout data. Generated using the Fusion unique ID API. -
CheckoutLin: array
Checkout Lines
Title:
Checkout Lines
The checkout lines resource is used to view, create, delete, or update checkout lines. -
CheckoutMessage: string
Maximum Length:
255
Additional information regarding the status of the checkout transaction. -
CheckoutStatus: string
Maximum Length:
1
The current status of the checkout transaction. Valid values are paid, canceled, or error. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the row was created. -
CreditAmountApplied: number
Default Value:
0
The amount of the credit applied to the payment. -
CreditAmountAvailable: number
Default Value:
0
The amount available to apply the payment on account credit. -
CreditAppliedFlag: string
Maximum Length:
1
Default Value:N
The payment on account credit is applied. -
CurrencyCode: string
Maximum Length:
3
The currency code for the amount field. -
Description: string
Maximum Length:
100
The description of the checkout transaction. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the row was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartyId: integer
(int64)
The unique identifier for the party associated with this transaction.
-
PayerCity: string
Maximum Length:
60
The city of the payer billing address. -
PayerCountryThreeCharacterCode: string
Maximum Length:
3
International three-digit country code call prefix of the payer's phone number. -
PayerCountryTwoCharacterCode: string
Maximum Length:
2
International two-digit country code call prefix of the payer's phone number. -
PayerCounty: string
Maximum Length:
60
The county of the payer billing address. This is a geographical subdivision within a state or region and encompasses multiple cities. -
PayerEmail: string
Maximum Length:
320
The email address of the person making the payment. -
PayerFirstName: string
Maximum Length:
150
The first name of the person making the payment. -
PayerLastName: string
Maximum Length:
150
The last name of the person making the payment. -
PayerMiddleName: string
Maximum Length:
60
The middle name of the person making the payment. -
PayerNameSuffix: string
Maximum Length:
30
The suffix of the name of the person making the payment. -
PayerPhone: string
Maximum Length:
60
The phone number of the person making the payment. -
PayerPostalAddOnCode: string
Maximum Length:
10
Additional digits used to identify a specific mail delivery route. -
PayerPostalCode: string
Maximum Length:
60
Postal code of the payer billing address. Can be a series of digits or letters or both. -
PayerProvince: string
Maximum Length:
60
Region code for the payer billing address in non-US countries. In Canada, this is the two character province abbreviation by the Canada Post. -
PayerState: string
Maximum Length:
60
State code of the payer billing address. In the US, this is the two character USPS state abbreviation. For example, NY for New York. -
PaymentTrackingData: string
Maximum Length:
50
First checkout reference or tracking number passed by the consuming application. -
PaymentTrackingDataPlus: string
Maximum Length:
50
Second checkout reference or tracking number passed by the consuming application. -
ProfileId: integer
(int64)
The unique identifier for the profile of the user associated with this transaction.
-
ReconcileDatetime: string
(date-time)
The date and time of the payment reconciliation.
-
ReconcileStatus: string
Maximum Length:
30
The payment reconciliation status. -
ReconcileType: string
Maximum Length:
30
Indicates whether the payment was reconciled through an online API or by the ESS job. -
ReturnURLCheckout: string
Maximum Length:
255
The URL provided by the consuming application. The user is redirected to this URL after the payment is complete. -
ReturnURLPayment: string
Maximum Length:
255
The URL used by the payment gateway to redirect after a successful payment. Oracle internal use only. -
ReversalTransactionType: string
Maximum Length:
30
Default Value:ORA_NONE
Indicates the type of the reversal transaction. -
TrustAccountNumber: string
Maximum Length:
30
The deposit account number associated with the payment. -
UnappliedFlag: string
Maximum Length:
1
Default Value:N
Identifies an unapplied payment record.
Nested Schema : Checkout Lines
Type:
array
Title:
Checkout Lines
The checkout lines resource is used to view, create, delete, or update checkout lines.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorCheckouts-CheckoutLin-item-response
Type:
Show Source
object
-
AdapterId: string
Maximum Length:
100
The unique identifier of the payment adapter associated with the agency and payment method. -
Address1: string
Maximum Length:
240
The first line of the permit address. -
Address2: string
Maximum Length:
240
The second line of the permit address, if present. -
Address3: string
Maximum Length:
240
The third line of the permit address, if present. -
Address4: string
Maximum Length:
240
The fourth line of the permit address, if present. -
AgencyId: integer
(int32)
The unique identifier of the agency associated with the row.
-
ApplicationReferenceId: string
Maximum Length:
50
The key identifier as the header passed by the consuming application. For example, the CART_ID value from the Pay Cart. -
ApplicationReferenceIdPlus: string
Maximum Length:
50
Additional key identifier passed by the consuming application. -
BillAgencyId: integer
(int64)
The unique identifier of the agency associated with the invoice.
-
BillType: string
Maximum Length:
15
Determines the default invoice values for invoice form and invoice number ID. -
BusBusinessLegalName: string
Maximum Length:
240
The legal name of a business. -
BusBusinessName: string
Maximum Length:
100
The name of a business. -
BusDbaBusinessName: string
Maximum Length:
100
The doing business as name of a business. -
BusinessEntityId: string
Maximum Length:
50
The unique identifier of a business. -
BusinessLocationId: string
Maximum Length:
50
The unique identifier of a business location. -
BusinessLocationPartyId: integer
(int64)
The party identifier of a business location.
-
BusPartyId: integer
(int64)
The party identifier of a business.
-
CaseId: string
Maximum Length:
50
The case identifier for a code enforcement fee. -
CheckoutId: string
Maximum Length:
50
The unique identifier for the checkout data. Generated using the Fusion unique ID API. -
CheckoutLineId: integer
(int64)
The unique sequence number for the checkout row generated using the Fusion unique ID API.
-
City: string
Maximum Length:
60
The city in the permit address. -
Classification: string
Maximum Length:
3
The source application that generated the fee. -
Country: string
Maximum Length:
60
The country in the permit address. -
County: string
Maximum Length:
60
The county in the permit address. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the row was created. -
CurrencyCode: string
Maximum Length:
3
The currency code in relation to the item unit price and tax amount. -
Department: string
Maximum Length:
30
A division within the agency devoted to a specific function. -
FeeItemId: string
Maximum Length:
30
The unique identifier for the fee item. -
FeeReferenceId: string
Maximum Length:
50
The reference identifier for the fee item. -
FeeReferencePuid: string
Maximum Length:
480
The PUID reference identifier for the fee item. -
Invoice: string
Maximum Length:
50
The unique billing identifier. -
ItemDescription: string
Maximum Length:
50
Relevant details related to the line item. -
ItemId: string
Maximum Length:
30
The unique identifier of the item to be paid. -
ItemQuantity: integer
Quantity of line items. This value cannot be negative.
-
ItemTaxAmount: number
Default Value:
0
The tax amount to apply to the line item. -
ItemUnitPrice: number
Price per unit of the line item. This value multiplied by the item quantity value equals the total line item amount.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the row was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationName: string
Maximum Length:
360
The name of an organization. -
PaymentDate: string
(date)
The date when the checkout was initiated.
-
PaymentHistoryKey: integer
(int64)
The unique payment history value generated using the Fusion unique ID API.
-
PaymentMethodCode: string
Maximum Length:
30
The type of payment selected during checkout. -
PaymentReferenceId: string
Maximum Length:
50
The global unique payment identifier that comprises a 4-character prefix and random digits. -
PaymentStatus: string
Maximum Length:
1
The status of the payment request. Valid values are paid, cancelled, or error. -
PostalCode: string
Maximum Length:
60
The postal code in the permit address. -
PostalPlus4Code: string
Maximum Length:
20
The extended postal code in the permit address. -
Province: string
Maximum Length:
60
The province in the permit address. -
RecordId: string
Maximum Length:
50
The source application's record identifier. -
RecordTypeId: string
Maximum Length:
30
The source application's record identifier. -
State: string
Maximum Length:
60
The state in the permit address.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- CheckoutLin
-
Parameters:
- CheckoutId:
$request.path.CheckoutId
The checkout lines resource is used to view, create, delete, or update checkout lines. - CheckoutId: