Jump to

• Request
• Response

Get one payment

get

/fscmRestApi/resources/11.13.18.05/salesOrdersForOrderHubRequests/{OrderKey}/child/lines/{linesUniqID}/child/payments/{paymentsUniqID}

Request

Path Parameters

• OrderKey(required): string
  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.
• linesUniqID(required): string
  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.
• paymentsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Payments resource and used to uniquely identify an instance of Payments. The client should not generate the hash key value. Instead, the client should query on the Payments collection resource in order to navigate to a specific instance of Payments to get the hash key.

Query Parameters

• dependency: string
  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>
• expand: string
  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).
• fields: string
  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
• links: string
  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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

Back to Top

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.

Body ()

Root Schema : salesOrdersForOrderHubRequests-lines-payments-item-response

Type: object

Show Source

• AuthorizationRequestId: string
  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.
• 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)
  Date when the card is no longer valid. The value is provided in the YYYY/MM/DD format.
• CardFirstName: string
  Maximum Length: 40

  First name of the card holder.
• CardIssuerCode: string
  Maximum Length: 30

  Value that identifies the card issuer; for example, Visa or MasterCard.
• CardLastName: string
  Maximum Length: 40

  Last name of the card holder.
• CardTokenNumber: string
  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: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaskedCardNumber: string
  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.
• PaymentMethod: string
  Maximum Length: 1000

  Name of the billing payment method.
• PaymentMethodCode: string
  Maximum Length: 1000

  Abbreviation that identifies the payment method. The application uses this payment method on the invoice to collect the open balance.
• PaymentServerOrderNumber: string
  Maximum Length: 80

  Number that identifies the card payment that was authorized by Oracle Payments Cloud.
• PaymentSetId: integer (int64)
  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 (int64)
  Value that uniquely identifies the payment.
• PaymentType: string
  Maximum Length: 80

  Name of the payment method for the transaction.
• PaymentTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the payment type.
• SourceTransactionPaymentId: string
  Maximum Length: 50

  Value that uniquely identifies the payment for the transaction. The source application assigns this value.
• VoiceAuthorizationCode: string
  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.

{
    "type":"object",
    "properties":{
        "PaymentTransactionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the payment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CardTokenNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Token number issued by the tokenization service provider corresponding to a card number. This is a required field for card token and authorization import.",
            "nullable":true,
            "x-queryable":true
        },
        "CardLastName":{
            "maxLength":40,
            "type":"string",
            "description":"Last name of the card holder.",
            "nullable":true,
            "x-queryable":true
        },
        "CardIssuerCode":{
            "maxLength":30,
            "type":"string",
            "description":"Value that identifies the card issuer; for example, Visa or MasterCard.",
            "nullable":true,
            "x-queryable":true
        },
        "MaskedCardNumber":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentSetId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PaymentMethodCode":{
            "maxLength":1000,
            "type":"string",
            "description":"Abbreviation that identifies the payment method. The application uses this payment method on the invoice to collect the open balance.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentServerOrderNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Number that identifies the card payment that was authorized by Oracle Payments Cloud.",
            "nullable":true,
            "x-queryable":true
        },
        "VoiceAuthorizationCode":{
            "maxLength":100,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "AuthorizationRequestId":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceTransactionPaymentId":{
            "maxLength":50,
            "type":"string",
            "description":"Value that uniquely identifies the payment for the transaction. The source application assigns this value.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CardExpirationDate":{
            "type":"string",
            "description":"Date when the card is no longer valid. The value is provided in the YYYY/MM/DD format.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CardFirstName":{
            "maxLength":40,
            "type":"string",
            "description":"First name of the card holder.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the payment type.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentType":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the payment method for the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentMethod":{
            "maxLength":1000,
            "type":"string",
            "description":"Name of the billing payment method.",
            "nullable":true,
            "x-queryable":true
        },
        "AuthorizedAmount":{
            "type":"number",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top