Overview
The RESTful web services provide a mechanism by which a client application can send requests to, and receive responses from, remote services. These RESTful web services provide access to Payment Feature Services.
The following figure shows a high-level overview of the RESTful web services.
The user can start a client application that either directly calls, or uses the provided SDK to call, the RESTful web services.
The following table shows the RESTful web services that are supported:
| Name | URI | Actions | Description |
|---|---|---|---|
| BatchType | /ws/svc/batchtypes/ | Read | Lists the batch types. |
| businessDate | /ws/svc/businessdates/ | Read | Lists the valid calendar business dates for a specified period of time. |
| inboundBatchInfo | /ws/svc/inboundbatchinfos/ | Read | Lists the inbound batches. |
| InboundBatchStatusChangeEvent | /ws/svc/inboundbatchstatuschangeevents/ | Read | Lists history of inbound batch status change events |
| InboundBatchSummary | /ws/svc/inboundbatchsummaries/ | Read | List inbound batch summaries. |
| InboundProcessingSummary | /ws/svc/inboundprocessingsummaries/ | Read | Lists inbound processing summaries. |
| InboundProduct | /ws/svc/inboundproducts/ | Read | Lists the inbound products. |
| InboundRejectedTransactionInfo | /ws/svc/inboundrejectedtransactioninfos/ | Read | Lists inbound rejected transactions. |
| inboundTransaction | /ws/svc/inboundtransactions/ | Read | Lists the inbound transactions. |
| inboundTransmissionInfo | /ws/svc/inboundtransmissioninfos/ | Read | Lists the inbound transmissions. |
| InboundTransmissionStatusChangeEvent | /ws/svc/inboundtransmissionstatuschangeevents/ | Read | Lists history of inbound transmission status change events |
| InboundTransmissionSummary | /ws/svc/inboundtransmissionsummaries/ | Read | Lists summaries of inbound transmissions. |
| MessageStandard | /ws/svc/messagestandards/ | Read | Lists the message standards. |
| MessageType | /ws/svc/messagetypes/ | Read | Lists the message types. |
| OutboundBatchInfo | /ws/svc/outboundbatchinfos/ | Read | Lists outbound batches |
| OutboundTransmissionInfo | /ws/svc/outboundtransmissioninfos/ | Read | Lists outbound transmissions |
| ParticipantDetails | /ws/svc/participantdetails/ | Read | Lists participant details |
| ParticipantElectronicConnections | /ws/svc/participantelectronicconnections/ | Read | Lists participant electronic connections |
| ParticipantRelationships | /ws/svc/participantrelationships/ | Read | Lists participant relationships |
| PaymentRecordType | /ws/svc/paymentrecordtypes/ | Read | Lists the payment record types. |
| TransmissionType | /ws/svc/transmissiontypes/ | Read | Lists the transmission types. |
| validationResult | /ws/svc/validationresults/ | Read | Lists the validation results that are associated with a transmission, batch, segment, or transaction. |
Data representation
The RESTful web services use requests and responses to send and receive the information. The web services responses support the JSON and XML output formats. If an attribute does not exist or has a null value, it is represented in the response body as a null value of the web service request in the RESTful web services SDK. There is no way to differentiate between values that do not exist and empty results.
Conditions
Every RESTful web service that returns results allows the returned data to be sorted and filtered and also allows only a range of the data to be retrieved.
Documentation
The methods that are provided by the SDK and how to start the RESTful web services is described in the Javadoc information.
The API reference describes the invocation, request, and response parameters of all of the RESTful web services. For more information, see Web service browser.
Configuration
The RESTful web services interface with the various user interface enterprise application (EAR) files that are deployed. These user interface applications must all be deployed in the same cluster to work with web services. In addition, the RESTful web services must be configured with the name of the cluster that the user interface EAR files are deployed to.