GET

payment_connections

List your processor keys

curl --request GET \
  --url https://api.rightfoot.com/v1/payment_connections \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.rightfoot.com/v1/payment_connections', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.rightfoot.com/v1/payment_connections",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.rightfoot.com/v1/payment_connections"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.rightfoot.com/v1/payment_connections")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "connections": [
    {
      "id": "59ed8c84-50e0-478b-a1cb-e4ff4f809582",
      "label": "Main key",
      "merchant_ref": null,
      "rail_scope": "both",
      "is_default": true,
      "key_last4": "b6a0",
      "last_poll_at": "2026-09-01T06:12:44Z",
      "access_scope": "lender_admins",
      "created_at": "2026-08-28T15:02:11Z"
    },
    {
      "id": "02623289-b33a-4d42-9e08-4a9a849c9c84",
      "label": "Nevada ACH",
      "merchant_ref": "acme-nv",
      "rail_scope": "ach",
      "is_default": false,
      "key_last4": "d2f4",
      "last_poll_at": "2026-09-01T06:12:44Z",
      "access_scope": "lender_admins",
      "created_at": "2026-08-28T15:04:37Z"
    }
  ],
  "missing_default_rails": [],
  "ingested": 128,
  "matched": 121,
  "last_poll_at": "2026-09-01T06:12:44Z"
}

{
  "status": "error",
  "status_code": 401,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid API key provided.",
    "timestamp": "2024-09-16T12:01:00Z",
    "suggestion": "Please check your API key."
  },
  "documentation_url": "https://api.rightfoot.com/docs"
}

{
  "status": "error",
  "status_code": 500,
  "error": {
    "code": "INTERNAL_SERVER_ERROR",
    "message": "An unexpected error occurred while retrieving the balances.",
    "timestamp": "2024-09-16T12:11:00Z",
    "suggestion": "Please try again later. If the problem persists, contact our support team."
  },
  "documentation_url": "https://api.rightfoot.com/docs"
}

List Processor Keys

Every processor key registered for your account, ordered defaults first and then oldest first. The response never contains a key — only key_last4, so you can tell them apart. This always returns 200. An account with no keys yet gets an empty connections list and both payment types in missing_default_rails.

Check your default coverage

missing_default_rails lists the payment types — ach, card — with no default key. Borrowers enrolled without a merchant_ref are skipped on those types until you add or promote a default. A both key covers both types, so the list is empty when you have one.

Response Fields

Field	Description
`connections`	Your keys. Each carries its `id`, `label`, `merchant_ref`, `rail_scope`, `is_default`, `key_last4`, `last_poll_at`, `access_scope` (reserved — always `lender_admins` today) and `created_at`
`missing_default_rails`	Payment types with no default key
`ingested`	Payments Rightfoot has read from your processor through your keys
`matched`	Of those, the number matched to a borrower you enrolled
`last_poll_at`	When Rightfoot last read results from any of your keys. `null` until the first read

Authorizations

Authorization

string

header

required

Authentication to the API is performed via Bearer Token Authentication. Provide your API key as the bearer token in the Authorization header.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Response

Your keys and default-key coverage.

connections

object[]

Your keys — defaults first, then oldest first.

Show child attributes

missing_default_rails

enum<string>[]

Payment types with no default key. Borrowers enrolled without a merchant_ref are skipped on these until you add or promote one. Empty when every type is covered — a both key covers both.

Available options:

card,

ach

ingested

integer

Payments Rightfoot has read from your processor through your keys.

matched

integer

Of those, the number matched to a borrower you enrolled.

last_poll_at

string<date-time> | null

The most recent read across all your keys. null until the first read.

⌘I

List your processor keys

curl --request GET \
  --url https://api.rightfoot.com/v1/payment_connections \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.rightfoot.com/v1/payment_connections', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.rightfoot.com/v1/payment_connections",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.rightfoot.com/v1/payment_connections"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.rightfoot.com/v1/payment_connections")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "connections": [
    {
      "id": "59ed8c84-50e0-478b-a1cb-e4ff4f809582",
      "label": "Main key",
      "merchant_ref": null,
      "rail_scope": "both",
      "is_default": true,
      "key_last4": "b6a0",
      "last_poll_at": "2026-09-01T06:12:44Z",
      "access_scope": "lender_admins",
      "created_at": "2026-08-28T15:02:11Z"
    },
    {
      "id": "02623289-b33a-4d42-9e08-4a9a849c9c84",
      "label": "Nevada ACH",
      "merchant_ref": "acme-nv",
      "rail_scope": "ach",
      "is_default": false,
      "key_last4": "d2f4",
      "last_poll_at": "2026-09-01T06:12:44Z",
      "access_scope": "lender_admins",
      "created_at": "2026-08-28T15:04:37Z"
    }
  ],
  "missing_default_rails": [],
  "ingested": 128,
  "matched": 121,
  "last_poll_at": "2026-09-01T06:12:44Z"
}

{
  "status": "error",
  "status_code": 401,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid API key provided.",
    "timestamp": "2024-09-16T12:01:00Z",
    "suggestion": "Please check your API key."
  },
  "documentation_url": "https://api.rightfoot.com/docs"
}

{
  "status": "error",
  "status_code": 500,
  "error": {
    "code": "INTERNAL_SERVER_ERROR",
    "message": "An unexpected error occurred while retrieving the balances.",
    "timestamp": "2024-09-16T12:11:00Z",
    "suggestion": "Please try again later. If the problem persists, contact our support team."
  },
  "documentation_url": "https://api.rightfoot.com/docs"
}

Getting Started

On Demand Balance Checks

Monitoring

Payments

Webhooks

List Processor Keys

List Processor Keys

Check your default coverage

Response Fields

Authorizations

Response

​List Processor Keys

​Check your default coverage

​Response Fields

Authorizations

Response

List Processor Keys

Check your default coverage

Response Fields