API Reference

Realtime Transfer

OBJECT
Realtime transfer object

Represents the current state of a realtime transfer via FedNow or RTP.

OBJECT
Realtime RFP object

Represents the current state of a realtime request for payment (RFP).

OBJECT
Realtime return request object

A request to return funds from a previously completed realtime transfer.

GET
List all realtime transfers

List all realtime transfers under your platform.

POST
Create a realtime transfer

Send a realtime transfer to a counterparty via RTP or FedNow.

GET
Get a realtime transfer

Retrieve a single realtime transfer by its ID.

POST
Cancel a held realtime transfer

Abort an outgoing realtime transfer in a hold state.

POST
Clear a held realtime transfer

Release the hold on a realtime transfer in a hold state.

POST
Return a realtime transfer

Return a completed realtime transfer.

POST
Create a realtime return request

Request the return of a previously completed realtime transfer.

GET
List all realtime RFPs

List all realtime requests for payment under your platform.

POST
Create a realtime RFP

Send a realtime request for payment to a counterparty.

GET
Get a realtime RFP

Retrieve a single realtime request for payment by its ID.

PATCH
Accept a realtime RFP

Accept an outstanding realtime request for payment.

PATCH
Reject a realtime RFP

Reject an outstanding realtime request for payment.

GET
List all realtime return requests

List all realtime return requests under your platform.

GET
Get a realtime return request by ID

Retrieve a single realtime return request by its ID.

PATCH
Accept a realtime return request

Accept an outstanding realtime return request.

PATCH
Reject a realtime return request

Reject an outstanding realtime return request.