Jump to

• Request
• Response

Create an agency payment option

post

/fscmRestApi/resources/11.13.18.05/publicSectorPaymentOptionsAgencies

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)
  The unique identifier of the agency receiving an incoming customer payment. This is usually the name of a city or county.
• CashierSessionAtnRule: string
  Title: Cashier Session Number Rule

  Maximum Length: 20

  The autonumbering rule used to generate cashier session numbers.
• DefaultPaymentMethod: string
  Title: Default Payment

  Maximum Length: 30

  The initial payment method that defaults on the cash drawer payment page.
• DepositSlipAtnRule: string
  Title: Deposit Slip Number

  Maximum Length: 20

  The autonumbering rule used to generate deposit slip sequence numbers.
• EnabledUser: string
  Maximum Length: 30

  Default Value: ORA_AGENCY_STAFF

  Indicates whether payment method is enabled for agency staff or public user or both.
• IdVerification: string
  Title: Require ID Verification

  Maximum Length: 1

  Indicates whether ID verification is required when accepting check payments.
• PaymentAdapterId: string
  Title: Payment Adapter ID

  Maximum Length: 100

  The unique identifier of the payment adapter associated with the agency.
• PaymentMethodCode: string
  Title: Payment Method

  Maximum Length: 30

  The method of payment. Possible values are Cash or Check.
• PaymentReferencePrefix: string
  Title: Payment Reference Prefix

  Maximum Length: 4

  Prefix used by the payment process for the payment reference value.
• ReceiptAtnRule: string
  Title: Cash Receipts Number Rule

  Maximum Length: 20

  The autonumbering rule used to generate receipt numbers.
• RefundFeeItemId: string
  Title: Overpayment Refund Recovery Fee ID

  Maximum Length: 30

  Specifies the identifier to recover a refund of overpayment on return of payment by the financial institution.
• ReinstateFeeFlag: string
  Title: Reinstate Fee

  Maximum Length: 1

  Default Value: N

  Specifies whether a fee should be reinstated on return of payment by the financial institution.
• ReopenCashierSession: string
  Title: Reopen Cashier Session

  Maximum Length: 1

  Indicates whether users can reopen a closed cashier session that has not been reconciled.
• ReturnFeeAmount: number
  Title: Returned Payment Fee Amount

  Specifies the amount of the fee charged on return of payment by the financial institution.
• ReturnFeeCurrency: string
  Title: Returned Payment Fee Currency

  Maximum Length: 3

  Specifies the currency of the fee charged on return of payment by the financial institution.
• ReturnFeeItemId: string
  Title: Returned Payment Fee ID

  Maximum Length: 30

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

