Jump to

• Request
• Response
• Examples

Update a payment process request

patch

/fscmRestApi/resources/11.13.18.05/paymentProcessRequests/{PaymentProcessRequestId}

Request

Path Parameters

• PaymentProcessRequestId(required): integer
  Application-generated identifier of a payment process request.

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

• Action: string
  Actions that can be taken by the user from the user interface: RESUME or TERMINATE.

{
    "type":"object",
    "properties":{
        "Action":{
            "type":"string",
            "description":"Actions that can be taken by the user from the user interface: RESUME or TERMINATE.",
            "nullable":true
        }
    }
}

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 : paymentProcessRequests-item-response

Type: object

Show Source

• Action: string
  Actions that can be taken by the user from the user interface: RESUME or TERMINATE.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PaymentProcessRequestId: integer
  Read Only: true

  Application-generated identifier of a payment process request.
• PaymentProcessRequestName: string
  Read Only: true

  Maximum Length: 255

  Name of the source product's payment process request.
• PaymentProcessRequestStatusCode: string
  Read Only: true

  Maximum Length: 30

  Status code of the payment process request. Values are taken from the IBY_REQUEST_STATUSES lookup.
• PaymentProcessRequestStatusMeaning: string
  Read Only: true

  Maximum Length: 255

  Status meaning of the payment process request. Values are from the IBY_REQUEST_STATUSES lookup.
• SourceApplicationIdentifier: integer
  Read Only: true

  Identifier of the source product that submitted the payment process request.

{
    "type":"object",
    "properties":{
        "SourceApplicationIdentifier":{
            "type":"integer",
            "description":"Identifier of the source product that submitted the payment process request.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "Action":{
            "type":"string",
            "description":"Actions that can be taken by the user from the user interface: RESUME or TERMINATE.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentProcessRequestStatusMeaning":{
            "maxLength":"255",
            "type":"string",
            "description":"Status meaning of the payment process request. Values are from the IBY_REQUEST_STATUSES lookup.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PaymentProcessRequestStatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Status code of the payment process request. Values are taken from the IBY_REQUEST_STATUSES lookup.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "PaymentProcessRequestName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the source product's payment process request.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "PaymentProcessRequestId":{
            "type":"integer",
            "description":"Application-generated identifier of a payment process request.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        }
    }
}

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

The following example shows how to update a payment process request by submitting a PATCH request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X PATCH -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentProcessRequests/1096

Example Request Payload

The following example shows the contents of the request body in JSON format:

{
"Action": "RESUME"
}

Example Response Body

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

{
    "PaymentProcessRequestId": 1096,
    "SourceApplicationIdentifier": 200,
    "PaymentProcessRequestName": "AP_PPR_3",
    "PaymentProcessRequestStatusCode": "PENDING_REVIEW",
    "PaymentProcessRequestStatusMeaning": "Pending proposed payment review",
    "Action": "RESUME",
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentProcessRequests/1096",
            "name": "paymentProcessRequests",
            "kind": "item"
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentProcessRequests/1096",
            "name": "paymentProcessRequests",
            "kind": "item"
        }
    ]
}

Back to Top