Jump to

• Request
• Response

Update a third party payments

patch

/fscmRestApi/resources/11.13.18.05/publicSectorThirdPartyPayments/{PaymentHeaderKey}

Request

Path Parameters

• PaymentHeaderKey(required): integer(int64)
  Identifies the primary key value of the payment.

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

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  Identifies the agency id associated with a payment.
• ExternalPaymentReference: string
  Title: External Payment Reference

  Maximum Length: 480

  Identifies the payment reference provided by third party payment system.
• OnaccountFlag: string
  Maximum Length: 1

  Default Value: N

  Identifies the payment as an account payment without fee records.
• PaymentAmountTotal: number
  Title: Payment Amount Total

  Identifies the total amount received as payment.
• PaymentCurrency: string
  Title: Payment Currency

  Maximum Length: 3

  Identifies the currency of the payment.
• PaymentDatetime: string (date-time)
  Title: Payment Date Time

  Identifies the UTC date time provided by third party payment system.
• PaymentNotes: string
  Title: Payment Notes

  Maximum Length: 2000

  Identifies the memo recorded for a payment.
• ProcessedByName: string
  Maximum Length: 240

  Identifies the agency staff who processed the payment.
• SelfServiceFlag: string
  Title: Self Service Mark

  Maximum Length: 1

  Default Value: N

  Identifies self service payments.
• ThirdPartyPaymentLine: array ThirdPartyPaymentLines
  Title: ThirdPartyPaymentLines

  The third party payment lines resource is used to view or create third party payment records.
• ThirdPartyPaymentMethod: array ThirdPartyPaymentMethods
  Title: ThirdPartyPaymentMethods

  The third party payment methods resource is used to view or create third party payment records.

{
    "type":"object",
    "properties":{
        "SelfServiceFlag":{
            "title":"Self Service Mark",
            "maxLength":1,
            "type":"string",
            "description":"Identifies self service payments.",
            "nullable":false,
            "default":"N"
        },
        "ThirdPartyPaymentLine":{
            "title":"ThirdPartyPaymentLines",
            "type":"array",
            "description":"The third party payment lines resource is used to view or create third party payment records.",
            "items":{
                "$ref":"#/components/schemas/publicSectorThirdPartyPayments-ThirdPartyPaymentLine-item-patch-request"
            }
        },
        "ProcessedByName":{
            "maxLength":240,
            "type":"string",
            "description":"Identifies the agency staff who processed the payment.",
            "nullable":true
        },
        "PaymentNotes":{
            "title":"Payment Notes",
            "maxLength":2000,
            "type":"string",
            "description":"Identifies the memo recorded for a payment.",
            "nullable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"Identifies the agency id associated with a payment.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            }
        },
        "OnaccountFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Identifies the payment as an account payment without fee records.",
            "nullable":false,
            "default":"N"
        },
        "ThirdPartyPaymentMethod":{
            "title":"ThirdPartyPaymentMethods",
            "type":"array",
            "description":"The third party payment methods resource is used to view or create third party payment records.",
            "items":{
                "$ref":"#/components/schemas/publicSectorThirdPartyPayments-ThirdPartyPaymentMethod-item-patch-request"
            }
        },
        "ExternalPaymentReference":{
            "title":"External Payment Reference",
            "maxLength":480,
            "type":"string",
            "description":"Identifies the payment reference provided by third party payment system.",
            "nullable":false
        },
        "PaymentDatetime":{
            "title":"Payment Date Time",
            "type":"string",
            "description":"Identifies the UTC date time provided by third party payment system.",
            "format":"date-time",
            "nullable":false
        },
        "PaymentCurrency":{
            "title":"Payment Currency",
            "maxLength":3,
            "type":"string",
            "description":"Identifies the currency of the payment.",
            "nullable":false
        },
        "PaymentAmountTotal":{
            "title":"Payment Amount Total",
            "type":"number",
            "description":"Identifies the total amount received as payment.",
            "nullable":false
        }
    }
}

Nested Schema : ThirdPartyPaymentLines

Type: array

Title: ThirdPartyPaymentLines

The third party payment lines resource is used to view or create third party payment records.

Show Source

• Array of: object publicSectorThirdPartyPayments-ThirdPartyPaymentLine-item-patch-request

