Create a third party payment methods
post
/fscmRestApi/resources/11.13.18.05/publicSectorThirdPartyPayments
Request
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
Identifies the agency id associated with a payment. -
ExternalPaymentReference(required): string
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(required): number
Identifies the total amount received as payment.
-
PaymentCurrency(required): string
Maximum Length:
3
Identifies the currency of the payment. -
PaymentDatetime(required): string
(date-time)
Identifies the UTC date time provided by third party payment system.
-
PaymentHeaderId(required): string
Maximum Length:
50
Identifies the unique alpha numeric reference of the payment. -
PaymentHeaderKey: integer
(int64)
Identifies the primary key value of the payment.
-
PaymentNotes: string
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
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(required): number
Identifies the total amount voided for the payment.
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
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
Nested Schema : publicSectorThirdPartyPayments-ThirdPartyPaymentLine-item-post-request
Type:
Show Source
object
-
AgencyId: integer
(int32)
Identifies the agency id associated with a payment.
-
Classification: string
Maximum Length:
3
Identifies the classification for the transaction record. -
ExternalPaymentReference: string
Maximum Length:
480
Identifies the payment reference provided by third party payment system. -
ItemAmount: number
Identifies the item amount received as payment line record.
-
ItemAmountVoid: number
Identifies the item amount voided.
-
ItemCurrency: string
Maximum Length:
3
Identifies the currency of the fee. -
ItemGroupId: string
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
Identifies the item unit price associated to a payment line record.
-
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.
-
PaymentLineKey: integer
(int64)
Identifies the primary key value of the fee line.
-
SearchId: string
Maximum Length:
50
Identifies the search id associated with a payment line record. -
TransactionRecordId: string
Maximum Length:
50
Identifies the unique alpha numeric value of the transaction record. -
TransactionRecordKey: integer
(int64)
Identifies the primary key of the transaction record.
Nested Schema : publicSectorThirdPartyPayments-ThirdPartyPaymentMethod-item-post-request
Type:
Show Source
object
-
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. -
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.
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.
Root Schema : publicSectorThirdPartyPayments-item-response
Type:
Show Source
object
-
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. -
OnaccountFlag: string
Maximum Length:
1
Default Value:N
Identifies the payment as an account payment without fee records. -
PaymentAmountTotal: number
Identifies the total amount received as payment.
-
PaymentCurrency: string
Maximum Length:
3
Identifies the currency of the payment. -
PaymentDatetime: string
(date-time)
Identifies the UTC date time provided by third party payment system.
-
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.
-
PaymentNotes: string
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
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
Identifies the total amount voided for the payment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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
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
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : publicSectorThirdPartyPayments-ThirdPartyPaymentLine-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Identifies the agency id associated with a payment.
-
Classification: string
Maximum Length:
3
Identifies the classification for the transaction record. -
ExternalPaymentReference: string
Maximum Length:
480
Identifies the payment reference provided by third party payment system. -
ItemAmount: number
Identifies the item amount received as payment line record.
-
ItemAmountVoid: number
Identifies the item amount voided.
-
ItemCurrency: string
Maximum Length:
3
Identifies the currency of the fee. -
ItemGroupId: string
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
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
Maximum Length:
50
Identifies the unique alpha numeric reference of the payment. -
PaymentHeaderKey: integer
(int64)
Identifies the primary key value of the payment.
-
PaymentLineKey: integer
(int64)
Identifies the primary key value of the fee line.
-
SearchId: string
Maximum Length:
50
Identifies the search id associated with a payment line record. -
TransactionRecordId: string
Maximum Length:
50
Identifies the unique alpha numeric value of the transaction record. -
TransactionRecordKey: integer
(int64)
Identifies the primary key of the transaction record.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorThirdPartyPayments-ThirdPartyPaymentMethod-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- ThirdPartyPaymentLine
-
Parameters:
- PaymentHeaderKey:
$request.path.PaymentHeaderKey
The third party payment lines resource is used to view or create third party payment records. - PaymentHeaderKey:
- ThirdPartyPaymentMethod
-
Parameters:
- PaymentHeaderKey:
$request.path.PaymentHeaderKey
The third party payment methods resource is used to view or create third party payment records. - PaymentHeaderKey: