Jump to

• Request
• Response

Create a payment adapter configuration

post

/fscmRestApi/resources/11.13.18.05/publicSectorAdapterConfigs

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 : publicSectorAdapterConfigs-item

Type: object

Show Source

• AdapterId(optional): string
  Maximum Length: 100

  The unique identifier of the payment adapter.
• AgencyId(optional): integer(int64)
  The unique identifier of the agency receiving incoming customer payments.
• ConfigurationId(optional): string
  Maximum Length: 15

  The unique identifier of the payment adapter configuration.
• ConfigurationName(optional): string
  Maximum Length: 100

  The name of the payment adapter configuration.
• ConfigurationValue(optional): string
  Maximum Length: 300

  The individual payment processing option within the payment adapter configuration.
• links(optional): array Items
  Title: Items

  Link Relations

{
    "properties":{
        "AdapterId":{
            "maxLength":100,
            "type":"string",
            "description":"The unique identifier of the payment adapter."
        },
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the agency receiving incoming customer payments."
        },
        "ConfigurationId":{
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier of the payment adapter configuration."
        },
        "ConfigurationName":{
            "maxLength":100,
            "type":"string",
            "description":"The name of the payment adapter configuration."
        },
        "ConfigurationValue":{
            "maxLength":300,
            "type":"string",
            "description":"The individual payment processing option within the payment adapter configuration."
        },
        "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 : publicSectorAdapterConfigs-item

Type: object

Show Source

• AdapterId(optional): string
  Maximum Length: 100

  The unique identifier of the payment adapter.
• AgencyId(optional): integer(int64)
  The unique identifier of the agency receiving incoming customer payments.
• ConfigurationId(optional): string
  Maximum Length: 15

  The unique identifier of the payment adapter configuration.
• ConfigurationName(optional): string
  Maximum Length: 100

  The name of the payment adapter configuration.
• ConfigurationValue(optional): string
  Maximum Length: 300

  The individual payment processing option within the payment adapter configuration.
• links(optional): array Items
  Title: Items

  Link Relations

{
    "properties":{
        "AdapterId":{
            "maxLength":100,
            "type":"string",
            "description":"The unique identifier of the payment adapter."
        },
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the agency receiving incoming customer payments."
        },
        "ConfigurationId":{
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier of the payment adapter configuration."
        },
        "ConfigurationName":{
            "maxLength":100,
            "type":"string",
            "description":"The name of the payment adapter configuration."
        },
        "ConfigurationValue":{
            "maxLength":300,
            "type":"string",
            "description":"The individual payment processing option within the payment adapter configuration."
        },
        "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