{
    "title":"ThirdPartyPaymentLines",
    "type":"array",
    "description":"The third party payment lines resource is used to view or create third party payment records.",
    "items":{
        "$ref":"#/components/schemas/publicSectorThirdPartyPayments-ThirdPartyPaymentLine-item-patch-request"
    }
}

Nested Schema : ThirdPartyPaymentMethods

Type: array

Title: ThirdPartyPaymentMethods

The third party payment methods resource is used to view or create third party payment records.

Show Source

• Array of: object schema

{
    "title":"ThirdPartyPaymentMethods",
    "type":"array",
    "description":"The third party payment methods resource is used to view or create third party payment records.",
    "items":{
        "$ref":"#/components/schemas/publicSectorThirdPartyPayments-ThirdPartyPaymentMethod-item-patch-request"
    }
}

Nested Schema : publicSectorThirdPartyPayments-ThirdPartyPaymentLine-item-patch-request

Type: object

Show Source

• Classification: string
  Title: Classification

  Maximum Length: 3

  Identifies the classification for the transaction record.
• ItemAmount: number
  Title: Item Amount

  Identifies the item amount received as payment line record.
• ItemCurrency: string
  Title: Item Currency

  Maximum Length: 3

  Identifies the currency of the fee.
• ItemGroupId: string
  Title: Item Group ID

  Maximum Length: 50

  Identifies the item group id associated with a payment.
• ItemQuantity: number
  Identifies the item quantity associated to a payment line record.
• ItemRecordKey: integer (int64)
  Identifies the primary key of the payment line record.
• ItemUnitPrice: number
  Title: Item Unit Price

  Identifies the item unit price associated to a payment line record.
• SearchId: string
  Title: Search ID

  Maximum Length: 50

  Identifies the search id associated with a payment line record.
• TransactionRecordId: string
  Title: Transaction Record ID

  Maximum Length: 50

  Identifies the unique alpha numeric value of the transaction record.
• TransactionRecordKey: integer (int64)
  Title: Transaction Record Key

  Identifies the primary key of the transaction record.

