Jump to

• Request
• Response

Update a payment adapter

patch

/fscmRestApi/resources/11.13.18.05/publicSectorAdapters/{publicSectorAdaptersUniqID}

Request

Path Parameters

• publicSectorAdaptersUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- AdapterId and AgencyId ---for the Adapters resource and used to uniquely identify an instance of Adapters. The client should not generate the hash key value. Instead, the client should query on the Adapters collection resource with a filter on the primary key values in order to navigate to a specific instance of Adapters.
  
  For example: publicSectorAdapters?q=AdapterId=<value1>;AgencyId=<value2>

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AdapterMode: string
  Title: Adapter Mode

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

  Maximum Length: 1

  Indicates whether the payment adapter is active. If the value is Y, the payment adapter is active.
• GatewayName: string
  Title: Payment Gateway

  Maximum Length: 80

  The name of the payment gateway associated with the payment adapter.
• 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.

{
    "type":"object",
    "properties":{
        "AdapterMode":{
            "title":"Adapter Mode",
            "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.",
            "nullable":false
        },
        "GatewayName":{
            "title":"Payment Gateway",
            "maxLength":"80",
            "type":"string",
            "description":"The name of the payment gateway associated with the payment adapter.",
            "nullable":false
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the payment adapter is active. If the value is Y, the payment adapter is active.",
            "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
        }
    }
}

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

Type: object

Show Source

• AdapterId: string
  Title: Payment Adapter ID

  Maximum Length: 100

  The unique identifier of the payment adapter.
• AdapterMode: string
  Title: Adapter Mode

  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: integer (int32)
  Title: Agency ID

  Default Value: 1

  The unique identifier of the agency receiving incoming customer payments.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the payment adapter.
• CreationDate: string (date-time)
  Read Only: true

  The date on which the payment adapter was created.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Indicates whether the payment adapter is active. If the value is Y, the payment adapter is active.
• GatewayName: string
  Title: Payment Gateway

  Maximum Length: 80

  The name of the payment gateway associated with the payment adapter.
• 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.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date on which the payment adapter was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the payment adapter.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the payment adapter.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date on which the payment adapter was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the payment adapter.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of the agency receiving  incoming customer payments.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "AdapterMode":{
            "title":"Adapter Mode",
            "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.",
            "nullable":false,
            "x-queryable":true
        },
        "AdapterId":{
            "title":"Payment Adapter ID",
            "maxLength":"100",
            "type":"string",
            "description":"The unique identifier of the payment adapter.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "GatewayName":{
            "title":"Payment Gateway",
            "maxLength":"80",
            "type":"string",
            "description":"The name of the payment gateway associated with the payment adapter.",
            "nullable":false,
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the payment adapter is active. If the value is Y, the payment adapter is active.",
            "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
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date on which the payment adapter was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":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