Jump to

• Request
• Response

Create a payment gateway

post

/fscmRestApi/resources/11.13.18.05/publicSectorGateways

Request

Supported Media Types

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

Body ()

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

Root Schema : publicSectorGateways-item

Type: object

Show Source

• 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.
• EnabledFlag(optional): boolean
  Title: Enabled

  Indicates whether the payment gateway is active. If the value is Y, the payment gateway is active. The default value is N.
• GatewayName(optional): string
  Title: Gateway Name

  Maximum Length: 80

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

  Maximum Length: 100

  The description of the product of the payment processor that is called by 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.
• GatewayProductVersion(optional): string
  Title: Gateway Product Version

  Maximum Length: 10

  The version number 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.
• URLLive(optional): string
  Title: Production Link

  Maximum Length: 300

  The URL that takes the user to the production environment of the payment processor product that is called by the payment gateway.
• URLTest(optional): string
  Title: Test Link

  Maximum Length: 300

  The URL that takes the user to the test environment of the payment processor product that is called by the payment gateway.

{
    "properties":{
        "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."
        },
        "EnabledFlag":{
            "type":"boolean",
            "description":"Indicates whether the payment gateway is active. If the value is Y, the payment gateway is active. The default value is N.",
            "title":"Enabled"
        },
        "GatewayName":{
            "maxLength":80,
            "type":"string",
            "description":"The name of the payment gateway.",
            "title":"Gateway Name"
        },
        "GatewayProductDescr":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the product of the payment processor that is called by the payment gateway.",
            "title":"Gateway Product Description"
        },
        "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"
        },
        "GatewayProductVersion":{
            "maxLength":10,
            "type":"string",
            "description":"The version number of the product of the payment processor that is called by the payment gateway.",
            "title":"Gateway Product Version"
        },
        "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."
        },
        "URLLive":{
            "maxLength":300,
            "type":"string",
            "description":"The URL that takes the user to the production environment of the payment processor product that is called by the payment gateway.",
            "title":"Production Link"
        },
        "URLTest":{
            "maxLength":300,
            "type":"string",
            "description":"The URL that takes the user to the test environment of the payment processor product that is called by the payment gateway.",
            "title":"Test Link"
        },
        "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 : publicSectorGateways-item

Type: object

Show Source

• 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.
• EnabledFlag(optional): boolean
  Title: Enabled

  Indicates whether the payment gateway is active. If the value is Y, the payment gateway is active. The default value is N.
• GatewayName(optional): string
  Title: Gateway Name

  Maximum Length: 80

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

  Maximum Length: 100

  The description of the product of the payment processor that is called by 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.
• GatewayProductVersion(optional): string
  Title: Gateway Product Version

  Maximum Length: 10

  The version number 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.
• URLLive(optional): string
  Title: Production Link

  Maximum Length: 300

  The URL that takes the user to the production environment of the payment processor product that is called by the payment gateway.
• URLTest(optional): string
  Title: Test Link

  Maximum Length: 300

  The URL that takes the user to the test environment of the payment processor product that is called by the payment gateway.

{
    "properties":{
        "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."
        },
        "EnabledFlag":{
            "type":"boolean",
            "description":"Indicates whether the payment gateway is active. If the value is Y, the payment gateway is active. The default value is N.",
            "title":"Enabled"
        },
        "GatewayName":{
            "maxLength":80,
            "type":"string",
            "description":"The name of the payment gateway.",
            "title":"Gateway Name"
        },
        "GatewayProductDescr":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the product of the payment processor that is called by the payment gateway.",
            "title":"Gateway Product Description"
        },
        "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"
        },
        "GatewayProductVersion":{
            "maxLength":10,
            "type":"string",
            "description":"The version number of the product of the payment processor that is called by the payment gateway.",
            "title":"Gateway Product Version"
        },
        "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."
        },
        "URLLive":{
            "maxLength":300,
            "type":"string",
            "description":"The URL that takes the user to the production environment of the payment processor product that is called by the payment gateway.",
            "title":"Production Link"
        },
        "URLTest":{
            "maxLength":300,
            "type":"string",
            "description":"The URL that takes the user to the test environment of the payment processor product that is called by the payment gateway.",
            "title":"Test Link"
        },
        "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