Jump to

• Request
• Response

Update a payment gateway configuration

patch

/fscmRestApi/resources/11.13.18.05/publicSectorGatewayConfigs/{publicSectorGatewayConfigsUniqID}

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Path Parameters

• publicSectorGatewayConfigsUniqID: integer
  This is the hash key of the attributes which make up the composite key--- GatewayName, GatewayProductId and ConfigurationId ---for the Gateway Configs resource and used to uniquely identify an instance of Gateway Configs. The client should not generate the hash key value. Instead, the client should query on the Gateway Configs collection resource with a filter on the primary key values in order to navigate to a specific instance of Gateway Configs.
  
  For example: publicSectorGatewayConfigs?q=GatewayName=<value1>;GatewayProductId=<value2>;ConfigurationId=<value3>

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorGatewayConfigs-item

Type: object

Show Source

• ConfigurationDescr(optional): string
  Title: Configuration Description

  Maximum Length: 300

  The description of the payment gateway configuration.
• ConfigurationId(optional): string
  Title: Configuration ID

  Maximum Length: 15

  The unique identifier of the payment gateway configuration.
• ConfigurationName(optional): string
  Title: Configuration Name

  Maximum Length: 100

  The name of the payment gateway configuration.
• DeletedFlag(optional): boolean
  Indicates whether seed data has been deleted. If the value is Y, the seed data has been deleted. The default value is N.
• GatewayName(optional): string
  Title: Gateway Name

  Maximum Length: 80

  The name of the payment gateway.
• GatewayProductId(optional): string
  Title: Gateway Product ID

  Maximum Length: 100

  The unique identifier of the product of the payment processor that is called by the payment gateway.
• links(optional): array Items
  Title: Items

  Link Relations
• SeedDataLock(optional): integer(int32)
  Indicates whether seed data is locked. A value of 0 means it is customer data. A value of 1 means the seed data is locked and cannot be updated. A value of 2 means the seed data can be updated.

{
    "properties":{
        "ConfigurationDescr":{
            "maxLength":300,
            "type":"string",
            "description":"The description of the payment gateway configuration.",
            "title":"Configuration Description"
        },
        "ConfigurationId":{
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier of the payment gateway configuration.",
            "title":"Configuration ID"
        },
        "ConfigurationName":{
            "maxLength":100,
            "type":"string",
            "description":"The name of the payment gateway configuration.",
            "title":"Configuration Name"
        },
        "DeletedFlag":{
            "type":"boolean",
            "description":"Indicates whether seed data has been deleted. If the value is Y, the seed data has been deleted. The default value is N."
        },
        "GatewayName":{
            "maxLength":80,
            "type":"string",
            "description":"The name of the payment gateway.",
            "title":"Gateway Name"
        },
        "GatewayProductId":{
            "maxLength":100,
            "type":"string",
            "description":"The unique identifier of the product of the payment processor that is called by the payment gateway.",
            "title":"Gateway Product ID"
        },
        "SeedDataLock":{
            "format":"int32",
            "type":"integer",
            "description":"Indicates whether seed data is locked. A value of 0 means it is customer data. A value of 1 means the seed data is locked and cannot be updated. A value of 2 means the seed data can be updated."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorGatewayConfigs-item

Type: object

Show Source

• ConfigurationDescr(optional): string
  Title: Configuration Description

  Maximum Length: 300

  The description of the payment gateway configuration.
• ConfigurationId(optional): string
  Title: Configuration ID

  Maximum Length: 15

  The unique identifier of the payment gateway configuration.
• ConfigurationName(optional): string
  Title: Configuration Name

  Maximum Length: 100

  The name of the payment gateway configuration.
• DeletedFlag(optional): boolean
  Indicates whether seed data has been deleted. If the value is Y, the seed data has been deleted. The default value is N.
• GatewayName(optional): string
  Title: Gateway Name

  Maximum Length: 80

  The name of the payment gateway.
• GatewayProductId(optional): string
  Title: Gateway Product ID

  Maximum Length: 100

  The unique identifier of the product of the payment processor that is called by the payment gateway.
• links(optional): array Items
  Title: Items

  Link Relations
• SeedDataLock(optional): integer(int32)
  Indicates whether seed data is locked. A value of 0 means it is customer data. A value of 1 means the seed data is locked and cannot be updated. A value of 2 means the seed data can be updated.

{
    "properties":{
        "ConfigurationDescr":{
            "maxLength":300,
            "type":"string",
            "description":"The description of the payment gateway configuration.",
            "title":"Configuration Description"
        },
        "ConfigurationId":{
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier of the payment gateway configuration.",
            "title":"Configuration ID"
        },
        "ConfigurationName":{
            "maxLength":100,
            "type":"string",
            "description":"The name of the payment gateway configuration.",
            "title":"Configuration Name"
        },
        "DeletedFlag":{
            "type":"boolean",
            "description":"Indicates whether seed data has been deleted. If the value is Y, the seed data has been deleted. The default value is N."
        },
        "GatewayName":{
            "maxLength":80,
            "type":"string",
            "description":"The name of the payment gateway.",
            "title":"Gateway Name"
        },
        "GatewayProductId":{
            "maxLength":100,
            "type":"string",
            "description":"The unique identifier of the product of the payment processor that is called by the payment gateway.",
            "title":"Gateway Product ID"
        },
        "SeedDataLock":{
            "format":"int32",
            "type":"integer",
            "description":"Indicates whether seed data is locked. A value of 0 means it is customer data. A value of 1 means the seed data is locked and cannot be updated. A value of 2 means the seed data can be updated."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top