Skip to main content
POST
/
api
/
funder_integrations
/
Link a funder to the current broker for self-service
curl --request POST \
  --url https://app.herondata.io/api/funder_integrations/ \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "funder_heron_id": "<string>"
}
'
import requests

url = "https://app.herondata.io/api/funder_integrations/"

payload = { "funder_heron_id": "<string>" }
headers = {
"x-api-key": "<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': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({funder_heron_id: '<string>'})
};

fetch('https://app.herondata.io/api/funder_integrations/', 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://app.herondata.io/api/funder_integrations/",
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([
'funder_heron_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <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 := "https://app.herondata.io/api/funder_integrations/"

payload := strings.NewReader("{\n \"funder_heron_id\": \"<string>\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("x-api-key", "<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("https://app.herondata.io/api/funder_integrations/")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"funder_heron_id\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://app.herondata.io/api/funder_integrations/")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"funder_heron_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "funder_heron_id": "<string>",
  "funder_name": "<string>",
  "supports_staging": true,
  "config": {
    "display_name": "<string>",
    "form_fields": [
      {
        "label": "<string>",
        "name": "<string>",
        "required": true
      }
    ],
    "supports_staging": true
  },
  "funder_logo_url": "<string>",
  "production": {
    "has_credentials": true,
    "last_test_attempted_at": "2023-11-07T05:31:56Z",
    "last_test_deal_id": "<string>",
    "last_test_status_message": "<string>"
  },
  "slug": "<string>",
  "staging": {
    "has_credentials": true,
    "last_test_attempted_at": "2023-11-07T05:31:56Z",
    "last_test_deal_id": "<string>",
    "last_test_status_message": "<string>"
  }
}

Authorizations

x-api-key
string
header
required

Body

application/json
funder_heron_id
string
required

Response

Funder linked

funder_heron_id
string
required
funder_name
string
required
state
enum<string>
required
Available options:
not_available,
not_configured,
staging_configured,
staging_tested,
live
supports_staging
boolean
required
channel_type
any | null
Available options:
api,
portal,
null
config
object | null
funder_logo_url
string | null
production
object | null
slug
string | null
staging
object | null