{
    "type":"object",
    "properties":{
        "ItemUnitPrice":{
            "title":"Item Unit Price",
            "type":"number",
            "description":"Identifies the item unit price associated to a payment line record.",
            "nullable":false
        },
        "SearchId":{
            "title":"Search ID",
            "maxLength":50,
            "type":"string",
            "description":"Identifies the search id associated with a payment line record.",
            "nullable":true
        },
        "ItemGroupId":{
            "title":"Item Group ID",
            "maxLength":50,
            "type":"string",
            "description":"Identifies the item group id associated with a payment.",
            "nullable":true
        },
        "ItemQuantity":{
            "type":"number",
            "description":"Identifies the item quantity associated to a payment line record.",
            "nullable":false
        },
        "Classification":{
            "title":"Classification",
            "maxLength":3,
            "type":"string",
            "description":"Identifies the classification for the transaction record.",
            "nullable":true
        },
        "ItemCurrency":{
            "title":"Item Currency",
            "maxLength":3,
            "type":"string",
            "description":"Identifies the currency of the fee.",
            "nullable":false
        },
        "TransactionRecordKey":{
            "title":"Transaction Record Key",
            "type":"integer",
            "description":"Identifies the primary key of the transaction record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "TransactionRecordId":{
            "title":"Transaction Record ID",
            "maxLength":50,
            "type":"string",
            "description":"Identifies the unique alpha numeric value of the transaction record.",
            "nullable":false
        },
        "ItemAmount":{
            "title":"Item Amount",
            "type":"number",
            "description":"Identifies the item amount received as payment line record.",
            "nullable":false
        },
        "ItemRecordKey":{
            "type":"integer",
            "description":"Identifies the primary key of the payment line record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• PayerAddress: string
  Title: Payer Address

  Maximum Length: 2000

  Identifies the address associated with the payment instrument.
• PayerEmail: string
  Title: Payer Email

  Maximum Length: 480

  Identifies the email associated with the payment instrument.
• PayerName: string
  Title: Payer Name

  Maximum Length: 480

  Identifies the name associated with the payment instrument.
• PaymentAmount: number
  Title: Payment Amount

  Identifies the amount received.
• PaymentCurrency: string
  Maximum Length: 3

  Identifies the payment currency.
• PaymentStatus: string
  Title: Payment Status

  Maximum Length: 30

  Identifies the payment status for a record.
• PaymentTransactionId: string
  Title: Payment Transaction ID

  Maximum Length: 50

  Identifies the reference number associated with the payment instrument.
• PrimaryTrackingData: string
  Title: Primary Tracking Data

  Maximum Length: 100

  Identifies the tracking reference associated with payment.
• SecondaryTrackingData: string
  Title: Secondary Tracking Data

  Maximum Length: 100

  Identifies the tracking reference associated with payment.
• ServiceChargeAmount: number
  Title: Service Charge Amount

  Identifies the service amount charges for a payment.
• TertiaryTrackingData: string
  Title: Tertiary Tracking Data

  Maximum Length: 100

  Identifies the tracking reference associated with payment.
• VoidByName: string
  Title: Void by Name

  Maximum Length: 240

  Identifies the name who voided payment.
• VoidComments: string
  Title: Void Comments

  Maximum Length: 2000

  Identifies the void comments.

{
    "type":"object",
    "properties":{
        "PaymentTransactionId":{
            "title":"Payment Transaction ID",
            "maxLength":50,
            "type":"string",
            "description":"Identifies the reference number associated with the payment instrument.",
            "nullable":false
        },
        "ServiceChargeAmount":{
            "title":"Service Charge Amount",
            "type":"number",
            "description":"Identifies the service amount charges for a payment.",
            "nullable":false
        },
        "VoidByName":{
            "title":"Void by Name",
            "maxLength":240,
            "type":"string",
            "description":"Identifies the name who voided payment.",
            "nullable":true
        },
        "PrimaryTrackingData":{
            "title":"Primary Tracking Data",
            "maxLength":100,
            "type":"string",
            "description":"Identifies the tracking reference associated with payment.",
            "nullable":true
        },
        "PayerAddress":{
            "title":"Payer Address",
            "maxLength":2000,
            "type":"string",
            "description":"Identifies the address associated with the payment instrument.",
            "nullable":true
        },
        "SecondaryTrackingData":{
            "title":"Secondary Tracking Data",
            "maxLength":100,
            "type":"string",
            "description":"Identifies the tracking reference associated with payment.",
            "nullable":true
        },
        "PaymentCurrency":{
            "maxLength":3,
            "type":"string",
            "description":"Identifies the payment currency.",
            "nullable":false
        },
        "PayerName":{
            "title":"Payer Name",
            "maxLength":480,
            "type":"string",
            "description":"Identifies the name associated with the payment instrument.",
            "nullable":true
        },
        "PayerEmail":{
            "title":"Payer Email",
            "maxLength":480,
            "type":"string",
            "description":"Identifies the email associated with the payment instrument.",
            "nullable":true
        },
        "PaymentAmount":{
            "title":"Payment Amount",
            "type":"number",
            "description":"Identifies the amount received.",
            "nullable":false
        },
        "VoidComments":{
            "title":"Void Comments",
            "maxLength":2000,
            "type":"string",
            "description":"Identifies the void comments.",
            "nullable":true
        },
        "TertiaryTrackingData":{
            "title":"Tertiary Tracking Data",
            "maxLength":100,
            "type":"string",
            "description":"Identifies the tracking reference associated with payment.",
            "nullable":true
        },
        "PaymentStatus":{
            "title":"Payment Status",
            "maxLength":30,
            "type":"string",
            "description":"Identifies the payment status for a record.",
            "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(required):
  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(required):
  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 : publicSectorThirdPartyPayments-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  Identifies the agency id associated with a payment.
• ExternalPaymentReference: string
  Title: External Payment Reference

  Maximum Length: 480

  Identifies the payment reference provided by third party payment system.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OnaccountFlag: string
  Maximum Length: 1

  Default Value: N

  Identifies the payment as an account payment without fee records.
• PaymentAmountTotal: number
  Title: Payment Amount Total

  Identifies the total amount received as payment.
• PaymentCurrency: string
  Title: Payment Currency

  Maximum Length: 3

  Identifies the currency of the payment.
• PaymentDatetime: string (date-time)
  Title: Payment Date Time

  Identifies the UTC date time provided by third party payment system.
• PaymentHeaderId: string
  Title: Payment Header ID

  Read Only: true

  Maximum Length: 50

  Identifies the unique alpha numeric reference of the payment.
• PaymentHeaderKey: integer (int64)
  Title: Payment Header Key

  Identifies the primary key value of the payment.
• PaymentNotes: string
  Title: Payment Notes

  Maximum Length: 2000

  Identifies the memo recorded for a payment.
• ProcessedByName: string
  Maximum Length: 240

  Identifies the agency staff who processed the payment.
• SelfServiceFlag: string
  Title: Self Service Mark

  Maximum Length: 1

  Default Value: N

  Identifies self service payments.
• ThirdPartyPaymentLine: array ThirdPartyPaymentLines
  Title: ThirdPartyPaymentLines

  The third party payment lines resource is used to view or create third party payment records.
• ThirdPartyPaymentMethod: array ThirdPartyPaymentMethods
  Title: ThirdPartyPaymentMethods

  The third party payment methods resource is used to view or create third party payment records.
• VoidAmountTotal: number
  Title: Void Amount Total

  Read Only: true

  Identifies the total amount voided for the payment.

{
    "type":"object",
    "properties":{
        "PaymentNotes":{
            "title":"Payment Notes",
            "maxLength":2000,
            "type":"string",
            "description":"Identifies the memo recorded for a payment.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"Identifies the agency id associated with a payment.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "OnaccountFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Identifies the payment as an account payment without fee records.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "ExternalPaymentReference":{
            "title":"External Payment Reference",
            "maxLength":480,
            "type":"string",
            "description":"Identifies the payment reference provided by third party payment system.",
            "nullable":false,
            "x-queryable":true
        },
        "PaymentCurrency":{
            "title":"Payment Currency",
            "maxLength":3,
            "type":"string",
            "description":"Identifies the currency of the payment.",
            "nullable":false,
            "x-queryable":true
        },
        "SelfServiceFlag":{
            "title":"Self Service Mark",
            "maxLength":1,
            "type":"string",
            "description":"Identifies self service payments.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "ThirdPartyPaymentLine":{
            "title":"ThirdPartyPaymentLines",
            "type":"array",
            "description":"The third party payment lines resource is used to view or create third party payment records.",
            "items":{
                "$ref":"#/components/schemas/publicSectorThirdPartyPayments-ThirdPartyPaymentLine-item-response"
            }
        },
        "ProcessedByName":{
            "maxLength":240,
            "type":"string",
            "description":"Identifies the agency staff who processed the payment.",
            "nullable":true,
            "x-queryable":true
        },
        "ThirdPartyPaymentMethod":{
            "title":"ThirdPartyPaymentMethods",
            "type":"array",
            "description":"The third party payment methods resource is used to view or create third party payment records.",
            "items":{
                "$ref":"#/components/schemas/publicSectorThirdPartyPayments-ThirdPartyPaymentMethod-item-response"
            }
        },
        "PaymentHeaderId":{
            "title":"Payment Header ID",
            "maxLength":50,
            "type":"string",
            "description":"Identifies the unique alpha numeric reference of the payment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PaymentHeaderKey":{
            "title":"Payment Header Key",
            "type":"integer",
            "description":"Identifies the primary key value of the payment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "VoidAmountTotal":{
            "title":"Void Amount Total",
            "type":"number",
            "description":"Identifies the total amount voided for the payment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PaymentDatetime":{
            "title":"Payment Date Time",
            "type":"string",
            "description":"Identifies the UTC date time provided by third party payment system.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "PaymentAmountTotal":{
            "title":"Payment Amount Total",
            "type":"number",
            "description":"Identifies the total amount received as payment.",
            "nullable":false,
            "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 : ThirdPartyPaymentLines

Type: array

Title: ThirdPartyPaymentLines

The third party payment lines resource is used to view or create third party payment records.

Show Source

• Array of: object publicSectorThirdPartyPayments-ThirdPartyPaymentLine-item-response

{
    "title":"ThirdPartyPaymentLines",
    "type":"array",
    "description":"The third party payment lines resource is used to view or create third party payment records.",
    "items":{
        "$ref":"#/components/schemas/publicSectorThirdPartyPayments-ThirdPartyPaymentLine-item-response"
    }
}

Nested Schema : ThirdPartyPaymentMethods

Type: array

Title: ThirdPartyPaymentMethods

The third party payment methods resource is used to view or create third party payment records.

Show Source

• Array of: object publicSectorThirdPartyPayments-ThirdPartyPaymentMethod-item-response

{
    "title":"ThirdPartyPaymentMethods",
    "type":"array",
    "description":"The third party payment methods resource is used to view or create third party payment records.",
    "items":{
        "$ref":"#/components/schemas/publicSectorThirdPartyPayments-ThirdPartyPaymentMethod-item-response"
    }
}

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."
        }
    }
}

Nested Schema : publicSectorThirdPartyPayments-ThirdPartyPaymentLine-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Read Only: true

  Identifies the agency id associated with a payment.
• Classification: string
  Title: Classification

  Maximum Length: 3

  Identifies the classification for the transaction record.
• ExternalPaymentReference: string
  Read Only: true

  Maximum Length: 480

  Identifies the payment reference provided by third party payment system.
• ItemAmount: number
  Title: Item Amount

  Identifies the item amount received as payment line record.
• ItemAmountVoid: number
  Title: Item Amount Void

  Read Only: true

  Identifies the item amount voided.
• ItemCurrency: string
  Title: Item Currency

  Maximum Length: 3

  Identifies the currency of the fee.
• ItemGroupId: string
  Title: Item Group ID

  Maximum Length: 50

  Identifies the item group id associated with a payment.
• ItemQuantity: number
  Identifies the item quantity associated to a payment line record.
• ItemRecordKey: integer (int64)
  Identifies the primary key of the payment line record.
• ItemUnitPrice: number
  Title: Item Unit Price

  Identifies the item unit price associated to a payment line record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PaymentHeaderId: string
  Read Only: true

  Maximum Length: 50

  Identifies the unique alpha numeric reference of the payment.
• PaymentHeaderKey: integer (int64)
  Read Only: true

  Identifies the primary key value of the payment.
• PaymentLineKey: integer (int64)
  Title: Payment Line Key

  Identifies the primary key value of the fee line.
• SearchId: string
  Title: Search ID

  Maximum Length: 50

  Identifies the search id associated with a payment line record.
• TransactionRecordId: string
  Title: Transaction Record ID

  Maximum Length: 50

  Identifies the unique alpha numeric value of the transaction record.
• TransactionRecordKey: integer (int64)
  Title: Transaction Record Key

  Identifies the primary key of the transaction record.

{
    "type":"object",
    "properties":{
        "ItemUnitPrice":{
            "title":"Item Unit Price",
            "type":"number",
            "description":"Identifies the item unit price associated to a payment line record.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"Identifies the agency id associated with a payment.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "ItemAmountVoid":{
            "title":"Item Amount Void",
            "type":"number",
            "description":"Identifies the item amount voided.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemCurrency":{
            "title":"Item Currency",
            "maxLength":3,
            "type":"string",
            "description":"Identifies the currency of the fee.",
            "nullable":false,
            "x-queryable":true
        },
        "ExternalPaymentReference":{
            "maxLength":480,
            "type":"string",
            "description":"Identifies the payment reference provided by third party payment system.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SearchId":{
            "title":"Search ID",
            "maxLength":50,
            "type":"string",
            "description":"Identifies the search id associated with a payment line record.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemGroupId":{
            "title":"Item Group ID",
            "maxLength":50,
            "type":"string",
            "description":"Identifies the item group id associated with a payment.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentHeaderId":{
            "maxLength":50,
            "type":"string",
            "description":"Identifies the unique alpha numeric reference of the payment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemQuantity":{
            "type":"number",
            "description":"Identifies the item quantity associated to a payment line record.",
            "nullable":false,
            "x-queryable":true
        },
        "Classification":{
            "title":"Classification",
            "maxLength":3,
            "type":"string",
            "description":"Identifies the classification for the transaction record.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentHeaderKey":{
            "type":"integer",
            "description":"Identifies the primary key value of the payment.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TransactionRecordKey":{
            "title":"Transaction Record Key",
            "type":"integer",
            "description":"Identifies the primary key of the transaction record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TransactionRecordId":{
            "title":"Transaction Record ID",
            "maxLength":50,
            "type":"string",
            "description":"Identifies the unique alpha numeric value of the transaction record.",
            "nullable":false,
            "x-queryable":true
        },
        "ItemAmount":{
            "title":"Item Amount",
            "type":"number",
            "description":"Identifies the item amount received as payment line record.",
            "nullable":false,
            "x-queryable":true
        },
        "PaymentLineKey":{
            "title":"Payment Line Key",
            "type":"integer",
            "description":"Identifies the primary key value of the fee line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ItemRecordKey":{
            "type":"integer",
            "description":"Identifies the primary key of the payment line record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "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 : publicSectorThirdPartyPayments-ThirdPartyPaymentMethod-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Read Only: true

  Default Value: 1

  Identifies the agency id associated with a payment.
• ExternalPaymentReference: string
  Read Only: true

  Maximum Length: 480

  Identifies the payment reference provided by third party payment system.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PayerAddress: string
  Title: Payer Address

  Maximum Length: 2000

  Identifies the address associated with the payment instrument.
• PayerEmail: string
  Title: Payer Email

  Maximum Length: 480

  Identifies the email associated with the payment instrument.
• PayerName: string
  Title: Payer Name

  Maximum Length: 480

  Identifies the name associated with the payment instrument.
• PaymentAmount: number
  Title: Payment Amount

  Identifies the amount received.
• PaymentCreated: string
  Title: Payment Created

  Read Only: true

  Maximum Length: 30

  Default Value: ORA_CREATED

  Identifies the payment created for a record.
• PaymentCurrency: string
  Maximum Length: 3

  Identifies the payment currency.
• PaymentHeaderId: string
  Read Only: true

  Maximum Length: 50

  Identifies the unique alpha numeric reference of the payment.
• PaymentHeaderKey: integer (int64)
  Read Only: true

  Identifies the primary key value of the payment.
• PaymentHistoryKey: integer (int64)
  Title: Payment History Key

  Read Only: true

  The unique identifier for the payment transaction.
• PaymentMethodCode: string
  Title: Payment Method Code

  Maximum Length: 30

  The method of payment used for a payment transaction, such as credit card, cash, personal check, or cashier???s check.
• PaymentMethodKey: integer (int64)
  Title: Payment Method Key

  Identifies payment method key for a record.
• PaymentReferenceId: string
  Title: Payment Reference ID

  Read Only: true

  Maximum Length: 50

  A reference value created by the payment module and sent as pass-through data to the payment processor.
• PaymentStatus: string
  Title: Payment Status

  Maximum Length: 30

  Identifies the payment status for a record.
• PaymentTransactionId: string
  Title: Payment Transaction ID

  Maximum Length: 50

  Identifies the reference number associated with the payment instrument.
• PrimaryTrackingData: string
  Title: Primary Tracking Data

  Maximum Length: 100

  Identifies the tracking reference associated with payment.
• SecondaryTrackingData: string
  Title: Secondary Tracking Data

  Maximum Length: 100

  Identifies the tracking reference associated with payment.
• ServiceChargeAmount: number
  Title: Service Charge Amount

  Identifies the service amount charges for a payment.
• TertiaryTrackingData: string
  Title: Tertiary Tracking Data

  Maximum Length: 100

  Identifies the tracking reference associated with payment.
• VoidAmount: number
  Read Only: true

  Identifies the void amount.
• VoidByName: string
  Title: Void by Name

  Maximum Length: 240

  Identifies the name who voided payment.
• VoidComments: string
  Title: Void Comments

  Maximum Length: 2000

  Identifies the void comments.
• VoidDatetime: string (date-time)
  Title: Void Date Time

  Read Only: true

  Identifies the void date time.

{
    "type":"object",
    "properties":{
        "PaymentTransactionId":{
            "title":"Payment Transaction ID",
            "maxLength":50,
            "type":"string",
            "description":"Identifies the reference number associated with the payment instrument.",
            "nullable":false,
            "x-queryable":true
        },
        "PaymentMethodKey":{
            "title":"Payment Method Key",
            "type":"integer",
            "description":"Identifies payment method key for a record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"Identifies the agency id associated with a payment.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "ServiceChargeAmount":{
            "title":"Service Charge Amount",
            "type":"number",
            "description":"Identifies the service amount charges for a payment.",
            "nullable":false,
            "x-queryable":true
        },
        "VoidByName":{
            "title":"Void by Name",
            "maxLength":240,
            "type":"string",
            "description":"Identifies the name who voided payment.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryTrackingData":{
            "title":"Primary Tracking Data",
            "maxLength":100,
            "type":"string",
            "description":"Identifies the tracking reference associated with payment.",
            "nullable":true,
            "x-queryable":true
        },
        "PayerAddress":{
            "title":"Payer Address",
            "maxLength":2000,
            "type":"string",
            "description":"Identifies the address associated with the payment instrument.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentCurrency":{
            "maxLength":3,
            "type":"string",
            "description":"Identifies the payment currency.",
            "nullable":false,
            "x-queryable":true
        },
        "PayerEmail":{
            "title":"Payer Email",
            "maxLength":480,
            "type":"string",
            "description":"Identifies the email associated with the payment instrument.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentAmount":{
            "title":"Payment Amount",
            "type":"number",
            "description":"Identifies the amount received.",
            "nullable":false,
            "x-queryable":true
        },
        "PaymentReferenceId":{
            "title":"Payment Reference ID",
            "maxLength":50,
            "type":"string",
            "description":"A reference value created by the payment module and sent as pass-through data to the payment processor.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PaymentHeaderId":{
            "maxLength":50,
            "type":"string",
            "description":"Identifies the unique alpha numeric reference of the payment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PaymentCreated":{
            "title":"Payment Created",
            "maxLength":30,
            "type":"string",
            "description":"Identifies the payment created for a record.",
            "nullable":true,
            "readOnly":true,
            "default":"ORA_CREATED",
            "x-queryable":true
        },
        "PaymentStatus":{
            "title":"Payment Status",
            "maxLength":30,
            "type":"string",
            "description":"Identifies the payment status for a record.",
            "nullable":false,
            "x-queryable":true
        },
        "SecondaryTrackingData":{
            "title":"Secondary Tracking Data",
            "maxLength":100,
            "type":"string",
            "description":"Identifies the tracking reference associated with payment.",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalPaymentReference":{
            "maxLength":480,
            "type":"string",
            "description":"Identifies the payment reference provided by third party payment system.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PayerName":{
            "title":"Payer Name",
            "maxLength":480,
            "type":"string",
            "description":"Identifies the name associated with the payment instrument.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentMethodCode":{
            "title":"Payment Method Code",
            "maxLength":30,
            "type":"string",
            "description":"The method of payment used for a payment transaction, such as credit card, cash, personal check, or cashier???s check.",
            "nullable":false,
            "x-queryable":true
        },
        "VoidComments":{
            "title":"Void Comments",
            "maxLength":2000,
            "type":"string",
            "description":"Identifies the void comments.",
            "nullable":true,
            "x-queryable":true
        },
        "VoidAmount":{
            "type":"number",
            "description":"Identifies the void amount.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PaymentHistoryKey":{
            "title":"Payment History Key",
            "type":"integer",
            "description":"The unique identifier for the payment transaction.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TertiaryTrackingData":{
            "title":"Tertiary Tracking Data",
            "maxLength":100,
            "type":"string",
            "description":"Identifies the tracking reference associated with payment.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentHeaderKey":{
            "type":"integer",
            "description":"Identifies the primary key value of the payment.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "VoidDatetime":{
            "title":"Void Date Time",
            "type":"string",
            "description":"Identifies the void date time.",
            "format":"date-time",
            "nullable":true,
            "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"
    }
}

Links

ThirdPartyPaymentLine

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorThirdPartyPayments/{PaymentHeaderKey}/child/ThirdPartyPaymentLine

Parameters:

• PaymentHeaderKey: $request.path.PaymentHeaderKey

The third party payment lines resource is used to view or create third party payment records.

ThirdPartyPaymentMethod

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorThirdPartyPayments/{PaymentHeaderKey}/child/ThirdPartyPaymentMethod

Parameters:

• PaymentHeaderKey: $request.path.PaymentHeaderKey

The third party payment methods resource is used to view or create third party payment records.

Back to Top