Jump to

• Request
• Response

Create a third party payment options

post

/fscmRestApi/resources/11.13.18.05/publicSectorThirdPartyPaymentOptions

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

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  Unique identifier of the agency.
• CEFeeLimit: integer (int32)
  Default Value: 200

  Indicates the transaction limit on data source associated with code enforcement transactions.
• CETimer: integer (int32)
  Default Value: 6

  Indicates the timer associated with search request for code enforcement transactions.
• LNPTransactionLimit: integer (int32)
  Default Value: 200

  Indicates the transaction limit on data source associated with permits, planning and zoning applications and business license transactions.
• PaymentReferencePrefix: string
  Title: Payment Reference Prefix

  Maximum Length: 4

  Default Value: TPTY

  Prefix used for the payment reference value.
• PunchoutUser: string
  Title: Punch-out User

  Maximum Length: 30

  Default Value: ORA_PUBLIC_USER

  Indicates user types who will be punched out to third party payment service provider page.
• ReinstateFeeFlag: string
  Title: Reinstate Fee Mark

  Maximum Length: 1

  Default Value: N

  Specifies whether a fee should be reinstated for return of payment by the financial institution.
• ReturnFeeAmount: number
  Title: Return Check Fee Amount

  Specifies the amount of the fee charged for return of payment by the financial institution.
• ReturnFeeCurrency: string
  Title: Return Check Fee Currency

  Maximum Length: 3

  Specifies the currency of the fee charged for return of payment by the financial institution.
• ReturnFeeFlag: string
  Title: Charge Return Fee Mark

  Maximum Length: 1

  Default Value: N

  Specifies whether a return fee should be charged for return of payment by the financial institution.
• ReturnFeeItemId: string
  Title: Return Check Fee Item ID

  Maximum Length: 30

  Specifies the identifier to charge a fee on return of payment by the financial institution.

{
    "type":"object",
    "properties":{
        "ReturnFeeItemId":{
            "title":"Return Check Fee Item ID",
            "maxLength":"30",
            "type":"string",
            "description":"Specifies the identifier to charge a fee on return of payment by the financial institution.",
            "nullable":true
        },
        "ReinstateFeeFlag":{
            "title":"Reinstate Fee Mark",
            "maxLength":"1",
            "type":"string",
            "description":"Specifies whether a fee should be reinstated for return of payment by the financial institution.",
            "nullable":false,
            "default":"N"
        },
        "ReturnFeeAmount":{
            "title":"Return Check Fee Amount",
            "type":"number",
            "description":"Specifies the amount of the fee charged for return of payment by the financial institution.",
            "nullable":true
        },
        "ReturnFeeCurrency":{
            "title":"Return Check Fee Currency",
            "maxLength":"3",
            "type":"string",
            "description":"Specifies the currency of the fee charged for return of payment by the financial institution.",
            "nullable":true
        },
        "LNPTransactionLimit":{
            "type":"integer",
            "description":"Indicates the transaction limit on data source associated with permits, planning and zoning applications and business license transactions.",
            "format":"int32",
            "nullable":true,
            "default":"200",
            "x-hints":{
                "precision":"3"
            }
        },
        "CETimer":{
            "type":"integer",
            "description":"Indicates the timer associated with search request for code enforcement transactions.",
            "format":"int32",
            "nullable":true,
            "default":"6",
            "x-hints":{
                "precision":"2"
            }
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"Unique identifier of the agency.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            }
        },
        "PunchoutUser":{
            "title":"Punch-out User",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates user types who will be punched out to third party payment service provider page.",
            "nullable":false,
            "default":"ORA_PUBLIC_USER"
        },
        "PaymentReferencePrefix":{
            "title":"Payment Reference Prefix",
            "maxLength":"4",
            "type":"string",
            "description":"Prefix used for the payment reference value.",
            "nullable":false,
            "default":"TPTY"
        },
        "ReturnFeeFlag":{
            "title":"Charge Return Fee Mark",
            "maxLength":"1",
            "type":"string",
            "description":"Specifies whether a return fee should be charged for return of payment by the financial institution.",
            "nullable":false,
            "default":"N"
        },
        "CEFeeLimit":{
            "type":"integer",
            "description":"Indicates the transaction limit on data source associated with code enforcement transactions.",
            "format":"int32",
            "nullable":true,
            "default":"200",
            "x-hints":{
                "precision":"3"
            }
        }
    }
}

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

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  Unique identifier of the agency.
• CEFeeLimit: integer (int32)
  Default Value: 200

  Indicates the transaction limit on data source associated with code enforcement transactions.
