Jump to

• Request
• Response
• Examples

Update one payment

patch

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

Request

Path Parameters

• OrderKey(required): string
  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.
• PaymentTransactionId(required): integer(int64)
  Value that uniquely identifies the payment.
• 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.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Amount: number
  Amount authorized for the payment.
• 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.
• AuthorizationStatus: string
  Maximum Length: 255

  Authorization status of the payment transaction. Values include Pass or Fail.
• AuthorizationStatusCode: string
  Maximum Length: 30

  Status of the payment. Values include Pass or Fail.
• 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.
• AuthorizedOn: string (date-time)
  Date when the application authorized payment.
• CardExpirationDate: string
  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.
• 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: 255

  Name of the billing payment method.
• PaymentMethodCode: integer (int64)
  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.
• PaymentType: string
  Maximum Length: 255

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

  Abbreviation that identifies the payment type.
• TransactionExtensionId: integer (int64)
  Value that identifies the payment transaction extension in the payment system.
• 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":{
        "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":false
        },
        "CardLastName":{
            "maxLength":"40",
            "type":"string",
            "description":"Last name of the card holder.",
            "nullable":true,
            "x-queryable":false
        },
        "CardIssuerCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that identifies the card issuer; for example, Visa or MasterCard.",
            "nullable":true,
            "x-queryable":false
        },
        "Amount":{
            "type":"number",
            "description":"Amount authorized for the payment.",
            "nullable":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":false
        },
        "AuthorizedOn":{
            "type":"string",
            "description":"Date when the application authorized payment.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "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"
            }
        },
        "PaymentMethodCode":{
            "type":"integer",
            "description":"Abbreviation that identifies the payment method. The application uses this payment method on the invoice to collect the open balance.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"255"
            }
        },
        "PaymentServerOrderNumber":{
            "maxLength":"80",
            "type":"string",
            "description":"Number that identifies the card payment that was authorized by Oracle Payments Cloud.",
            "nullable":true,
            "x-queryable":false
        },
        "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":false
        },
        "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":false
        },
        "AuthorizationStatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Status of the payment. Values include Pass or Fail.",
            "nullable":true
        },
        "AuthorizationStatus":{
            "maxLength":"255",
            "type":"string",
            "description":"Authorization status of the payment transaction. Values include Pass or Fail.",
            "nullable":true
        },
        "TransactionExtensionId":{
            "type":"integer",
            "description":"Value that identifies the payment transaction extension in the payment system.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "CardExpirationDate":{
            "type":"string",
            "description":"Date when the card is no longer valid. The value is provided in the YYYY/MM/DD format.",
            "nullable":true,
            "x-queryable":false
        },
        "CardFirstName":{
            "maxLength":"40",
            "type":"string",
            "description":"First name of the card holder.",
            "nullable":true,
            "x-queryable":false
        },
        "PaymentTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the payment type.",
            "nullable":true
        },
        "PaymentType":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the payment method for the transaction.",
            "nullable":true
        },
        "PaymentMethod":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the billing payment method.",
            "nullable":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":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

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

Type: object

Show Source

• Amount: number
  Amount authorized for the payment.
• 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.
• AuthorizationStatus: string
  Maximum Length: 255

  Authorization status of the payment transaction. Values include Pass or Fail.
• AuthorizationStatusCode: string
  Maximum Length: 30

  Status of the payment. Values include Pass or Fail.
• 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.
• AuthorizedInSourceFlag: boolean
  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.
• AuthorizedOn: string (date-time)
  Date when the application authorized payment.
• CardExpirationDate: string
  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.
• InstrumentAssignmentId: integer (int64)
  Read Only: true

  Value that identifies the payment method.
• 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.
• OriginalSystemPaymentReference: string
  Maximum Length: 50

  Value that uniquely identifies the payment details from the source application.
• PaymentMethod: string
  Maximum Length: 255

  Name of the billing payment method.
• PaymentMethodCode: integer (int64)
  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)
  Read Only: true

  Value that uniquely identifies the payment.
• PaymentType: string
  Maximum Length: 255

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

  Abbreviation that identifies the payment type.
• TransactionExtensionId: integer (int64)
  Value that identifies the payment transaction extension in the payment system.
• UniquePaymentReference: string
  Read Only: true

  Maximum Length: 30

  Unique payment reference that the application sends to the payment system for authorization.
• 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":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "InstrumentAssignmentId":{
            "type":"integer",
            "description":"Value that identifies the payment method.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AuthorizedOn":{
            "type":"string",
            "description":"Date when the application authorized payment.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "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":false
        },
        "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":false
        },
        "OriginalSystemPaymentReference":{
            "maxLength":"50",
            "type":"string",
            "description":"Value that uniquely identifies the payment details from the source application.",
            "nullable":true,
            "x-queryable":true
        },
        "AuthorizationStatus":{
            "maxLength":"255",
            "type":"string",
            "description":"Authorization status of the payment transaction. Values include Pass or Fail.",
            "nullable":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.",
            "nullable":true,
            "x-queryable":false
        },
        "PaymentType":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the payment method for the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AuthorizedInSourceFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "default":true,
            "x-queryable":false
        },
        "UniquePaymentReference":{
            "maxLength":"30",
            "type":"string",
            "description":"Unique payment reference that the application sends to the payment system for authorization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "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":false
        },
        "CardLastName":{
            "maxLength":"40",
            "type":"string",
            "description":"Last name of the card holder.",
            "nullable":true,
            "x-queryable":false
        },
        "CardIssuerCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that identifies the card issuer; for example, Visa or MasterCard.",
            "nullable":true,
            "x-queryable":false
        },
        "Amount":{
            "type":"number",
            "description":"Amount authorized for the payment.",
            "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":false
        },
        "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":{
            "type":"integer",
            "description":"Abbreviation that identifies the payment method. The application uses this payment method on the invoice to collect the open balance.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"255"
            }
        },
        "PaymentServerOrderNumber":{
            "maxLength":"80",
            "type":"string",
            "description":"Number that identifies the card payment that was authorized by Oracle Payments Cloud.",
            "nullable":true,
            "x-queryable":false
        },
        "AuthorizationStatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Status of the payment. Values include Pass or Fail.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionExtensionId":{
            "type":"integer",
            "description":"Value that identifies the payment transaction extension in the payment system.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CardFirstName":{
            "maxLength":"40",
            "type":"string",
            "description":"First name of the card holder.",
            "nullable":true,
            "x-queryable":false
        },
        "PaymentTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the payment type.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentMethod":{
            "maxLength":"255",
            "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":false
        }
    }
}

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

Examples

This example describes how to update one payment.

Example cURL Command

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

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/OrderKey/child/lines/linesUniqID/child/payments/PaymentTransactionId"

For example, use the following command:

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Payment_Line_01/child/lines/00020000000EACED00057708000110F08513E0440000000EACED00057708000110F08513E045/child/payments/300100187578438"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.

You can achieve the same result with Create sales orders using the upsert-mode header parameter. Refer to the examples in the Create sales orders section to see how to update child resource in the existing order.

{ 
	"Amount" : 50
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{}

Back to Top