{
    "type":"object",
    "properties":{
        "ReturnFeeItemId":{
            "title":"Returned Payment Fee ID",
            "maxLength":"30",
            "type":"string",
            "description":"Specifies the identifier to charge a fee on return of payment by the financial institution.",
            "nullable":true
        },
        "ReceiptAtnRule":{
            "title":"Cash Receipts Number Rule",
            "maxLength":"20",
            "type":"string",
            "description":"The autonumbering rule used to generate receipt numbers.",
            "nullable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the agency receiving an incoming customer payment. This is usually the name of a city or county.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"8"
            }
        },
        "CashierSessionAtnRule":{
            "title":"Cashier Session Number Rule",
            "maxLength":"20",
            "type":"string",
            "description":"The autonumbering rule used to generate cashier session numbers.",
            "nullable":true
        },
        "IdVerification":{
            "title":"Require ID Verification",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether ID verification is required when accepting check payments.",
            "nullable":true
        },
        "PaymentReferencePrefix":{
            "title":"Payment Reference Prefix",
            "maxLength":"4",
            "type":"string",
            "description":"Prefix used by the payment process for the payment reference value.",
            "nullable":false
        },
        "PaymentMethodCode":{
            "title":"Payment Method",
            "maxLength":"30",
            "type":"string",
            "description":"The method of payment. Possible values are Cash or Check.",
            "nullable":false
        },
        "DefaultPaymentMethod":{
            "title":"Default Payment",
            "maxLength":"30",
            "type":"string",
            "description":"The initial payment method that defaults on the cash drawer payment page.",
            "nullable":true
        },
        "ReturnFeeAmount":{
            "title":"Returned Payment Fee Amount",
            "type":"number",
            "description":"Specifies the amount of the fee charged on return of payment by the financial institution.",
            "nullable":true
        },
        "ReinstateFeeFlag":{
            "title":"Reinstate Fee",
            "maxLength":"1",
            "type":"string",
            "description":"Specifies whether a fee should be reinstated on return of payment by the financial institution.",
            "nullable":false,
            "default":"N"
        },
        "ReturnFeeCurrency":{
            "title":"Returned Payment Fee Currency",
            "maxLength":"3",
            "type":"string",
            "description":"Specifies the currency of the fee charged on return of payment by the financial institution.",
            "nullable":true
        },
        "DepositSlipAtnRule":{
            "title":"Deposit Slip Number",
            "maxLength":"20",
            "type":"string",
            "description":"The autonumbering rule used to generate deposit slip sequence numbers.",
            "nullable":true
        },
        "EnabledUser":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether payment method is enabled for agency staff or public user or both.",
            "nullable":false,
            "default":"ORA_AGENCY_STAFF"
        },
        "RefundFeeItemId":{
            "title":"Overpayment Refund Recovery Fee ID",
            "maxLength":"30",
            "type":"string",
            "description":"Specifies the identifier to recover a refund of overpayment on return of payment by the financial institution.",
            "nullable":true
        },
        "PaymentAdapterId":{
            "title":"Payment Adapter ID",
            "maxLength":"100",
            "type":"string",
            "description":"The unique identifier of the payment adapter associated with the agency.",
            "nullable":true
        },
        "ReopenCashierSession":{
            "title":"Reopen Cashier Session",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether users can reopen a closed cashier session that has not been reconciled.",
            "nullable":true
        }
    }
}

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

Type: object

Show Source

• AgencyId: integer (int32)
  The unique identifier of the agency receiving an incoming customer payment. This is usually the name of a city or county.
• CashierSessionAtnRule: string
  Title: Cashier Session Number Rule

  Maximum Length: 20

  The autonumbering rule used to generate cashier session numbers.
• DefaultPaymentMethod: string
  Title: Default Payment

  Maximum Length: 30

  The initial payment method that defaults on the cash drawer payment page.
• DepositSlipAtnRule: string
  Title: Deposit Slip Number

  Maximum Length: 20

  The autonumbering rule used to generate deposit slip sequence numbers.
• EnabledUser: string
  Maximum Length: 30

  Default Value: ORA_AGENCY_STAFF

  Indicates whether payment method is enabled for agency staff or public user or both.
• IdVerification: string
  Title: Require ID Verification

  Maximum Length: 1

  Indicates whether ID verification is required when accepting check payments.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PaymentAdapterId: string
  Title: Payment Adapter ID

  Maximum Length: 100

  The unique identifier of the payment adapter associated with the agency.
• PaymentMethodCode: string
  Title: Payment Method

  Maximum Length: 30

  The method of payment. Possible values are Cash or Check.
• PaymentReferencePrefix: string
  Title: Payment Reference Prefix

  Maximum Length: 4

  Prefix used by the payment process for the payment reference value.
• ReceiptAtnRule: string
  Title: Cash Receipts Number Rule

  Maximum Length: 20

  The autonumbering rule used to generate receipt numbers.
• RefundFeeItemId: string
  Title: Overpayment Refund Recovery Fee ID

  Maximum Length: 30

  Specifies the identifier to recover a refund of overpayment on return of payment by the financial institution.
