Update one payment

patch

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

Request

Path Parameters
  • The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
  • The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
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.
  • Date when the application authorized payment.
  • Date when the card is no longer valid.
  • 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.
  • Maximum Length: 50
    Number that identifies the check used for payment.
  • 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.
  • Date to use as the receipt when paying before the item is fulfilled.
  • 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: 255
    Specifies whether to pay before fulfilling the item or upon receiving the invoice.
  • Maximum Length: 30
    Code of the payment mode, which specifies whether to pay before fulfilling the item or from the invoice.
  • 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.
  • Maximum Length: 255
    Name of the payment method for the transaction.
  • Maximum Length: 30
    Abbreviation that identifies the payment type.
  • Amount for the payment made before fulfilling the item.
  • Value that identifies the payment transaction extension in the payment system.
  • 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

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-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 doesn't occur in the source application. The default value is true.
  • Date when the application authorized payment.
  • Date when the card is no longer valid.
  • 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 uniquely identifies the cash receipt for payments made before fulfilling the item.
  • Maximum Length: 50
    Number that identifies the check used for payment.
  • 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.
  • Date to use as the receipt when paying before the item is fulfilled.
  • 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: 255
    Specifies whether to pay before fulfilling the item or upon receiving the invoice.
  • Maximum Length: 30
    Code of the payment mode, which specifies whether to pay before fulfilling the item or from the invoice.
  • 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.
  • Amount for the payment made before fulfilling the item.
  • 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 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/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_Hdr_01/child/payments/300100187576799"

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" : 100
}

Example Response Body

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

{
}
Back to Top