Quickstart

First, for each user in your application, register them with the Create User API. The ID corresponding to this user should be stored in your database to fetch their user object at a later time.

Once the user is created, you can connect an account to the user corresponding to the deposit method you want to use. For RTP and FedNow, you can link a user bank account with the Link Bank Account API.

We will assume that we are using an RTP RfP for the deposit, as other flows are similar. After connecting the user bank, you may issue an RTP RfP with the Create a Real-Time Payments Request for Payment API with the user’s bank account as the RfP recipient and the account you want to deposit the funds into as the sender. The user will then receive a notification from their bank asking them to approve the payment.

Once the RfP is approved, a rtp_request.updated event will be sent to the event subscription you’ve registered. The RfP will be in the completed state. This means the amount has deposited in your Swift account and the user is good for the funds.

To enable an end-to-end instant flow, you can then send an RTP push payment to your external operating account. Alternatively, a FedWire will be sent overnight to your operating account on file.