Creating Transactions

Swagger UI

You can view the full API documentation in our Swagger UI. This collection provides detailed information about all available endpoints, including request and response schemas, parameters, and examples.

Check if Instant RTP Supports a Specific Route (by routing number)

Before sending an Instant RTP, a route check must be done using a Route Inquiry API to determine if the recipient is reachable via RTP.

The route check will confirm:

• If the receiving bank or account supports RTP
• What type of payments are allowed (max amount, currency, etc.)
• Whether the destination is reachable instantly

To check if Instant RTP supports a specific route, use the following endpoint:

GET /api/v3/InstantRtpRoutes/{routingNumber}

Note

routingNumber is required.

routingNumber is the routing number you want to check, essentially a nine-digit number that functions as the bank’s address. It can be obtained from the transaction details or user profile.

Add Transaction through Instant RTP

To add a transaction through Instant RTP, use the following endpoint:

POST /api/v3/InstantRtpTransactions/companycode/{companyCode}

Note

waitSeconds is the amount of seconds you’re willing to wait for the transaction to be processed. The maximum value is 300 seconds.

Request Body

{
  "name": ".L822{1{{0'{36}6?58{L8p09070,",
  "firstName": "?,.} }318L6p4`&2'4895",
  "lastName": "&L-L112'L03L1`0-}6L8994}",
  "routingNumber": "61518435",
  "accountNumber": "123-",
  "amount": 1000000,
  "yourReferenceNumber": "pwZSS64jSm"
}