Jump to

• Request
• Response

Update a set of checkout payment data

patch

/fscmRestApi/resources/11.13.18.05/publicSectorCheckouts/{CheckoutId}/child/CheckoutPmt/{CheckoutPmtUniqID}

Request

Path Parameters

• CheckoutId(required): string
  The unique identifier for the checkout data. Generated using the Fusion unique ID API.
• CheckoutPmtUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- CheckoutId and CheckoutPmtId ---for the Checkout Payments resource and used to uniquely identify an instance of Checkout Payments. The client should not generate the hash key value. Instead, the client should query on the Checkout Payments collection resource with a filter on the primary key values in order to navigate to a specific instance of Checkout Payments.
  
  For example: CheckoutPmt?q=CheckoutId=<value1>;CheckoutPmtId=<value2>

Header Parameters

• Metadata-Context: string
  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: string
  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

• AuthorizationCode: string
  Maximum Length: 10

  Authorization code value returned by the payment gateway or trust account system.
• Comments: string
  Title: Comments

  Maximum Length: 240

  Comments provided for the payment.
• Description: string
  Title: Description

  Maximum Length: 100

  Description provided for the payment.

{
    "type":"object",
    "properties":{
        "AuthorizationCode":{
            "maxLength":10,
            "type":"string",
            "description":"Authorization code value returned by the payment gateway or trust account system.",
            "nullable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":100,
            "type":"string",
            "description":"Description provided for the payment.",
            "nullable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":240,
            "type":"string",
            "description":"Comments provided for the payment.",
            "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 : publicSectorCheckouts-CheckoutPmt-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Identifies the identifier associated with an agency.
• AuthorizationCode: string
  Maximum Length: 10

  Authorization code value returned by the payment gateway or trust account system.
• AuthorizationDttm: string (date-time)
  Title: Authorization Date and Time

  Authorization date and time returned by payment gateway system or trust account system.
• AuthorizationStatus: string
  Maximum Length: 4

  The status value returned by the payment gateway or trust account system.
• CashierId: string
  Title: Cashier ID

  Maximum Length: 50

  The unique identifier for the cashier.
• ChangeAmount: number
  Title: Change Due

  The amount of money to be handed back to the payer if the payment received from the payer is more than the amount due.
• CheckAddress: string
  Maximum Length: 240

  The address on the check.
• CheckDate: string (date)
  Title: Check Date

  The date that the check was received from the payer.
• CheckName: string
  Maximum Length: 100

  The name on the check.
• CheckNumber: string
  Title: Check Number

  Maximum Length: 10

  The number of the check that was received from the payer.
• CheckoutId: string
  Maximum Length: 50

  Unique identifier for the checkout data. Generated using the Fusion unique ID API.
• CheckoutPmtId: integer (int64)
  Unique sequence number for the checkout payment row generated using the Fusion unique ID API.
• Comments: string
  Title: Comments

  Maximum Length: 240

  Comments provided for the payment.
• Description: string
  Title: Description

  Maximum Length: 100

  Description provided for the payment.
• DrawerId: string
  Title: Cash Drawer ID

  Maximum Length: 30

  The unique identifier for the cash drawer.
• FirstResponseMessage: string
  Title: Primary Response Message

  Maximum Length: 100

  First part of the response message returned by the payment gateway or a free form message entered by agency staff for cash drawer or trust account.
• LineAmount: number
  Title: Amount

  That dollar amount that applies to a line item.
• links: array Links
  Title: Links

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

  Maximum Length: 240

  The address of the person who made the payment.
• PayerName: string
  Title: Payer Name

  Maximum Length: 100

  The name of the person who made the payment.
• PaymentCurrency: string
  Title: Currency

  Maximum Length: 3

  Currency used for the payment transaction.
• PaymentDate: string (date)
  Title: Payment Date

  Date on which the payment transaction occurred.
• PaymentMethodCode: string
  Title: Payment Method Code

  Maximum Length: 30

  Type of payment selected during checkout.
• PaymentReferenceId: string
  Title: Payment Reference ID

  Maximum Length: 50

  Global unique payment identifier that comprises a 4-character prefix and random digits.
• PaymentTrackingData: string
  Title: Primary Payment Tracking Data

  Maximum Length: 50

  The identifying attribute passed during checkout by the originator of the assessed fees.
• PaymentTrackingDataPlus: string
  Title: Secondary Payment Tracking Data

  Maximum Length: 50

  The additional identifying attribute passed during checkout by the originator of the assessed fees.
• PaymentTransactionId: string
  Title: Payment Transaction ID

  Maximum Length: 50

  Transaction ID/reference number received from the payment gateway or trust account system.
• PrimaryId: string
  Title: Primary ID

  Maximum Length: 3

  The unique identifier for the primary document used to identify the payer of a cash drawer check payment.
• SecondaryId: string
  Title: Secondary ID

  Maximum Length: 3

  The unique identifier for the secondary document used to identify the payer of a cash drawer check payment.
• SecondResponseMessage: string
  Title: Secondary Response Message

  Maximum Length: 100

  Second part of the response message returned by the payment gateway or a free form message entered by agency staff for cash drawer or trust account.
• SessionId: string
  Title: Session ID

  Maximum Length: 50

  The unique identifier for the cashier session.
• ThirdResponseMessage: string
  Title: Additional Response Message

  Maximum Length: 100

  Third part of the response message returned by the payment gateway or a free form message entered by agency staff for cash drawer or trust account.
• TotalTendAmount: number
  Title: Amount Tendered

  The total amount of money received in payment from the payer. If this amount is more than the amount due, the difference is handed back to the payer.

{
    "type":"object",
    "properties":{
        "PaymentTransactionId":{
            "title":"Payment Transaction ID",
            "maxLength":50,
            "type":"string",
            "description":"Transaction ID/reference number received from the payment gateway or trust account system.",
            "nullable":false,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":100,
            "type":"string",
            "description":"Description provided for the payment.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"Identifies the identifier associated with an agency.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "AuthorizationDttm":{
            "title":"Authorization Date and Time",
            "type":"string",
            "description":"Authorization date and time returned by payment gateway system or trust account system.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "CashierId":{
            "title":"Cashier ID",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the cashier.",
            "nullable":true,
            "x-queryable":true
        },
        "PayerAddress":{
            "title":"Payer Address",
            "maxLength":240,
            "type":"string",
            "description":"The address of the person who made the payment.",
            "nullable":true,
            "x-queryable":true
        },
        "SecondResponseMessage":{
            "title":"Secondary Response Message",
            "maxLength":100,
            "type":"string",
            "description":"Second part of the response message returned by the payment gateway or a free form message entered by agency staff for cash drawer or trust account.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentCurrency":{
            "title":"Currency",
            "maxLength":3,
            "type":"string",
            "description":"Currency used for the payment transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentReferenceId":{
            "title":"Payment Reference ID",
            "maxLength":50,
            "type":"string",
            "description":"Global unique payment identifier that comprises a 4-character prefix and random digits.",
            "nullable":false,
            "x-queryable":true
        },
        "AuthorizationStatus":{
            "maxLength":4,
            "type":"string",
            "description":"The status value returned by the payment gateway or trust account system.",
            "nullable":false,
            "x-queryable":true
        },
        "DrawerId":{
            "title":"Cash Drawer ID",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the cash drawer.",
            "nullable":true,
            "x-queryable":true
        },
        "CheckoutPmtId":{
            "type":"integer",
            "description":"Unique sequence number for the checkout payment row generated using the Fusion unique ID API.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SecondaryId":{
            "title":"Secondary ID",
            "maxLength":3,
            "type":"string",
            "description":"The unique identifier for the secondary document used to identify the payer of a cash drawer check payment.",
            "nullable":true,
            "x-queryable":true
        },
        "TotalTendAmount":{
            "title":"Amount Tendered",
            "type":"number",
            "description":"The total amount of money received in payment from the payer. If this amount is more than the amount due, the difference is handed back to the payer.",
            "nullable":false,
            "x-queryable":true
        },
        "LineAmount":{
            "title":"Amount",
            "type":"number",
            "description":"That dollar amount that applies to a line item.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CheckDate":{
            "title":"Check Date",
            "type":"string",
            "description":"The date that the check was received from the payer.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "FirstResponseMessage":{
            "title":"Primary Response Message",
            "maxLength":100,
            "type":"string",
            "description":"First part of the response message returned by the payment gateway or a free form message entered by agency staff for cash drawer or trust account.",
            "nullable":true,
            "x-queryable":true
        },
        "SessionId":{
            "title":"Session ID",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the cashier session.",
            "nullable":true,
            "x-queryable":true
        },
        "AuthorizationCode":{
            "maxLength":10,
            "type":"string",
            "description":"Authorization code value returned by the payment gateway or trust account system.",
            "nullable":true,
            "x-queryable":true
        },
        "CheckName":{
            "maxLength":100,
            "type":"string",
            "description":"The name on the check.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentDate":{
            "title":"Payment Date",
            "type":"string",
            "description":"Date on which the payment transaction occurred.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentTrackingDataPlus":{
            "title":"Secondary Payment Tracking Data",
            "maxLength":50,
            "type":"string",
            "description":"The additional identifying attribute passed during checkout by the originator of the assessed fees.",
            "nullable":true,
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":240,
            "type":"string",
            "description":"Comments provided for the payment.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentTrackingData":{
            "title":"Primary Payment Tracking Data",
            "maxLength":50,
            "type":"string",
            "description":"The identifying attribute passed during checkout by the originator of the assessed fees.",
            "nullable":true,
            "x-queryable":true
        },
        "CheckAddress":{
            "maxLength":240,
            "type":"string",
            "description":"The address on the check.",
            "nullable":true,
            "x-queryable":true
        },
        "PayerName":{
            "title":"Payer Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the person who made the payment.",
            "nullable":true,
            "x-queryable":true
        },
        "ThirdResponseMessage":{
            "title":"Additional Response Message",
            "maxLength":100,
            "type":"string",
            "description":"Third part of the response message returned by the payment gateway or a free form message entered by agency staff for cash drawer or trust account.",
            "nullable":true,
            "x-queryable":true
        },
        "CheckNumber":{
            "title":"Check Number",
            "maxLength":10,
            "type":"string",
            "description":"The number of the check that was received from the payer.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentMethodCode":{
            "title":"Payment Method Code",
            "maxLength":30,
            "type":"string",
            "description":"Type of payment selected during checkout.",
            "nullable":false,
            "x-queryable":true
        },
        "CheckoutId":{
            "maxLength":50,
            "type":"string",
            "description":"Unique identifier for the checkout data. Generated using the Fusion unique ID API.",
            "nullable":false,
            "x-queryable":true
        },
        "ChangeAmount":{
            "title":"Change Due",
            "type":"number",
            "description":"The amount of money to be handed back to the payer if the payment received from the payer is more than the amount due.",
            "nullable":false,
            "x-queryable":true
        },
        "PrimaryId":{
            "title":"Primary ID",
            "maxLength":3,
            "type":"string",
            "description":"The unique identifier for the primary document used to identify the payer of a cash drawer check payment.",
            "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