GET
/
rtp_requests
List Real-Time Payments Request for Payments
curl --request GET \
  --url https://api.useswift.dev/rtp_requests \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "account_id": "account_vjb43lkAdf934jb13Df93",
      "amount": 10000,
      "created_at": "2024-01-31T23:59:59Z",
      "id": "rtp_request_vjb43lkAdf934jb13Df93",
      "reason": null,
      "rfp_registration_id": "rfp_registration_vjb43lkAdf934jb13Df93",
      "status": "pending",
      "user_bank_id": "user_bank_vjb43lkAdf934jb13Df93"
    }
  ],
  "next_cursor": "Y3Vyc29y"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
cursor
string

Return the page of entries after this one.

​
limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

Required range: 1 <= x <= 100
​
status
string

Filter the list of Real-Time Payments Requests by status.

​
user_bank_id
string

Filter the list of Real-Time Payments Requests by User Bank ID.

Response

Real-Time Payments Requests

A list of RTP Request objects.

​
data
RTP Request for Payment · object[]
required
​
next_cursor
string | null
required

A pointer to a place in the list.