Jump to

• Request
• Response

Update a payment adapter payment method

patch

/fscmRestApi/resources/11.13.18.05/publicSectorAdapterMethods/{publicSectorAdapterMethodsUniqID}

Request

Supported Media Types

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

Path Parameters

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

Body ()

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

Root Schema : publicSectorAdapterMethods-item

Type: object

Show Source

• AdapterId(optional): string
  Maximum Length: 100

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

  Indicates whether a payment adapter payment method is active. If the value is Y, the payment adapter payment method is active.
• links(optional): array Items
  Title: Items

  Link Relations
• PaymentMethodCode(optional): string
  Maximum Length: 30

  The payment method code.
• ServiceChargeAmount(optional): number
  The amount that is charged by the payment processor as a payment service charge.
• ServiceChargeCurrency(optional): string
  Maximum Length: 3

  The currency code related to any payment service charge amounts.
• ServiceChargeDescr(optional): string
  Maximum Length: 150

  The description of the service charge that is applied to payment transactions by the payment processor.
• ServiceChargePercent(optional): number
  The percentage of the payment amount that is charged by the payment processor as a payment service charge.
• SpecialInstructions(optional): string
  Maximum Length: 1000

  List of special instructions for the user related to the payment.

{
    "properties":{
        "AdapterId":{
            "maxLength":100,
            "type":"string",
            "description":"The unique identifier for the payment adapter."
        },
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the agency receiving incoming customer payments."
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether a payment adapter payment method is active. If the value is Y, the payment adapter payment method is active."
        },
        "PaymentMethodCode":{
            "maxLength":30,
            "type":"string",
            "description":"The payment method code."
        },
        "ServiceChargeAmount":{
            "type":"number",
            "description":"The amount that is charged by the payment processor as a payment service charge."
        },
        "ServiceChargeCurrency":{
            "maxLength":3,
            "type":"string",
            "description":"The currency code related to any payment service charge amounts."
        },
        "ServiceChargeDescr":{
            "maxLength":150,
            "type":"string",
            "description":"The description of the service charge that is applied to payment transactions by the payment processor."
        },
        "ServiceChargePercent":{
            "type":"number",
            "description":"The percentage of the payment amount that is charged by the payment processor as a payment service charge."
        },
        "SpecialInstructions":{
            "maxLength":1000,
            "type":"string",
            "description":"List of special instructions for the user related to the payment."
        },
        "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 : publicSectorAdapterMethods-item

Type: object

Show Source

• AdapterId(optional): string
  Maximum Length: 100

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

  Indicates whether a payment adapter payment method is active. If the value is Y, the payment adapter payment method is active.
• links(optional): array Items
  Title: Items

  Link Relations
• PaymentMethodCode(optional): string
  Maximum Length: 30

  The payment method code.
• ServiceChargeAmount(optional): number
  The amount that is charged by the payment processor as a payment service charge.
• ServiceChargeCurrency(optional): string
  Maximum Length: 3

  The currency code related to any payment service charge amounts.
• ServiceChargeDescr(optional): string
  Maximum Length: 150

  The description of the service charge that is applied to payment transactions by the payment processor.
• ServiceChargePercent(optional): number
  The percentage of the payment amount that is charged by the payment processor as a payment service charge.
• SpecialInstructions(optional): string
  Maximum Length: 1000

  List of special instructions for the user related to the payment.

{
    "properties":{
        "AdapterId":{
            "maxLength":100,
            "type":"string",
            "description":"The unique identifier for the payment adapter."
        },
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the agency receiving incoming customer payments."
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether a payment adapter payment method is active. If the value is Y, the payment adapter payment method is active."
        },
        "PaymentMethodCode":{
            "maxLength":30,
            "type":"string",
            "description":"The payment method code."
        },
        "ServiceChargeAmount":{
            "type":"number",
            "description":"The amount that is charged by the payment processor as a payment service charge."
        },
        "ServiceChargeCurrency":{
            "maxLength":3,
            "type":"string",
            "description":"The currency code related to any payment service charge amounts."
        },
        "ServiceChargeDescr":{
            "maxLength":150,
            "type":"string",
            "description":"The description of the service charge that is applied to payment transactions by the payment processor."
        },
        "ServiceChargePercent":{
            "type":"number",
            "description":"The percentage of the payment amount that is charged by the payment processor as a payment service charge."
        },
        "SpecialInstructions":{
            "maxLength":1000,
            "type":"string",
            "description":"List of special instructions for the user related to the payment."
        },
        "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