Jump to

• Request
• Response

Create a payment gateway

post

/fscmRestApi/resources/11.13.18.05/publicSectorGateways

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• DeletedFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether seed data has been deleted. If the value is Y, the seed data has been deleted. The default value is N.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

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

  Maximum Length: 80

  The name of the payment gateway.
• GatewayProductDescr: 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: 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: 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.
• SeedDataLock: integer (int32)
  Default Value: 0

  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: 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: 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.

{
    "type":"object",
    "properties":{
        "URLTest":{
            "title":"Test Link",
            "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.",
            "nullable":true
        },
        "GatewayProductDescr":{
            "title":"Gateway Product Description",
            "maxLength":"100",
            "type":"string",
            "description":"The description of the product of the payment processor that is called by the payment gateway.",
            "nullable":false
        },
        "SeedDataLock":{
            "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.",
            "format":"int32",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"1"
            }
        },
        "DeletedFlag":{
            "maxLength":"1",
            "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.",
            "nullable":false,
            "default":false
        },
        "URLLive":{
            "title":"Production Link",
            "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.",
            "nullable":true
        },
        "GatewayName":{
            "title":"Gateway Name",
            "maxLength":"80",
            "type":"string",
            "description":"The name of the payment gateway.",
            "nullable":false
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "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.",
            "nullable":false
        },
        "GatewayProductId":{
            "title":"Gateway Product ID",
            "maxLength":"100",
            "type":"string",
            "description":"The unique identifier of the product of the payment processor that is called by the payment gateway.",
            "nullable":false
        },
        "GatewayProductVersion":{
            "title":"Gateway Product Version",
            "maxLength":"10",
            "type":"string",
            "description":"The version number of the product of the payment processor that is called by the payment gateway.",
            "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 : publicSectorGateways-item-response

Type: object

Show Source

• DeletedFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether seed data has been deleted. If the value is Y, the seed data has been deleted. The default value is N.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

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

  Maximum Length: 80

  The name of the payment gateway.
• GatewayProductDescr: 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: 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: 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: array Links
  Title: Links

  The link relations associated with the resource instance.
• SeedDataLock: integer (int32)
  Default Value: 0

  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: 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: 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.

{
    "type":"object",
    "properties":{
        "URLTest":{
            "title":"Test Link",
            "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.",
            "nullable":true,
            "x-queryable":true
        },
        "GatewayProductDescr":{
            "title":"Gateway Product Description",
            "maxLength":"100",
            "type":"string",
            "description":"The description of the product of the payment processor that is called by the payment gateway.",
            "nullable":false,
            "x-queryable":true
        },
        "SeedDataLock":{
            "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.",
            "format":"int32",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "DeletedFlag":{
            "maxLength":"1",
            "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.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "URLLive":{
            "title":"Production Link",
            "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.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "GatewayName":{
            "title":"Gateway Name",
            "maxLength":"80",
            "type":"string",
            "description":"The name of the payment gateway.",
            "nullable":false,
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "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.",
            "nullable":false,
            "x-queryable":true
        },
        "GatewayProductId":{
            "title":"Gateway Product ID",
            "maxLength":"100",
            "type":"string",
            "description":"The unique identifier of the product of the payment processor that is called by the payment gateway.",
            "nullable":false,
            "x-queryable":true
        },
        "GatewayProductVersion":{
            "title":"Gateway Product Version",
            "maxLength":"10",
            "type":"string",
            "description":"The version number of the product of the payment processor that is called by the payment gateway.",
            "nullable":true,
            "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