Jump to

• Request
• Response

Update a third party payment methods

patch

/fscmRestApi/resources/11.13.18.05/publicSectorThirdPartyPayments/{PaymentHeaderKey}/child/ThirdPartyPaymentMethod/{PaymentMethodKey}

Request

Path Parameters

• PaymentHeaderKey(required): integer(int64)
  Identifies the primary key value of the payment.
• PaymentMethodKey(required): integer(int64)
  Identifies payment method key for a record.

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)
  Default Value: 1

  Identifies the agency id associated with a payment.
• PayerAddress: string
  Maximum Length: 2000

  Identifies the address associated with the payment instrument.
• PayerEmail: string
  Maximum Length: 480

  Identifies the email associated with the payment instrument.
• PayerName: string
  Maximum Length: 480

  Identifies the name associated with the payment instrument.
• PaymentAmount: number
  Identifies the amount received.
• PaymentCreated: string
  Maximum Length: 30

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

  Identifies the payment currency.
• PaymentHistoryKey: integer (int64)
  The unique identifier for the payment transaction.
• PaymentReferenceId: string
  Maximum Length: 50

  A reference value created by the payment module and sent as pass-through data to the payment processor.
• PaymentStatus: string
  Maximum Length: 30

  Identifies the payment status for a record.
• PaymentTransactionId: string
  Maximum Length: 50

  Identifies the reference number associated with the payment instrument.
• PrimaryTrackingData: string
  Maximum Length: 100

  Identifies the tracking reference associated with payment.
• SecondaryTrackingData: string
  Maximum Length: 100

  Identifies the tracking reference associated with payment.
• ServiceChargeAmount: number
  Identifies the service amount charges for a payment.
• TertiaryTrackingData: string
  Maximum Length: 100

  Identifies the tracking reference associated with payment.
• VoidAmount: number
  Identifies the void amount.
• VoidByName: string
  Maximum Length: 240

  Identifies the name who voided payment.
• VoidComments: string
  Maximum Length: 2000

  Identifies the void comments.
• VoidDatetime: string (date-time)
  Identifies the void date time.

