APIs for Immediate Payments TCH applications or user exits

The following APIs can be used to develop TCH client applications or user exits in FTM for Immediate Payments.

APIs for Risk Management

These APIs are installed in the install_directory/digitalpayments/v3213/RTP/sdk/lib directory. This directory contains the Java™ libraries that are needed to create a client application in Immediate Payments.

The APIs for Risk Management are shown in the following list.
  • Participant accessor APIs.
    public List<ParticipantEntityView> getParticipantDetail (String participantId, List<ParticipantExtension> extensions, DateMarker effectiveDate) throws DatabaseAccessorException;
    This method returns a list of ParticipantEntityView objects that match parameters that are passed to the method. Each ParticipantEntityView object contains a ParticipantExtension object that has risk information such as the blocking and authorization filters.
    public List<ParticipantEntityView> getParticipantDetail (String accountNumber, Short accountType, String accountBankCode, List<ParticipantExtension> extensions, DateMarker effectiveDate) throws DatabaseAccessorException;
    This method returns a list of ParticipantEntityView objects that match parameters that are passed to the method. Each ParticipantEntityView object contains a ParticipantExtension object that has risk information such as the blocking and authorization filters.
  • Risk filter APIs.
    doesMatch (boolean credit, short msgType, String currencyCode, BigDecimal amount, String companyId, String companyName, String idNumber, String sendingAccountNumber, String sendingAccountBankCode, RiskFilterMatch match);
    Determines whether the payment matches the filter. If a RiskFilterMatch object was passed to the method, all of the reasons why the payment does not match the filter are returned in that object. This method returns a boolean.
    doesMatch (boolean credit, short msgType, String currencyCode, BigDecimal amount, String companyId, String companyName, String idNumber, String sendingAccountNumber, String sendingAccountBankCode, Timestamp date, RiskFilterMatch match);
    Determines whether the payment matches the filter. If a RiskFilterMatch object was passed to the method, all of the reasons why the payment does not match the filter are returned in that object. This method returns a boolean.