POST
/
rtp_requests
curl --request POST \
  --url https://api.useswift.dev/rtp_requests \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "account_id": "account_vjb43lkAdf934jb13Df93",
  "amount": 10000,
  "rfp_registration_id": "rfp_registration_vjb43lkAdf934jb13Df93",
  "user_bank_id": "user_bank_vjb43lkAdf934jb13Df93"
}'
{
  "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"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Parameters for creating a RTP Request.

​
account_id
string
required

The ID of the Account that funds will be received into.

​
amount
integer
required

The amount of the RTP Request in USD cents.

​
rfp_registration_id
string
required

The ID of the RTP RFP Registration. This is provided by our team when your business and use case is registered with the Real-time Payments network.

​
user_bank_id
string
required

The ID of the User Bank that is being requested from.

Response

200
application/json
Real-Time Payments Request

Represents a Request for Payment over the Real-time Payments network. This transfer is between an RTP-enabled User Bank and an Account.

​
account_id
string
required

The ID of the Account that funds will be received into.

​
amount
integer
required

The amount of the Real-time Payments Request in USD cents.

​
created_at
string
required

The ISO 8601 time at which the Real-time Payments Request was created.

​
id
string
required

The Real-time Payments Request's unique identifier.

​
reason
string | null
required

The reason for error if rejected by the Real-time Payments network.

​
rfp_registration_id
string
required

The ID of the RTP RFP Registration. This is provided by our team when your business and use case is registered with the Real-time Payments network.

​
status
enum<string>
required

The current status of the Real-time Payments Request.

Available options:
pending,
fulfilled,
expired,
declined,
cancelled,
failed
​
user_bank_id
string
required

The ID of the User Bank that is being requested from.