Jump to

• Request
• Response

Create a payment adapter

post

/fscmRestApi/resources/11.13.18.05/publicSectorAdapters

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

Type: object

Show Source

• AdapterId(optional): string
  Maximum Length: 100

  The unique identifier of the payment adapter.
• AdapterMode(optional): string
  Maximum Length: 1

  The mode for the payment adapter. The Test value indicates that the connection to the payment processor is used for testing purposes. The Live value indicates that it is used to process payment transactions in a production environment. The default value is Test.
• AgencyId(optional): integer(int64)
  The unique identifier of the agency receiving incoming customer payments.
• CreatedBy(optional): string
  Maximum Length: 64

  The user who created the payment adapter.
• CreationDate(optional): string(date-time)
  The date on which the payment adapter was created.
• EnabledFlag(optional): boolean
  Indicates whether the payment adapter is active. If the value is Y, the payment adapter is active.
• GatewayName(optional): string
  Maximum Length: 80

  The name of the payment gateway associated with the payment adapter.
• GatewayProductId(optional): string
  Maximum Length: 100

  The unique identifier of the product of the payment processor that is called by the payment gateway.
• LastUpdateDate(optional): string(date-time)
  The date on which the payment adapter was last updated.
• LastUpdatedBy(optional): string
  Maximum Length: 64

  The user who last updated the payment adapter.
• links(optional): array Items
  Title: Items

  Link Relations

{
    "properties":{
        "AdapterId":{
            "maxLength":100,
            "type":"string",
            "description":"The unique identifier of the payment adapter."
        },
        "AdapterMode":{
            "maxLength":1,
            "type":"string",
            "description":"The mode for the payment adapter. The Test value indicates that the connection to the payment processor is used for testing purposes. The Live value indicates that it is used to process payment transactions in a production environment. The default value is Test."
        },
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the agency receiving  incoming customer payments."
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the payment adapter."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date on which the payment adapter was created."
        },
        "EnabledFlag":{
            "type":"boolean",
            "description":"Indicates whether the payment adapter is active. If the value is Y, the payment adapter is active."
        },
        "GatewayName":{
            "maxLength":80,
            "type":"string",
            "description":"The name of the payment gateway associated with the payment adapter."
        },
        "GatewayProductId":{
            "maxLength":100,
            "type":"string",
            "description":"The unique identifier of the product of the payment processor that is called by the payment gateway."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date on which the payment adapter was last updated."
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the payment adapter."
        },
        "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 : publicSectorAdapters-item

Type: object

Show Source

• AdapterId(optional): string
  Maximum Length: 100

  The unique identifier of the payment adapter.
• AdapterMode(optional): string
  Maximum Length: 1

  The mode for the payment adapter. The Test value indicates that the connection to the payment processor is used for testing purposes. The Live value indicates that it is used to process payment transactions in a production environment. The default value is Test.
• AgencyId(optional): integer(int64)
  The unique identifier of the agency receiving incoming customer payments.
• CreatedBy(optional): string
  Maximum Length: 64

  The user who created the payment adapter.
• CreationDate(optional): string(date-time)
  The date on which the payment adapter was created.
• EnabledFlag(optional): boolean
  Indicates whether the payment adapter is active. If the value is Y, the payment adapter is active.
• GatewayName(optional): string
  Maximum Length: 80

  The name of the payment gateway associated with the payment adapter.
• GatewayProductId(optional): string
  Maximum Length: 100

  The unique identifier of the product of the payment processor that is called by the payment gateway.
• LastUpdateDate(optional): string(date-time)
  The date on which the payment adapter was last updated.
• LastUpdatedBy(optional): string
  Maximum Length: 64

  The user who last updated the payment adapter.
• links(optional): array Items
  Title: Items

  Link Relations

{
    "properties":{
        "AdapterId":{
            "maxLength":100,
            "type":"string",
            "description":"The unique identifier of the payment adapter."
        },
        "AdapterMode":{
            "maxLength":1,
            "type":"string",
            "description":"The mode for the payment adapter. The Test value indicates that the connection to the payment processor is used for testing purposes. The Live value indicates that it is used to process payment transactions in a production environment. The default value is Test."
        },
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the agency receiving  incoming customer payments."
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the payment adapter."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date on which the payment adapter was created."
        },
        "EnabledFlag":{
            "type":"boolean",
            "description":"Indicates whether the payment adapter is active. If the value is Y, the payment adapter is active."
        },
        "GatewayName":{
            "maxLength":80,
            "type":"string",
            "description":"The name of the payment gateway associated with the payment adapter."
        },
        "GatewayProductId":{
            "maxLength":100,
            "type":"string",
            "description":"The unique identifier of the product of the payment processor that is called by the payment gateway."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date on which the payment adapter was last updated."
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the payment adapter."
        },
        "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