GET

payment_policy

Get your collection policy

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

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

fetch('https://api.rightfoot.com/v1/payment_policy', 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_policy",
  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_policy"

	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_policy")

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

{
  "source": "default",
  "policy": {
    "version": 1,
    "reserveCents": 5000,
    "minDebitCents": 0
  },
  "updatedAt": null
}

Get Your Collection Policy

Your collection policy applies to every borrower you enroll:

Field	What it decides
`reserveCents`	A payment fires only when the balance covers the amount owed plus this much. The reserve is never charged
`minDebitCents`	The smallest payment Rightfoot submits. A smaller amount is held with `amount_below_minimum`
`chargeOrder`	The rails your borrowers are collected on, in order. Absent means ACH alone
`fallbackOn`	Which failures move a payment to the next rail. Absent means every failure category

source is lender once you have set your own policy, and default before that. A borrower’s own settings take precedence: policy_overrides for the reserve and minimum, and their charge settings for the order.

This endpoint is camelCase (reserveCents), unlike the snake_case enrollment routes.

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

The policy in effect.

source

enum<string>

lender — the policy you set. default — you have not set one.

Available options:

default,

lender

policy

object

Your collection policy. camelCase, unlike the enrollment routes. Unknown fields are rejected.

Show child attributes

updatedAt

string<date-time> | null

When you last set your policy. null on the default.

⌘I

Get your collection policy

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

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

fetch('https://api.rightfoot.com/v1/payment_policy', 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_policy",
  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_policy"

	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_policy")

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

{
  "source": "default",
  "policy": {
    "version": 1,
    "reserveCents": 5000,
    "minDebitCents": 0
  },
  "updatedAt": null
}

Getting Started

On Demand Balance Checks

Monitoring

Payments

Webhooks

Get Your Collection Policy

Get Your Collection Policy

Authorizations

Response