Support RTR in Your Existing INTERAC Payout Integration

Required integration changes for existing INTERAC payout merchants

Update your existing INTERAC payout integration to handle Real-Time Rail (RTR) routing for payouts submitted with a bank account number.

Before You Start

  • Identify where your integration parses the Payout Response, including enum validation and any logic that uses the selected rail.
  • Locate financial institution filters that restrict account-number payouts to institutions supported by INTERAC Account Number Routing (ANR).
  • Identify the report requests and CSV parsing logic you use to reconcile payouts.

Required Changes

1. Handle the Routing Decision

Read routing_decision from the payout response. If you already consume the field, update your enum validation and rail-specific handling to accept rtr; if you have not consumed the field before, add handling for all documented values.

Preserve the exact casing of the values documented in the payout response contract. Update any validation, storage constraints, or reporting logic that assumes every payout uses INTERAC.

Continue using the Payout Notification to determine the payout's final outcome. A routing decision identifies the selected rail; a routing decision does not confirm payout success.

2. Remove Financial Institution Filtering

Remove filters based on the list of institutions supported by INTERAC ANR when you submit payouts with account_number. Submit the customer's institution number, transit number, and account number to Paramount using the existing payout request format.

Paramount selects the supported rail in this order: RTR, INTERAC ANR, then Electronic Funds Transfer (EFT). EFT routing depends on your account configuration.

Keep validation of the account-number format and required payout parameters. The filtering change applies to institution eligibility for account-number payouts; the filtering change does not remove request validation.

3. Update Payout Reporting

Use the reporting API's Report Query endpoint to retrieve payout reports.

Set query_type to 6 in the report requests you use to reconcile payouts across RTR, INTERAC, and EFT. Query type 6 includes all transactions within the requested date range, including RTR and EFT-routed payouts.

Include field 23 in response_fields to return routing_decision. Query type 6 includes the default columns automatically; use response_fields to request additional, non-default fields.

To add the routing decision to the default report columns, use:

query_type=6&response_fields=23

Paramount returns the default query type 6 columns plus field 23, which contains the routing decision. Update your CSV parser to read the additional routing-decision column and retain the selected rail for each payout.

Validation Checklist

  • Verify that enum validation accepts each routing value documented in the payout response contract, including rtr.

  • Verify that your integration uses payout notifications to determine success or rejection.

  • Verify that INTERAC ANR institution filters no longer block account-number payout submissions.

  • Verify that account-number format validation and required-parameter validation remain in place.

  • Verify that reconciliation requests use query type 6 and explicitly include field 23 in the selected response fields.

  • Verify that the report includes the default query type 6 columns plus the additional routing-decision column.

  • Verify that your CSV parser reads field 23 and reconciliation captures the routing decision for each payout.

Related


Did this page help you?