• CETimer: integer (int32)
  Default Value: 6

  Indicates the timer associated with search request for code enforcement transactions.
• links: array Links
  Title: Links

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

  Indicates the transaction limit on data source associated with permits, planning and zoning applications and business license transactions.
• PaymentReferencePrefix: string
  Title: Payment Reference Prefix

  Maximum Length: 4

  Default Value: TPTY

  Prefix used for the payment reference value.
• PunchoutUser: string
  Title: Punch-out User

  Maximum Length: 30

  Default Value: ORA_PUBLIC_USER

  Indicates user types who will be punched out to third party payment service provider page.
• PunchoutUserName: string
  Read Only: true

  Maximum Length: 80

  Indicates the user types who will be punched out to third party payment service provider page.
• ReinstateFeeFlag: string
  Title: Reinstate Fee Mark

  Maximum Length: 1

  Default Value: N

  Specifies whether a fee should be reinstated for return of payment by the financial institution.
• ReturnFeeAmount: number
  Title: Return Check Fee Amount

  Specifies the amount of the fee charged for return of payment by the financial institution.
• ReturnFeeCurrency: string
  Title: Return Check Fee Currency

  Maximum Length: 3

  Specifies the currency of the fee charged for return of payment by the financial institution.
• ReturnFeeFlag: string
  Title: Charge Return Fee Mark

  Maximum Length: 1

  Default Value: N

  Specifies whether a return fee should be charged for return of payment by the financial institution.
• ReturnFeeItemId: string
  Title: Return Check Fee Item ID

  Maximum Length: 30

  Specifies the identifier to charge a fee on return of payment by the financial institution.

{
    "type":"object",
    "properties":{
        "ReturnFeeItemId":{
            "title":"Return Check Fee Item ID",
            "maxLength":"30",
            "type":"string",
            "description":"Specifies the identifier to charge a fee on return of payment by the financial institution.",
            "nullable":true,
            "x-queryable":true
        },
        "LNPTransactionLimit":{
            "type":"integer",
            "description":"Indicates the transaction limit on data source associated with permits, planning and zoning applications and business license transactions.",
            "format":"int32",
            "nullable":true,
            "default":"200",
            "x-hints":{
                "precision":"3"
            },
            "x-queryable":true
        },
        "PunchoutUserName":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates the user types who will be punched out to third party payment service provider page.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"Unique identifier of the agency.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "PunchoutUser":{
            "title":"Punch-out User",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates user types who will be punched out to third party payment service provider page.",
            "nullable":false,
            "default":"ORA_PUBLIC_USER",
            "x-queryable":true
        },
        "PaymentReferencePrefix":{
            "title":"Payment Reference Prefix",
            "maxLength":"4",
            "type":"string",
            "description":"Prefix used for the payment reference value.",
            "nullable":false,
            "default":"TPTY",
            "x-queryable":true
        },
        "ReinstateFeeFlag":{
            "title":"Reinstate Fee Mark",
            "maxLength":"1",
            "type":"string",
            "description":"Specifies whether a fee should be reinstated for return of payment by the financial institution.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "ReturnFeeAmount":{
            "title":"Return Check Fee Amount",
            "type":"number",
            "description":"Specifies the amount of the fee charged for return of payment by the financial institution.",
            "nullable":true,
            "x-queryable":true
        },
        "ReturnFeeCurrency":{
            "title":"Return Check Fee Currency",
            "maxLength":"3",
            "type":"string",
            "description":"Specifies the currency of the fee charged for return of payment by the financial institution.",
            "nullable":true,
            "x-queryable":true
        },
        "CETimer":{
            "type":"integer",
            "description":"Indicates the timer associated with search request for code enforcement transactions.",
            "format":"int32",
            "nullable":true,
            "default":"6",
            "x-hints":{
                "precision":"2"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ReturnFeeFlag":{
            "title":"Charge Return Fee Mark",
            "maxLength":"1",
            "type":"string",
            "description":"Specifies whether a return fee should be charged for return of payment by the financial institution.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "CEFeeLimit":{
            "type":"integer",
            "description":"Indicates the transaction limit on data source associated with code enforcement transactions.",
            "format":"int32",
            "nullable":true,
            "default":"200",
            "x-hints":{
                "precision":"3"
            },
            "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