Update one payment

patch

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

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.
  • 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.
  • 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.
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
  • 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.
  • 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: 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 : salesOrdersForOrderHubRequests-lines-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