Create a recurring gift for a church giving link
curl --request POST \
--url http://localhost:3001/api/v1/business/links/{id}/recurring \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--data '
{
"paymentLinkId": "a1b2c3d4-...",
"donorName": "Jane Doe",
"donorEmail": "jane@example.com",
"frequency": "monthly",
"amount": 50,
"paymentMethodId": "pm_1abc2def3ghi",
"memberId": "MEM-001",
"dayOfWeek": 0,
"dayOfMonth": 15,
"currency": "USD",
"category": "tithe"
}
'import requests
url = "http://localhost:3001/api/v1/business/links/{id}/recurring"
payload = {
"paymentLinkId": "a1b2c3d4-...",
"donorName": "Jane Doe",
"donorEmail": "jane@example.com",
"frequency": "monthly",
"amount": 50,
"paymentMethodId": "pm_1abc2def3ghi",
"memberId": "MEM-001",
"dayOfWeek": 0,
"dayOfMonth": 15,
"currency": "USD",
"category": "tithe"
}
headers = {
"x-api-key": "<x-api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
paymentLinkId: 'a1b2c3d4-...',
donorName: 'Jane Doe',
donorEmail: 'jane@example.com',
frequency: 'monthly',
amount: 50,
paymentMethodId: 'pm_1abc2def3ghi',
memberId: 'MEM-001',
dayOfWeek: 0,
dayOfMonth: 15,
currency: 'USD',
category: 'tithe'
})
};
fetch('http://localhost:3001/api/v1/business/links/{id}/recurring', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3001",
CURLOPT_URL => "http://localhost:3001/api/v1/business/links/{id}/recurring",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'paymentLinkId' => 'a1b2c3d4-...',
'donorName' => 'Jane Doe',
'donorEmail' => 'jane@example.com',
'frequency' => 'monthly',
'amount' => 50,
'paymentMethodId' => 'pm_1abc2def3ghi',
'memberId' => 'MEM-001',
'dayOfWeek' => 0,
'dayOfMonth' => 15,
'currency' => 'USD',
'category' => 'tithe'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <x-api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:3001/api/v1/business/links/{id}/recurring"
payload := strings.NewReader("{\n \"paymentLinkId\": \"a1b2c3d4-...\",\n \"donorName\": \"Jane Doe\",\n \"donorEmail\": \"jane@example.com\",\n \"frequency\": \"monthly\",\n \"amount\": 50,\n \"paymentMethodId\": \"pm_1abc2def3ghi\",\n \"memberId\": \"MEM-001\",\n \"dayOfWeek\": 0,\n \"dayOfMonth\": 15,\n \"currency\": \"USD\",\n \"category\": \"tithe\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<x-api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:3001/api/v1/business/links/{id}/recurring")
.header("x-api-key", "<x-api-key>")
.header("Content-Type", "application/json")
.body("{\n \"paymentLinkId\": \"a1b2c3d4-...\",\n \"donorName\": \"Jane Doe\",\n \"donorEmail\": \"jane@example.com\",\n \"frequency\": \"monthly\",\n \"amount\": 50,\n \"paymentMethodId\": \"pm_1abc2def3ghi\",\n \"memberId\": \"MEM-001\",\n \"dayOfWeek\": 0,\n \"dayOfMonth\": 15,\n \"currency\": \"USD\",\n \"category\": \"tithe\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3001/api/v1/business/links/{id}/recurring")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"paymentLinkId\": \"a1b2c3d4-...\",\n \"donorName\": \"Jane Doe\",\n \"donorEmail\": \"jane@example.com\",\n \"frequency\": \"monthly\",\n \"amount\": 50,\n \"paymentMethodId\": \"pm_1abc2def3ghi\",\n \"memberId\": \"MEM-001\",\n \"dayOfWeek\": 0,\n \"dayOfMonth\": 15,\n \"currency\": \"USD\",\n \"category\": \"tithe\"\n}"
response = http.request(request)
puts response.read_body{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "email must be an email",
"statusCode": 400,
"errors": {}
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "email must be an email",
"statusCode": 400,
"errors": {}
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "email must be an email",
"statusCode": 400,
"errors": {}
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "email must be an email",
"statusCode": 400,
"errors": {}
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "email must be an email",
"statusCode": 400,
"errors": {}
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "email must be an email",
"statusCode": 400,
"errors": {}
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "email must be an email",
"statusCode": 400,
"errors": {}
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "email must be an email",
"statusCode": 400,
"errors": {}
}
}Payment Links
Create a recurring gift for a church giving link
POST
/
api
/
v1
/
business
/
links
/
{id}
/
recurring
Create a recurring gift for a church giving link
curl --request POST \
--url http://localhost:3001/api/v1/business/links/{id}/recurring \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--data '
{
"paymentLinkId": "a1b2c3d4-...",
"donorName": "Jane Doe",
"donorEmail": "jane@example.com",
"frequency": "monthly",
"amount": 50,
"paymentMethodId": "pm_1abc2def3ghi",
"memberId": "MEM-001",
"dayOfWeek": 0,
"dayOfMonth": 15,
"currency": "USD",
"category": "tithe"
}
'import requests
url = "http://localhost:3001/api/v1/business/links/{id}/recurring"
payload = {
"paymentLinkId": "a1b2c3d4-...",
"donorName": "Jane Doe",
"donorEmail": "jane@example.com",
"frequency": "monthly",
"amount": 50,
"paymentMethodId": "pm_1abc2def3ghi",
"memberId": "MEM-001",
"dayOfWeek": 0,
"dayOfMonth": 15,
"currency": "USD",
"category": "tithe"
}
headers = {
"x-api-key": "<x-api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
paymentLinkId: 'a1b2c3d4-...',
donorName: 'Jane Doe',
donorEmail: 'jane@example.com',
frequency: 'monthly',
amount: 50,
paymentMethodId: 'pm_1abc2def3ghi',
memberId: 'MEM-001',
dayOfWeek: 0,
dayOfMonth: 15,
currency: 'USD',
category: 'tithe'
})
};
fetch('http://localhost:3001/api/v1/business/links/{id}/recurring', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3001",
CURLOPT_URL => "http://localhost:3001/api/v1/business/links/{id}/recurring",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'paymentLinkId' => 'a1b2c3d4-...',
'donorName' => 'Jane Doe',
'donorEmail' => 'jane@example.com',
'frequency' => 'monthly',
'amount' => 50,
'paymentMethodId' => 'pm_1abc2def3ghi',
'memberId' => 'MEM-001',
'dayOfWeek' => 0,
'dayOfMonth' => 15,
'currency' => 'USD',
'category' => 'tithe'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <x-api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:3001/api/v1/business/links/{id}/recurring"
payload := strings.NewReader("{\n \"paymentLinkId\": \"a1b2c3d4-...\",\n \"donorName\": \"Jane Doe\",\n \"donorEmail\": \"jane@example.com\",\n \"frequency\": \"monthly\",\n \"amount\": 50,\n \"paymentMethodId\": \"pm_1abc2def3ghi\",\n \"memberId\": \"MEM-001\",\n \"dayOfWeek\": 0,\n \"dayOfMonth\": 15,\n \"currency\": \"USD\",\n \"category\": \"tithe\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<x-api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:3001/api/v1/business/links/{id}/recurring")
.header("x-api-key", "<x-api-key>")
.header("Content-Type", "application/json")
.body("{\n \"paymentLinkId\": \"a1b2c3d4-...\",\n \"donorName\": \"Jane Doe\",\n \"donorEmail\": \"jane@example.com\",\n \"frequency\": \"monthly\",\n \"amount\": 50,\n \"paymentMethodId\": \"pm_1abc2def3ghi\",\n \"memberId\": \"MEM-001\",\n \"dayOfWeek\": 0,\n \"dayOfMonth\": 15,\n \"currency\": \"USD\",\n \"category\": \"tithe\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3001/api/v1/business/links/{id}/recurring")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"paymentLinkId\": \"a1b2c3d4-...\",\n \"donorName\": \"Jane Doe\",\n \"donorEmail\": \"jane@example.com\",\n \"frequency\": \"monthly\",\n \"amount\": 50,\n \"paymentMethodId\": \"pm_1abc2def3ghi\",\n \"memberId\": \"MEM-001\",\n \"dayOfWeek\": 0,\n \"dayOfMonth\": 15,\n \"currency\": \"USD\",\n \"category\": \"tithe\"\n}"
response = http.request(request)
puts response.read_body{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "email must be an email",
"statusCode": 400,
"errors": {}
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "email must be an email",
"statusCode": 400,
"errors": {}
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "email must be an email",
"statusCode": 400,
"errors": {}
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "email must be an email",
"statusCode": 400,
"errors": {}
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "email must be an email",
"statusCode": 400,
"errors": {}
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "email must be an email",
"statusCode": 400,
"errors": {}
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "email must be an email",
"statusCode": 400,
"errors": {}
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "email must be an email",
"statusCode": 400,
"errors": {}
}
}Headers
Path Parameters
Body
application/json
Payment link ID (church link)
Example:
"a1b2c3d4-..."
Donor full name
Example:
"Jane Doe"
Donor email address
Example:
"jane@example.com"
Giving frequency
Available options:
weekly, biweekly, first_and_fifteenth, monthly Example:
"monthly"
Gift amount (minimum $1)
Example:
50
Payment method ID for the saved card
Example:
"pm_1abc2def3ghi"
Church member ID
Example:
"MEM-001"
Day of week (0=Sunday, 6=Saturday) — used for weekly frequency
Example:
0
Day of month (1-28) — used for monthly frequency
Example:
15
Currency code (default: USD)
Example:
"USD"
Giving category (tithe, offering, etc.)
Example:
"tithe"
⌘I
