Commitments

List recipient funding allocated from a gift

Requires bearer or API-key authentication, current organization scope and access to every selected recipient program. Gift/funding administration also follows the donations/reports permission policy. Returns rows in ID order filtered to recipient programs the caller can access. available is the remaining allocatable retained gift value; amount is the original gift amount. Reversed/released rows remain in history and have zero effective amount.

GET

admin

donations

{donation_id}

funding

List recipient funding allocated from a gift

curl --request GET \
  --url https://api.gratona.com/v1/admin/donations/{donation_id}/funding \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.gratona.com/v1/admin/donations/{donation_id}/funding"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://api.gratona.com/v1/admin/donations/{donation_id}/funding', 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.gratona.com/v1/admin/donations/{donation_id}/funding",
  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.gratona.com/v1/admin/donations/{donation_id}/funding"

	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.gratona.com/v1/admin/donations/{donation_id}/funding")

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

{
  "rows": [
    {
      "id": 123,
      "entity_id": 123,
      "recipient_name": "<string>",
      "program_id": 123,
      "funder_donor_id": 123,
      "funder_name": "<string>",
      "donation_id": 123,
      "source_type": "gift",
      "currency_code": "<string>",
      "covered_from": "2023-12-25",
      "covered_through": "2023-12-25",
      "status": "pledged",
      "display_funder": "inherit",
      "active": true,
      "created_at": "2023-11-07T05:31:56Z",
      "reversed_at": "2023-11-07T05:31:56Z",
      "ended_reason": "<string>",
      "amount": "35.00",
      "original_amount": "35.00",
      "recorded_amount": "35.00"
    }
  ],
  "available": "35.00",
  "amount": "35.00"
}

{
  "message": "Unauthorized",
  "status": "error"
}

{
  "message": "Something went wrong. Please try again.",
  "status": "error",
  "error": "invalid_request",
  "code": "DONOR_NOT_FOUND"
}

{
  "errors": {},
  "status": "error",
  "message": "The given data was invalid."
}

Authorizations

Authorization

string

header

required

Passport bearer token authentication for legacy admin sessions.

Path Parameters

donation_id

integer

required

Donation id.

Required range: x >= 1

Example:

123

Response

List recipient funding allocated from a gift response.

rows

object[]

Show child attributes

available

string

Decimal major-unit amount serialized as a string with two decimal places.

Pattern: ^-?[0-9]+[.][0-9]{2}$

Example:

"35.00"

amount

string

Decimal major-unit amount serialized as a string with two decimal places.

Pattern: ^-?[0-9]+[.][0-9]{2}$

Example:

"35.00"

List recipient funding allocated from a gift

curl --request GET \
  --url https://api.gratona.com/v1/admin/donations/{donation_id}/funding \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.gratona.com/v1/admin/donations/{donation_id}/funding"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://api.gratona.com/v1/admin/donations/{donation_id}/funding', 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.gratona.com/v1/admin/donations/{donation_id}/funding",
  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.gratona.com/v1/admin/donations/{donation_id}/funding"

	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.gratona.com/v1/admin/donations/{donation_id}/funding")

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

{
  "rows": [
    {
      "id": 123,
      "entity_id": 123,
      "recipient_name": "<string>",
      "program_id": 123,
      "funder_donor_id": 123,
      "funder_name": "<string>",
      "donation_id": 123,
      "source_type": "gift",
      "currency_code": "<string>",
      "covered_from": "2023-12-25",
      "covered_through": "2023-12-25",
      "status": "pledged",
      "display_funder": "inherit",
      "active": true,
      "created_at": "2023-11-07T05:31:56Z",
      "reversed_at": "2023-11-07T05:31:56Z",
      "ended_reason": "<string>",
      "amount": "35.00",
      "original_amount": "35.00",
      "recorded_amount": "35.00"
    }
  ],
  "available": "35.00",
  "amount": "35.00"
}

{
  "message": "Unauthorized",
  "status": "error"
}

{
  "message": "Something went wrong. Please try again.",
  "status": "error",
  "error": "invalid_request",
  "code": "DONOR_NOT_FOUND"
}

{
  "errors": {},
  "status": "error",
  "message": "The given data was invalid."
}