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

Get all payments

get

/fscmRestApi/resources/11.13.18.05/salesOrdersForOrderHubRequests/{OrderKey}/child/payments

Request

Path Parameters
  • Value that uniquely identifies the sales order. This value is derived by concatenating the value of SourceOrderSystem, a colon, and the value of SourceOrderId. For orders created through the Oracle Order Management Cloud work area, the SourceOrderId is same as the HeaderId. For example, if SourceOrderSystem is LEG and SourceOrderId is R13_Sample_Order, the value of this attribute is LEG:R13_Sample_Order.
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
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Find payment details according to the original application payment reference.
      Finder Variables:
      • SourceTransactionPaymentId; string; Value that uniquely identifies the payment details from the source application.
    • findBySourceTransactionPaymentId: Find payment details according to the original application payment reference.
      Finder Variables:
      • SourceTransactionPaymentId; string; Value that uniquely identifies the payment details from the source application.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • AuthorizationRequestId; string; 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.
    • AuthorizedAmount; number; 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.
    • CardExpirationDate; string; Date when the card is no longer valid. The value is provided in the YYYY/MM/DD format.
    • CardFirstName; string; First name of the card holder.
    • CardIssuerCode; string; Value that identifies the card issuer; for example, Visa or MasterCard.
    • CardLastName; string; Last name of the card holder.
    • CardTokenNumber; string; Token number issued by the tokenization service provider corresponding to a card number. This is a required field for card token and authorization import.
    • MaskedCardNumber; string; 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.
    • PaymentMethod; string; Name of the billing payment method.
    • PaymentMethodCode; string; Abbreviation that identifies the payment method. The application uses this payment method on the invoice to collect the open balance.
    • PaymentServerOrderNumber; string; Number that identifies the card payment that was authorized by Oracle Payments Cloud.
    • PaymentSetId; integer; 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.
    • PaymentTransactionId; integer; Value that uniquely identifies the payment.
    • PaymentType; string; Name of the payment method for the transaction.
    • PaymentTypeCode; string; Abbreviation that identifies the payment type.
    • SourceTransactionPaymentId; string; Value that uniquely identifies the payment for the transaction. The source application assigns this value.
    • VoiceAuthorizationCode; string; 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.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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 : salesOrdersForOrderHubRequests-payments
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : salesOrdersForOrderHubRequests-payments-item-response
Type: object
Show Source
  • 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.
  • 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.
  • 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.
  • 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: 1000
    Name of the billing payment method.
  • Maximum Length: 1000
    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.
  • Value that uniquely identifies the payment.
  • Maximum Length: 80
    Name of the payment method for the transaction.
  • Maximum Length: 30
    Abbreviation that identifies the payment type.
  • Maximum Length: 50
    Value that uniquely identifies the payment for the transaction. The source application assigns this value.
  • 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 all payments.

Example cURL Command

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

curl -i -X GET \
-H "Authorization:Basic c2Ntb3BlcmF0aW9uczpXZWxjb21lMQ==" \
-H "REST-Framework-Version:4" \
-H "prefer:return=representation" \
-H "Content-Type:application/json" \
'https://servername/fscmRestApi/resources/version/salesOrdersForOrderHubRequests/GPR%3AR13_Rest_stage_01/child/payments'

Example Response Body

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

{
	"items" : [ {
		"PaymentMethod" : null,
		"PaymentMethodCode" : null,
		"PaymentSetId" : null,
		"PaymentTransactionId" : null,
		"PaymentType" : null,
		"PaymentTypeCode" : "ORA_CREDIT_CARD",
		"SourceTransactionPaymentId" : "SK-BATCH-1006-D3-header-PI",
		"links" : [ {
			"rel" : "self",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHubRequests/GPR%3AR13_Rest_stage_01/child/payments/00060000000EACED00057708000001764CC49C2A000000115231335F526573745F73746167655F30310000000F5F666F6D4E756C6C56616C756549640000001A534B2D42415443482D313030362D44332D6865616465722D50490000000F5F666F6D4E756C6C56616C7565496400000003475052",
			"name" : "payments",
			"kind" : "item",
			"properties" : {
				"changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
			}
		}, {
			"rel" : "canonical",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHubRequests/GPR%3AR13_Rest_stage_01/child/payments/00060000000EACED00057708000001764CC49C2A000000115231335F526573745F73746167655F30310000000F5F666F6D4E756C6C56616C756549640000001A534B2D42415443482D313030362D44332D6865616465722D50490000000F5F666F6D4E756C6C56616C7565496400000003475052",
			"name" : "payments",
			"kind" : "item"
		}, {
			"rel" : "parent",
			"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHubRequests/GPR%3AR13_Rest_stage_01",
			"name" : "salesOrdersForOrderHubRequests",
			"kind" : "item"
		} ]
	} ],
	"count" : 1,
	"hasMore" : false,
	"limit" : 25,
	"offset" : 0,
	"links" : [ {
		"rel" : "self",
		"href" : "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHubRequests/GPR%3AR13_Rest_stage_01/child/payments",
		"name" : "payments",
		"kind" : "collection"
	} ]
}
Back to Top