This is an inbound web service invoked by remote systems on Universal Access. This service is used to transmit information about one or more payments. The schema for the payload of web service requests of this type can be found in <CURAM_DIR>\EJBServer\components\WorkspaceServices\webservices\ExternalPayment.xsd. A sample SOAP request for this web service is published in Appendix A.
This web service request can contain one or more Payments. This allows the remote system to batch up payments and send them as a single request for performance reasons. Each payment can relate to an entirely separate Universal Access account. A single payment may contain a payment breakdown. A payment breakdown may contain one or more payment line items.
A single Payment contains the following information:
- paymentID – Together with the source system, this uniquely identifies a payment.
- sourceSystem – The name of the remote system sending the request. Must match the name of a remote system configured in the system.
- citizenWorkspaceAccountID – The unique citizen workspace account id.
- cityIndustryType – Denotes the type of industry associated with the payment. The values for this element must match codes from the CityIndustry code table. Optional.
- paymentAmount – The headline value for the payment as a whole. This payment may optionally be further broken into a number of line items.
- currency – The currency in which the payment was made, contains values from the Currency code table. Optional.
- paymentMethod – The method by which the payment was made, contains values from the MethodOfDelivery code table.
- paymentStatus – The status of the payment, for example cancelled, processed, suspended etc. Contains values from PmtReconciliationStatus code table.
- effectiveDate – The effective date of the payment in the format "YYYY-MM-DD".
- coverPeriodFrom – The start date of the period covered by this payment. In the format "YYYY-MM-DD".
- coverPeriodTo – The end date of the period covered by this payment. In the format "YYYY-MM-DD".
- dueDate – The date that the payment was due to be paid. In the format "YYYY-MM-DD".
- payeeName – The name of the payee for this payment.
- payeeAddress – The address that the payment was sent to (in the case of a cheque). Optional.
- paymentReferenceNo – Uniquely identifies a payment within a given remote system.
- bankSortCode - The sort code of the bank account to which this payment is delivered.
- bankAccountNo – The bank account number to which payment is made.
- A payment may contain a Payment Breakdown (optional).
A Payment Breakdown contains one or more Payment Line Items. A Payment Line Item contains the following information:
- caseName – The human readable name of the case on the remote system with which this payment is associated.
- The case name must be localised to the locale of the client. This case name must match the case name displayed on the Contact Information page.
- caseReference – This uniquely identifies the case on a given remote system.
- componentType – This contains a code from the FinComponentType code table.
- debitAmount – The amount debited if this payment was a debit.
- creditAmount – The amount credited if this payment was a credit.
- coverPeriodFrom - The start date of the period covered by this payment. In the format "YYYY-MM-DD".
- coverPeriodTo – The end date of the period covered by this payment. In the format "YYYY-MM-DD".
It is important to note that payments can supersede previously submitted payments. For example, a payment is submitted from TestSystem with paymentID 1234. Subsequently another payment arrives from TestSystem with the same paymentID, 1234. This payment replaces the previous payment. The previous payment is physically removed along with all its related payment line items. A typical example of where this might occur is when a previously issued payment is cancelled.