• ReinstateFeeFlag: string
  Title: Reinstate Fee

  Maximum Length: 1

  Default Value: N

  Specifies whether a fee should be reinstated on return of payment by the financial institution.
• ReopenCashierSession: string
  Title: Reopen Cashier Session

  Maximum Length: 1

  Indicates whether users can reopen a closed cashier session that has not been reconciled.
• ReturnFeeAmount: number
  Title: Returned Payment Fee Amount

  Specifies the amount of the fee charged on return of payment by the financial institution.
• ReturnFeeCurrency: string
  Title: Returned Payment Fee Currency

  Maximum Length: 3

  Specifies the currency of the fee charged on return of payment by the financial institution.
• ReturnFeeItemId: string
  Title: Returned Payment Fee ID

  Maximum Length: 30

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

{
    "type":"object",
    "properties":{
        "ReturnFeeItemId":{
            "title":"Returned Payment Fee 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
        },
        "ReceiptAtnRule":{
            "title":"Cash Receipts Number Rule",
            "maxLength":"20",
            "type":"string",
            "description":"The autonumbering rule used to generate receipt numbers.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the agency receiving an incoming customer payment. This is usually the name of a city or county.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "CashierSessionAtnRule":{
            "title":"Cashier Session Number Rule",
            "maxLength":"20",
            "type":"string",
            "description":"The autonumbering rule used to generate cashier session numbers.",
            "nullable":true,
            "x-queryable":true
        },
        "IdVerification":{
            "title":"Require ID Verification",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether ID verification is required when accepting check payments.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentReferencePrefix":{
            "title":"Payment Reference Prefix",
            "maxLength":"4",
            "type":"string",
            "description":"Prefix used by the payment process for the payment reference value.",
            "nullable":false,
            "x-queryable":true
        },
        "PaymentMethodCode":{
            "title":"Payment Method",
            "maxLength":"30",
            "type":"string",
            "description":"The method of payment. Possible values are Cash or Check.",
            "nullable":false,
            "x-queryable":true
        },
        "DefaultPaymentMethod":{
            "title":"Default Payment",
            "maxLength":"30",
            "type":"string",
            "description":"The initial payment method that defaults on the cash drawer payment page.",
            "nullable":true,
            "x-queryable":true
        },
        "ReturnFeeAmount":{
            "title":"Returned Payment Fee Amount",
            "type":"number",
            "description":"Specifies the amount of the fee charged on return of payment by the financial institution.",
            "nullable":true,
            "x-queryable":true
        },
        "ReinstateFeeFlag":{
            "title":"Reinstate Fee",
            "maxLength":"1",
            "type":"string",
            "description":"Specifies whether a fee should be reinstated on return of payment by the financial institution.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "ReturnFeeCurrency":{
            "title":"Returned Payment Fee Currency",
            "maxLength":"3",
            "type":"string",
            "description":"Specifies the currency of the fee charged on return of payment by the financial institution.",
            "nullable":true,
            "x-queryable":true
        },
        "DepositSlipAtnRule":{
            "title":"Deposit Slip Number",
            "maxLength":"20",
            "type":"string",
            "description":"The autonumbering rule used to generate deposit slip sequence numbers.",
            "nullable":true,
            "x-queryable":true
        },
        "EnabledUser":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether payment method is enabled for agency staff or public user or both.",
            "nullable":false,
            "default":"ORA_AGENCY_STAFF",
            "x-queryable":true
        },
        "RefundFeeItemId":{
            "title":"Overpayment Refund Recovery Fee ID",
            "maxLength":"30",
            "type":"string",
            "description":"Specifies the identifier to recover a refund of overpayment on return of payment by the financial institution.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentAdapterId":{
            "title":"Payment Adapter ID",
            "maxLength":"100",
            "type":"string",
            "description":"The unique identifier of the payment adapter associated with the agency.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ReopenCashierSession":{
            "title":"Reopen Cashier Session",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether users can reopen a closed cashier session that has not been reconciled.",
            "nullable":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