Create a set of payment checkout data
post
/fscmRestApi/resources/11.13.18.05/publicSectorCheckouts
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorCheckouts-item
Type:
Show Source
object
-
Address1(optional):
string
Maximum Length:
240
First line of the payer billing address. Requires a valid street number and name. -
Address2(optional):
string
Maximum Length:
240
Second line of the payer billing address such as apartment, suite, unit, building, floor, or village information. -
Address3(optional):
string
Maximum Length:
240
Third line of the payer billing address. -
Address4(optional):
string
Maximum Length:
240
Fourth 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:
50
Information to cross-reference key field values back to the source application or module data. -
BusinessEntityDbaName(optional):
string
Maximum Length:
100
Doing business as name of the business making the payment. -
BusinessEntityId(optional):
string
Maximum Length:
50
The unique identifier for the business entity associated with this transaction. -
BusinessEntityName(optional):
string
Maximum Length:
100
Entity 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:
50
The 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:
255
Callback URL used to post payload response data to the consuming application. -
CancelURLCheckout(optional):
string
Maximum Length:
255
URL provided by the consuming application. The user redirected to this URL when the payment is canceled. -
CancelURLPayment(optional):
string
Maximum Length:
255
URL 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 Lines
The checkouts resource is used to view, create, delete or update checkout data. -
CheckoutMessage(optional):
string
Maximum Length:
255
Additional information regarding the status of the checkout transaction. -
CheckoutStatus(optional):
string
Maximum Length:
1
Current status of the checkout transaction. Valid values are paid, canceled, or error. -
CurrencyCode(optional):
string
Maximum Length:
3
Currency code for the amount field. -
Description(optional):
string
Maximum Length:
100
Description of the checkout transaction. -
links(optional):
array Items
Title:
Items
Link Relations -
PartyId(optional):
integer(int64)
The unique identifier for the party associated with this transaction.
-
PayerCity(optional):
string
Maximum Length:
60
City of the payer billing address. -
PayerCountryThreeCharacterCode(optional):
string
Maximum Length:
3
International three-digit country code call prefix of the payer's phone number. -
PayerCountryTwoCharacterCode(optional):
string
Maximum Length:
2
International two-digit country code call prefix of the payer's phone number. -
PayerCounty(optional):
string
Maximum Length:
60
County of the payer billing address. This is a geographical subdivision within a state or region and encompasses multiple cities. -
PayerEmail(optional):
string
Maximum Length:
320
Email address of the person making the payment. -
PayerFirstName(optional):
string
Maximum Length:
150
First name of the person making the payment. -
PayerLastName(optional):
string
Maximum Length:
150
Last name of the person making the payment. -
PayerMiddleName(optional):
string
Maximum Length:
60
Middle name of the person making the payment. -
PayerNameSuffix(optional):
string
Maximum Length:
30
The suffix of the name of the person making the payment. -
PayerPhone(optional):
string
Maximum Length:
60
Phone number of the person making the payment. -
PayerPostalAddOnCode(optional):
string
Maximum Length:
10
Additional digits used to identify a specific mail delivery route. -
PayerPostalCode(optional):
string
Maximum Length:
60
Postal code of the payer billing address. Can be a series of digits or letters or both. -
PayerProvince(optional):
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(optional):
string
Maximum Length:
60
State 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:
50
First checkout reference or tracking number passed by the consuming application. -
PaymentTrackingDataPlus(optional):
string
Maximum Length:
50
Second 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:
255
URL provided by the consuming application. The user is redirected to this URL after the payment is complete. -
ReturnURLPayment(optional):
string
Maximum Length:
255
URL used by the payment gateway to redirect after a successful payment. Oracle internal use only.
Nested Schema : Checkout Lines
Type:
array
Title:
Checkout Lines
The checkouts resource is used to view, create, delete or update checkout data.
Show Source
Nested Schema : publicSectorCheckouts-CheckoutLin-item
Type:
Show Source
object
-
AdapterId(optional):
string
Maximum Length:
100
Unique 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:
50
Key identifier as the header passed by the consuming application. For example, the CART_ID value from the Pay Cart. -
ApplicationReferenceIdPlus(optional):
string
Maximum Length:
50
Additional 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:
15
Determines the default invoice values for invoice form and invoice number ID. -
CheckoutId(optional):
string
Maximum Length:
50
Unique 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:
3
Source application that generated the fee. -
CurrencyCode(optional):
string
Maximum Length:
3
Currency code in relation to the item unit price and tax amount. -
Department(optional):
string
Maximum Length:
30
A division within the agency devoted to a specific function. -
Invoice(optional):
string
Maximum Length:
50
Unique billing identifier. -
ItemDescription(optional):
string
Maximum Length:
50
Relevant details related to the line item. -
ItemId(optional):
string
Maximum Length:
30
Unique 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.
-
links(optional):
array Items
Title:
Items
Link 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:
30
Type of payment selected during checkout. -
PaymentReferenceId(optional):
string
Maximum Length:
50
Global unique payment identifier that comprises a 4-character prefix and random digits. -
PaymentStatus(optional):
string
Maximum Length:
1
Status of the payment request. Valid values are paid, cancelled or error.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.
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:
240
First line of the payer billing address. Requires a valid street number and name. -
Address2(optional):
string
Maximum Length:
240
Second line of the payer billing address such as apartment, suite, unit, building, floor, or village information. -
Address3(optional):
string
Maximum Length:
240
Third line of the payer billing address. -
Address4(optional):
string
Maximum Length:
240
Fourth 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:
50
Information to cross-reference key field values back to the source application or module data. -
BusinessEntityDbaName(optional):
string
Maximum Length:
100
Doing business as name of the business making the payment. -
BusinessEntityId(optional):
string
Maximum Length:
50
The unique identifier for the business entity associated with this transaction. -
BusinessEntityName(optional):
string
Maximum Length:
100
Entity 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:
50
The 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:
255
Callback URL used to post payload response data to the consuming application. -
CancelURLCheckout(optional):
string
Maximum Length:
255
URL provided by the consuming application. The user redirected to this URL when the payment is canceled. -
CancelURLPayment(optional):
string
Maximum Length:
255
URL 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 Lines
The checkouts resource is used to view, create, delete or update checkout data. -
CheckoutMessage(optional):
string
Maximum Length:
255
Additional information regarding the status of the checkout transaction. -
CheckoutStatus(optional):
string
Maximum Length:
1
Current status of the checkout transaction. Valid values are paid, canceled, or error. -
CurrencyCode(optional):
string
Maximum Length:
3
Currency code for the amount field. -
Description(optional):
string
Maximum Length:
100
Description of the checkout transaction. -
links(optional):
array Items
Title:
Items
Link Relations -
PartyId(optional):
integer(int64)
The unique identifier for the party associated with this transaction.
-
PayerCity(optional):
string
Maximum Length:
60
City of the payer billing address. -
PayerCountryThreeCharacterCode(optional):
string
Maximum Length:
3
International three-digit country code call prefix of the payer's phone number. -
PayerCountryTwoCharacterCode(optional):
string
Maximum Length:
2
International two-digit country code call prefix of the payer's phone number. -
PayerCounty(optional):
string
Maximum Length:
60
County of the payer billing address. This is a geographical subdivision within a state or region and encompasses multiple cities. -
PayerEmail(optional):
string
Maximum Length:
320
Email address of the person making the payment. -
PayerFirstName(optional):
string
Maximum Length:
150
First name of the person making the payment. -
PayerLastName(optional):
string
Maximum Length:
150
Last name of the person making the payment. -
PayerMiddleName(optional):
string
Maximum Length:
60
Middle name of the person making the payment. -
PayerNameSuffix(optional):
string
Maximum Length:
30
The suffix of the name of the person making the payment. -
PayerPhone(optional):
string
Maximum Length:
60
Phone number of the person making the payment. -
PayerPostalAddOnCode(optional):
string
Maximum Length:
10
Additional digits used to identify a specific mail delivery route. -
PayerPostalCode(optional):
string
Maximum Length:
60
Postal code of the payer billing address. Can be a series of digits or letters or both. -
PayerProvince(optional):
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(optional):
string
Maximum Length:
60
State 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:
50
First checkout reference or tracking number passed by the consuming application. -
PaymentTrackingDataPlus(optional):
string
Maximum Length:
50
Second 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:
255
URL provided by the consuming application. The user is redirected to this URL after the payment is complete. -
ReturnURLPayment(optional):
string
Maximum Length:
255
URL used by the payment gateway to redirect after a successful payment. Oracle internal use only.
Nested Schema : Checkout Lines
Type:
array
Title:
Checkout Lines
The checkouts resource is used to view, create, delete or update checkout data.
Show Source
Nested Schema : publicSectorCheckouts-CheckoutLin-item
Type:
Show Source
object
-
AdapterId(optional):
string
Maximum Length:
100
Unique 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:
50
Key identifier as the header passed by the consuming application. For example, the CART_ID value from the Pay Cart. -
ApplicationReferenceIdPlus(optional):
string
Maximum Length:
50
Additional 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:
15
Determines the default invoice values for invoice form and invoice number ID. -
CheckoutId(optional):
string
Maximum Length:
50
Unique 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:
3
Source application that generated the fee. -
CurrencyCode(optional):
string
Maximum Length:
3
Currency code in relation to the item unit price and tax amount. -
Department(optional):
string
Maximum Length:
30
A division within the agency devoted to a specific function. -
Invoice(optional):
string
Maximum Length:
50
Unique billing identifier. -
ItemDescription(optional):
string
Maximum Length:
50
Relevant details related to the line item. -
ItemId(optional):
string
Maximum Length:
30
Unique 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.
-
links(optional):
array Items
Title:
Items
Link 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:
30
Type of payment selected during checkout. -
PaymentReferenceId(optional):
string
Maximum Length:
50
Global unique payment identifier that comprises a 4-character prefix and random digits. -
PaymentStatus(optional):
string
Maximum Length:
1
Status of the payment request. Valid values are paid, cancelled or error.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.