Jump to

• Request
• Response

Create an agency payment option

post

/fscmRestApi/resources/11.13.18.05/publicSectorPaymentOptionsAgencies

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

Type: object

Show Source

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

  Maximum Length: 20

  The autonumbering rule used to generate cashier session numbers.
• CreatedBy(optional): string
  Maximum Length: 64

  The user who created the agency payment option.
• CreationDate(optional): string(date-time)
  The date on which the agency payment option was created.
• DepositSlipAtnRule(optional): string
  Title: Deposit Slip Number

  Maximum Length: 20

  The autonumbering rule used to generate deposit slip sequence numbers.
• LastUpdateDate(optional): string(date-time)
  The date on which the agency payment option was last updated.
• LastUpdatedBy(optional): string
  Maximum Length: 64

  The user who last updated the agency payment option.
• LastUpdateLogin(optional): string
  Maximum Length: 32

  The session ID associated with the user who last updated the row.
• links(optional): array Items
  Title: Items

  Link Relations
• ObjectVersionNumber(optional): integer(int32)
  A number used to implement optimized locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
• PaymentAdapterId(optional): string
  Title: Payment Adapter ID

  Maximum Length: 100

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

  Maximum Length: 30

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

  Maximum Length: 4

  Prefix used by the Payment Engine during the creation of the payment reference value that is sent as pass through data to the payment processor, trust account, and cash drawer.
• ReceiptAtnRule(optional): string
  Title: Cash Receipts Number Rule

  Maximum Length: 20

  The autonumbering rule used to generate receipt numbers.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency receiving an incoming customer payment. This is usually the name of a city or county."
        },
        "CashierSessionAtnRule":{
            "maxLength":20,
            "type":"string",
            "description":"The autonumbering rule used to generate cashier session numbers.",
            "title":"Cashier Session Number Rule"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the agency payment option."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date on which the agency payment option was created."
        },
        "DepositSlipAtnRule":{
            "maxLength":20,
            "type":"string",
            "description":"The autonumbering rule used to generate deposit slip sequence numbers.",
            "title":"Deposit Slip Number"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date on which the agency payment option was last updated."
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The session ID associated with the user who last updated the row."
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the agency payment option."
        },
        "ObjectVersionNumber":{
            "format":"int32",
            "type":"integer",
            "description":"A number used to implement optimized locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried."
        },
        "PaymentAdapterId":{
            "maxLength":100,
            "type":"string",
            "description":"The unique identifier of the payment adapter associated with the agency.",
            "title":"Payment Adapter ID"
        },
        "PaymentMethodCode":{
            "maxLength":30,
            "type":"string",
            "description":"The method of payment. Possible values are Cash or Check.",
            "title":"Payment Method"
        },
        "PaymentReferencePrefix":{
            "maxLength":4,
            "type":"string",
            "description":"Prefix used by the Payment Engine during the creation of the payment reference value that is sent as pass through data to the payment processor, trust account, and cash drawer.",
            "title":"Payment Reference Prefix"
        },
        "ReceiptAtnRule":{
            "maxLength":20,
            "type":"string",
            "description":"The autonumbering rule used to generate receipt numbers.",
            "title":"Cash Receipts Number Rule"
        },
        "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 : publicSectorPaymentOptionsAgencies-item

Type: object

Show Source

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

  Maximum Length: 20

  The autonumbering rule used to generate cashier session numbers.
• CreatedBy(optional): string
  Maximum Length: 64

  The user who created the agency payment option.
• CreationDate(optional): string(date-time)
  The date on which the agency payment option was created.
• DepositSlipAtnRule(optional): string
  Title: Deposit Slip Number

  Maximum Length: 20

  The autonumbering rule used to generate deposit slip sequence numbers.
• LastUpdateDate(optional): string(date-time)
  The date on which the agency payment option was last updated.
• LastUpdatedBy(optional): string
  Maximum Length: 64

  The user who last updated the agency payment option.
• LastUpdateLogin(optional): string
  Maximum Length: 32

  The session ID associated with the user who last updated the row.
• links(optional): array Items
  Title: Items

  Link Relations
• ObjectVersionNumber(optional): integer(int32)
  A number used to implement optimized locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
• PaymentAdapterId(optional): string
  Title: Payment Adapter ID

  Maximum Length: 100

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

  Maximum Length: 30

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

  Maximum Length: 4

  Prefix used by the Payment Engine during the creation of the payment reference value that is sent as pass through data to the payment processor, trust account, and cash drawer.
• ReceiptAtnRule(optional): string
  Title: Cash Receipts Number Rule

  Maximum Length: 20

  The autonumbering rule used to generate receipt numbers.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency receiving an incoming customer payment. This is usually the name of a city or county."
        },
        "CashierSessionAtnRule":{
            "maxLength":20,
            "type":"string",
            "description":"The autonumbering rule used to generate cashier session numbers.",
            "title":"Cashier Session Number Rule"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the agency payment option."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date on which the agency payment option was created."
        },
        "DepositSlipAtnRule":{
            "maxLength":20,
            "type":"string",
            "description":"The autonumbering rule used to generate deposit slip sequence numbers.",
            "title":"Deposit Slip Number"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date on which the agency payment option was last updated."
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The session ID associated with the user who last updated the row."
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the agency payment option."
        },
        "ObjectVersionNumber":{
            "format":"int32",
            "type":"integer",
            "description":"A number used to implement optimized locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried."
        },
        "PaymentAdapterId":{
            "maxLength":100,
            "type":"string",
            "description":"The unique identifier of the payment adapter associated with the agency.",
            "title":"Payment Adapter ID"
        },
        "PaymentMethodCode":{
            "maxLength":30,
            "type":"string",
            "description":"The method of payment. Possible values are Cash or Check.",
            "title":"Payment Method"
        },
        "PaymentReferencePrefix":{
            "maxLength":4,
            "type":"string",
            "description":"Prefix used by the Payment Engine during the creation of the payment reference value that is sent as pass through data to the payment processor, trust account, and cash drawer.",
            "title":"Payment Reference Prefix"
        },
        "ReceiptAtnRule":{
            "maxLength":20,
            "type":"string",
            "description":"The autonumbering rule used to generate receipt numbers.",
            "title":"Cash Receipts Number Rule"
        },
        "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