Create a payment checkout line
post
/fscmRestApi/resources/11.13.18.05/publicSectorCheckouts/{CheckoutId}/child/CheckoutLin
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
CheckoutId: integer
Unique identifier for the checkout data. Generated using the Fusion unique ID API.
The following table describes the body parameters in the request for this task.
Root 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. -
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. -
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-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. -
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. -
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.