{
    "type":"object",
    "properties":{
        "PaymentTransactionId":{
            "maxLength":50,
            "type":"string",
            "description":"Identifies the reference number associated with the payment instrument.",
            "nullable":false
        },
        "AgencyId":{
            "type":"integer",
            "description":"Identifies the agency id associated with a payment.",
            "format":"int32",
            "nullable":true,
            "default":1,
            "x-hints":{
                "precision":8
            }
        },
        "ServiceChargeAmount":{
            "type":"number",
            "description":"Identifies the service amount charges for a payment.",
            "nullable":false
        },
        "VoidByName":{
            "maxLength":240,
            "type":"string",
            "description":"Identifies the name who voided payment.",
            "nullable":true
        },
        "PrimaryTrackingData":{
            "maxLength":100,
            "type":"string",
            "description":"Identifies the tracking reference associated with payment.",
            "nullable":true
        },
        "PayerAddress":{
            "maxLength":2000,
            "type":"string",
            "description":"Identifies the address associated with the payment instrument.",
            "nullable":true
        },
        "SecondaryTrackingData":{
            "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":{
            "maxLength":480,
            "type":"string",
            "description":"Identifies the name associated with the payment instrument.",
            "nullable":true
        },
        "PayerEmail":{
            "maxLength":480,
            "type":"string",
            "description":"Identifies the email associated with the payment instrument.",
            "nullable":true
        },
        "PaymentAmount":{
            "type":"number",
            "description":"Identifies the amount received.",
            "nullable":false
        },
        "VoidComments":{
            "maxLength":2000,
            "type":"string",
            "description":"Identifies the void comments.",
            "nullable":true
        },
        "VoidAmount":{
            "type":"number",
            "description":"Identifies the void amount.",
            "nullable":false
        },
        "PaymentReferenceId":{
            "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
        },
        "PaymentHistoryKey":{
            "type":"integer",
            "description":"The unique identifier for the payment transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TertiaryTrackingData":{
            "maxLength":100,
            "type":"string",
            "description":"Identifies the tracking reference associated with payment.",
            "nullable":true
        },
        "VoidDatetime":{
            "type":"string",
            "description":"Identifies the void date time.",
            "format":"date-time",
            "nullable":true
        },
        "PaymentStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Identifies the payment status for a record.",
            "nullable":false
        },
        "PaymentCreated":{
            "maxLength":30,
            "type":"string",
            "description":"Identifies the payment created 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-ThirdPartyPaymentMethod-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Default Value: 1

  Identifies the agency id associated with a payment.
• ExternalPaymentReference: string
  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
  Maximum Length: 2000

  Identifies the address associated with the payment instrument.
• PayerEmail: string
  Maximum Length: 480

  Identifies the email associated with the payment instrument.
• PayerName: string
  Maximum Length: 480

  Identifies the name associated with the payment instrument.
• PaymentAmount: number
  Identifies the amount received.
• PaymentCreated: string
  Maximum Length: 30

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

  Identifies the payment currency.
• PaymentHeaderId: string
  Maximum Length: 50

  Identifies the unique alpha numeric reference of the payment.
• PaymentHeaderKey: integer (int64)
  Identifies the primary key value of the payment.
• PaymentHistoryKey: integer (int64)
  The unique identifier for the payment transaction.
• PaymentMethodCode: string
  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)
  Identifies payment method key for a record.
• PaymentReferenceId: string
  Maximum Length: 50

  A reference value created by the payment module and sent as pass-through data to the payment processor.
• PaymentStatus: string
  Maximum Length: 30

  Identifies the payment status for a record.
• PaymentTransactionId: string
  Maximum Length: 50

  Identifies the reference number associated with the payment instrument.
• PrimaryTrackingData: string
  Maximum Length: 100

  Identifies the tracking reference associated with payment.
• SecondaryTrackingData: string
  Maximum Length: 100

  Identifies the tracking reference associated with payment.
• ServiceChargeAmount: number
  Identifies the service amount charges for a payment.
• TertiaryTrackingData: string
  Maximum Length: 100

  Identifies the tracking reference associated with payment.
• VoidAmount: number
  Identifies the void amount.
• VoidByName: string
  Maximum Length: 240

  Identifies the name who voided payment.
• VoidComments: string
  Maximum Length: 2000

  Identifies the void comments.
• VoidDatetime: string (date-time)
  Identifies the void date time.

{
    "type":"object",
    "properties":{
        "PaymentTransactionId":{
            "maxLength":50,
            "type":"string",
            "description":"Identifies the reference number associated with the payment instrument.",
            "nullable":false,
            "x-queryable":true
        },
        "PaymentMethodKey":{
            "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,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "ServiceChargeAmount":{
            "type":"number",
            "description":"Identifies the service amount charges for a payment.",
            "nullable":false,
            "x-queryable":true
        },
        "VoidByName":{
            "maxLength":240,
            "type":"string",
            "description":"Identifies the name who voided payment.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryTrackingData":{
            "maxLength":100,
            "type":"string",
            "description":"Identifies the tracking reference associated with payment.",
            "nullable":true,
            "x-queryable":true
        },
        "PayerAddress":{
            "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":{
            "maxLength":480,
            "type":"string",
            "description":"Identifies the email associated with the payment instrument.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentAmount":{
            "type":"number",
            "description":"Identifies the amount received.",
            "nullable":false,
            "x-queryable":true
        },
        "PaymentReferenceId":{
            "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,
            "x-queryable":true
        },
        "PaymentHeaderId":{
            "maxLength":50,
            "type":"string",
            "description":"Identifies the unique alpha numeric reference of the payment.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PaymentStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Identifies the payment status for a record.",
            "nullable":false,
            "x-queryable":true
        },
        "PaymentCreated":{
            "maxLength":30,
            "type":"string",
            "description":"Identifies the payment created for a record.",
            "nullable":false,
            "x-queryable":true
        },
        "SecondaryTrackingData":{
            "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,
            "x-queryable":true
        },
        "PayerName":{
            "maxLength":480,
            "type":"string",
            "description":"Identifies the name associated with the payment instrument.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentMethodCode":{
            "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":{
            "maxLength":2000,
            "type":"string",
            "description":"Identifies the void comments.",
            "nullable":true,
            "x-queryable":true
        },
        "VoidAmount":{
            "type":"number",
            "description":"Identifies the void amount.",
            "nullable":false,
            "x-queryable":true
        },
        "PaymentHistoryKey":{
            "type":"integer",
            "description":"The unique identifier for the payment transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TertiaryTrackingData":{
            "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,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "VoidDatetime":{
            "type":"string",
            "description":"Identifies the void date time.",
            "format":"date-time",
            "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