1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Order Management
  4. Sales Orders for Order Hub
  5. Order Lines
  6. Payments

Get one payment

get

/fscmRestApi/resources/11.13.18.05/salesOrdersForOrderHub/{OrderKey}/child/lines/{linesUniqID}/child/payments/{PaymentTransactionId}

Request

Path Parameters
  • Value that uniquely identifies the sales order. It can have the following formats.

    - Concatenation of SourceOrderSystem, a colon, and the value of SourceTransactionId. For orders created through the Oracle Fusion Cloud Order Management work area, the SourceTransactionId is same as the HeaderId. For example, if SourceOrderSystem is LEG and SourceTransactionId is R13_Sample_Order, the value of this attribute is LEG:R13_Sample_Order. This format of the OrderKey in the URL always returns the latest version of the sales order. When a draft exists, that becomes the latest version of the sales order. When invoking GET sales order using this OrderKey format, the URLs in the "links" section point to the latest version of the sales order and the corresponding child objects.
    Example: /salesOrdersForOrderHub/LEG:R13_Sample_Order points to the latest version of the order with SourceTransactionId "R13_Sample_Order" in the SourceOrderSystem "LEG".

    - Primary key of the sales order, which is HeaderId. This format of the OrderKey is useful when the order has multiple revisions because it helps in accessing either the older version or the latest version of the order. When there's a draft revision then HeaderId can be used to access the processing order. When invoking GET sales order using this OrderKey format, the URLs in the "links" section also point to that specific version of the sales order and the corresponding child objects. Only the Get operation is supported on older revisions of the order.
    Example: /salesOrdersForOrderHub/12345 points to an order with HeaderId 12345.

    When a q parameter or query finder is used to GET an order that has multiple versions then the latest version has the OrderKey in the format <sourceOrderSystem>:<SourceTransactionId> whereas reference orders have OrderKey in the format of HeaderId.
  • Value that uniquely identifies the payment.
  • This is the hash key of the attributes which make up the composite key for the Order Lines resource and used to uniquely identify an instance of Order Lines. The client should not generate the hash key value. Instead, the client should query on the Order Lines collection resource in order to navigate to a specific instance of Order Lines to get the hash key.
Query Parameters
  • 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>
  • 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).
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • 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".
  • 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.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : salesOrdersForOrderHub-lines-payments-item-response
Type: object
Show Source
  • Amount authorized for the payment.
  • Maximum Length: 30
    Value that uniquely identifies the authorization request received from the tokenization service provider to authorize the card number. If you want to import a card authorization other than the Card Token Number, then you must provide either the Card Authorization Request Identifier or the Card Voice Authorization Code. If both are provided, then the Card Authorization Request Identifier takes precedence.
  • Maximum Length: 255
    Authorization status of the payment transaction. Values include Pass or Fail.
  • Maximum Length: 30
    Status of the payment. Values include Pass or Fail.
  • Authorized amount received from the tokenization service provider to authorize the transaction. The authorized amount must be provided if the authorization request identifier is sent in the payload.
  • Read Only: true
    Maximum Length: 1
    Default Value: true
    Contains one of the following values: true or false. If true, then payment authorization occurs in the source application. If false, then payment authorization does not occur in the source application. The default value is true.
  • Date when the application authorized payment.
  • Date when the card is no longer valid. The value is provided in the YYYY/MM/DD format.
  • Maximum Length: 40
    First name of the card holder.
  • Maximum Length: 30
    Value that identifies the card issuer; for example, Visa or MasterCard.
  • Maximum Length: 40
    Last name of the card holder.
  • Maximum Length: 30
    Token number issued by the tokenization service provider corresponding to a card number. This is a required field for card token and authorization import.
  • Read Only: true
    Value that identifies the payment method.
  • Links
  • Maximum Length: 30
    Masked format that displays only the last four digits of a card number, and replaces all other digits with X. This attribute is used for security purposes. The length of the masked card number should match the actual length of the number provided by the card issuer. For example, the masked card number for a Visa card number is XXXXXXXXXXXX2345.
  • Maximum Length: 50
    Value that uniquely identifies the payment details from the source application.
  • Maximum Length: 255
    Name of the billing payment method.
  • Abbreviation that identifies the payment method. The application uses this payment method on the invoice to collect the open balance.
  • Maximum Length: 80
    Number that identifies the card payment that was authorized by Oracle Payments Cloud.
  • Value that uniquely identifies the group of payments for one prepaid sales order. If the payment is a prepayment, then this attribute uses a foreign key to reference billing.
  • Read Only: true
    Value that uniquely identifies the payment.
  • Maximum Length: 255
    Name of the payment method for the transaction.
  • Maximum Length: 30
    Abbreviation that identifies the payment type.
  • Value that identifies the payment transaction extension in the payment system.
  • Read Only: true
    Maximum Length: 30
    Unique payment reference that the application sends to the payment system for authorization.
  • Maximum Length: 100
    Abbreviation that identifies the card authorization. If you want to import a card authorization other than the Card Token Number, then you must provide either the Card Authorization Request Identifier or the Card Voice Authorization Code. If both are provided, then the Card Authorization Request Identifier takes precedence.
Back to Top

Examples

This example describes how to get one payment.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/OrderKey/child/lines/linesUniqID/child/payments/PaymentTransactionId"

For example, the following command gets one payment:

curl -u username:password "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Payment_Line_01/child/lines/00020000000EACED00057708000110F08513E0440000000EACED00057708000110F08513E045/child/payments/300100187578438"

Example Response Body

The following shows an example of the response body in JSON format.

{
	"PaymentTransactionId" : 300100187578438,
	"Amount" : 1,
	"AuthorizationStatusCode" : "ORA_SUCCESS",
	"AuthorizationStatus" : "Success",
	"AuthorizedInSourceFlag" : true,
	"AuthorizedOn" : null,
	"InstrumentAssignmentId" : null,
	"OriginalSystemPaymentReference" : "PaymentRef1",
	"PaymentTypeCode" : "ORA_ON_ACCOUNT",
	"PaymentType" : "On Account",
	"PaymentSetId" : 1,
	"PaymentMethod" : "SSC Manual 200",
	"TransactionExtensionId" : 1,
	"UniquePaymentReference" : null,
	"PaymentMethodCode" : 5765,
	"links" : [ {
		"rel" : "self",
		"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Payment_Line_01/child/lines/00020000000EACED00057708000110F08513E0440000000EACED00057708000110F08513E045/child/payments/300100187578438",
		"name" : "payments",
		"kind" : "item",
		"properties" : {
			"changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
		}
	}, {
		"rel" : "canonical",
		"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Payment_Line_01/child/lines/00020000000EACED00057708000110F08513E0440000000EACED00057708000110F08513E045/child/payments/300100187578438",
		"name" : "payments",
		"kind" : "item"
	}, {
		"rel" : "parent",
		"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Payment_Line_01/child/lines/00020000000EACED00057708000110F08513E0440000000EACED00057708000110F08513E045",
		"name" : "lines",
		"kind" : "item"
	} ]
}
Back to Top