GET
/
rfp_registrations
curl --request GET \
  --url https://api.useswift.dev/rfp_registrations \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "type": "object",
      "title": "Real-time Payments Request for Payment Registration",
      "description": "RfP Registrations are used to register for sending RfPs on the Real-time Payments network.",
      "example": {
        "id": "rfp_registration_vjb43lkAdf934jb13Df93",
        "created_at": "2024-01-31T23:59:59Z",
        "status": "pending",
        "use_case": "account_to_account"
      },
      "properties": {
        "id": {
          "oneOf": [
            {
              "type": "string",
              "description": "The RfP Registration's unique identifier."
            }
          ]
        },
        "created_at": {
          "oneOf": [
            {
              "type": "string",
              "format": "date-time",
              "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the RfP Registration was created."
            }
          ]
        },
        "status": {
          "oneOf": [
            {
              "type": "string",
              "description": "The current status of the RfP Registration.",
              "enum": [
                "pending",
                "active",
                "inactive"
              ],
              "x-enum-descriptions": [
                "The RfP Registration is pending.",
                "The RfP Registration is active.",
                "The RfP Registration is inactive."
              ],
              "x-enum-varnames": [
                "rfp_registration_pending",
                "rfp_registration_active",
                "rfp_registration_inactive"
              ]
            }
          ]
        },
        "use_case": {
          "oneOf": [
            {
              "type": "string",
              "description": "The use case of the RfP Registration.",
              "enum": [
                "account_to_account",
                "business_to_business",
                "bill_pay"
              ],
              "x-enum-descriptions": [
                "Use case for transfers between asset Accounts owned by the same entity.",
                "Use case for transfers that have a business purpose for both the sender and receiver .",
                "Use case for recurring and non-recurring consumer payments to businesses."
              ],
              "x-enum-varnames": [
                "rfp_registration_use_case_account_to_account",
                "rfp_registration_use_case_business_to_business",
                "rfp_registration_use_case_bill_pay"
              ]
            }
          ]
        }
      },
      "required": [
        "id",
        "created_at",
        "status",
        "use_case"
      ],
      "x-title-plural": "RfP Registrations"
    }
  ],
  "next_cursor": "Y3Vyc29y"
}

Before going live with Request for Payments on the Real-Time Payments network, you must register your business and use case with The Clearing House. We do this for you when you onboard with us.

This endpoint returns a list of all your Request for Payment registrations, representing the list of use cases of RfP you may use.

Authorizations

​
Authorization
string
header
required

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

Response

200
application/json
Request for Payment Registrations

A list of RfP Registration objects.

​
data
object[]
required

RfP Registrations are used to register for sending RfPs on the Real-time Payments network.

​
next_cursor
string | null
required

A pointer to a place in the list.