​
Overview

To use the Swift API, you will need your API token provided by support and the list of payment methods that you would like to use. Your API key grants access to a subset of the following payment rails:

  • venmo
  • zelle
  • rtp

You can create a request for payment by issuing a POST request to the /rfp endpoint:

curl -X POST \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"rail": "venmo", "username": "Rakeeb-Hossain", amount: 99.12}' \
  https://api.joinswift.app/rfp

If successful, a 200 status code is returned with an object containing a payment ID:

{
    "paymentId": "..."
}

When a payment is fulfilled, a POST request is sent to your endpoint with your provided secret header. If no secret is configured, the request will be equivalent to

curl -X POST \
  -H "Content-Type: application/json"
  -d '{"paymentId": "..."}'

​
Authentication

All requests to the API should use Bearer authorization or will receive a 401 (Unauthorized). This means that the following example header should be included in all requests:

Authorization: Bearer SWIFT_API_KEY
Create User