Supported 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 time period. |
| 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. |
| RecurringModel | /ws/svc/readfuturepayments/:ftmParticipantID/ | Create | Service that is used to read all future payments associated with an FTM participant ID. This service optionally accepts model ID and date as query parameters for filtering. |
| ReturnPayment | /ws/svc/returnPayment/ | Create | Service used to return the payment (pacs.008). |
| RiskAuthorizationCheck | /ws/svc/performriskauthorizationchecks/ | Read | Runs a risk authorization check. It checks whether the payment or nonpayment attributes are validated against the blocking and authorization filter list in Risk. The payment and nonpayment attributes are attributes such as credit, amount, originating bank code, and account number. |
| RiskMonitorLimitsView | /ws/svc/riskmonitorlimitsviews/ | Read | Returns all risk monitors for an FTM participant, including the overall available credit and debit amounts for that FTM participant. Transaction and batch limits are also returned. |
| ScheduledPaymentModel | /ws/svc/scheduledpaymentmodel/ | Creates scheduled payment models for the following supported payment types:
Participants can use scheduled payment models to send payments at variable times. If the start date of the scheduled payment is today, the payment is sent immediately. Otherwise, the payment is sent when the scheduled payment task is run on or after the start date. |
|
| 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. |