curl --request GET \
--url https://api.us.cr4ce.com/allocation-payment/{allocation_payment_slug} \
--header 'Accept: <accept>' \
--header 'x-api-key: <api-key>'import requests
url = "https://api.us.cr4ce.com/allocation-payment/{allocation_payment_slug}"
headers = {
"Accept": "<accept>",
"x-api-key": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Accept: '<accept>', 'x-api-key': '<api-key>'}};
fetch('https://api.us.cr4ce.com/allocation-payment/{allocation_payment_slug}', 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.us.cr4ce.com/allocation-payment/{allocation_payment_slug}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Accept: <accept>",
"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"
"net/http"
"io"
)
func main() {
url := "https://api.us.cr4ce.com/allocation-payment/{allocation_payment_slug}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Accept", "<accept>")
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.us.cr4ce.com/allocation-payment/{allocation_payment_slug}")
.header("Accept", "<accept>")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.us.cr4ce.com/allocation-payment/{allocation_payment_slug}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Accept"] = '<accept>'
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"allocation": {
"slug": "NqqplzPl",
"link": "https://api.au.cr4ce.com/allocation/NqqplzPl"
},
"allocation_amount": 500,
"amount": 280.65,
"comments": "",
"created": "2024-03-19T14:00:25Z",
"currency": "GBP",
"date_due": null,
"date_paid": null,
"applicant": {
"slug": "AbCdEfGh",
"link": "https://api.au.cr4ce.com/user/AbCdEfGh",
"name": "Jane Doe",
"first_name": "Jane",
"last_name": "Doe",
"email": "jane.doe@example.com",
"global_id": "9c78dcbc-53cf-42f1-b5b3-82fe396f66e6"
},
"application": {
"slug": "PqRsTuVw",
"id": 4821,
"title": "Project title",
"link": "https://api.au.cr4ce.com/application/PqRsTuVw"
},
"external_id": "",
"fund": {
"slug": "PVzOmlXO",
"link": "https://api.au.cr4ce.com/fund/PVzOmlXO",
"name": {
"en_GB": "Maintenance"
}
},
"grant_status": null,
"payment_method": null,
"reference": "",
"season": {
"slug": "wboyrBmo",
"link": "https://api.au.cr4ce.com/season/wboyrBmo",
"name": {
"en_GB": "2026"
}
},
"slug": "oQKEeNDy",
"status": "Scheduled",
"updated": "2024-03-19T14:00:35Z"
}{
"message": "<string>",
"status_code": 400
}{
"message": "<string>",
"status_code": 401
}{
"message": "<string>",
"status_code": 403
}{
"message": "<string>",
"status_code": 404
}{
"message": "<string>",
"status_code": 429
}{
"status": "Maintenance in progress"
}Get allocation payment
Get the allocation payment identified by the specified slug.
curl --request GET \
--url https://api.us.cr4ce.com/allocation-payment/{allocation_payment_slug} \
--header 'Accept: <accept>' \
--header 'x-api-key: <api-key>'import requests
url = "https://api.us.cr4ce.com/allocation-payment/{allocation_payment_slug}"
headers = {
"Accept": "<accept>",
"x-api-key": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Accept: '<accept>', 'x-api-key': '<api-key>'}};
fetch('https://api.us.cr4ce.com/allocation-payment/{allocation_payment_slug}', 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.us.cr4ce.com/allocation-payment/{allocation_payment_slug}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Accept: <accept>",
"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"
"net/http"
"io"
)
func main() {
url := "https://api.us.cr4ce.com/allocation-payment/{allocation_payment_slug}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Accept", "<accept>")
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.us.cr4ce.com/allocation-payment/{allocation_payment_slug}")
.header("Accept", "<accept>")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.us.cr4ce.com/allocation-payment/{allocation_payment_slug}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Accept"] = '<accept>'
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"allocation": {
"slug": "NqqplzPl",
"link": "https://api.au.cr4ce.com/allocation/NqqplzPl"
},
"allocation_amount": 500,
"amount": 280.65,
"comments": "",
"created": "2024-03-19T14:00:25Z",
"currency": "GBP",
"date_due": null,
"date_paid": null,
"applicant": {
"slug": "AbCdEfGh",
"link": "https://api.au.cr4ce.com/user/AbCdEfGh",
"name": "Jane Doe",
"first_name": "Jane",
"last_name": "Doe",
"email": "jane.doe@example.com",
"global_id": "9c78dcbc-53cf-42f1-b5b3-82fe396f66e6"
},
"application": {
"slug": "PqRsTuVw",
"id": 4821,
"title": "Project title",
"link": "https://api.au.cr4ce.com/application/PqRsTuVw"
},
"external_id": "",
"fund": {
"slug": "PVzOmlXO",
"link": "https://api.au.cr4ce.com/fund/PVzOmlXO",
"name": {
"en_GB": "Maintenance"
}
},
"grant_status": null,
"payment_method": null,
"reference": "",
"season": {
"slug": "wboyrBmo",
"link": "https://api.au.cr4ce.com/season/wboyrBmo",
"name": {
"en_GB": "2026"
}
},
"slug": "oQKEeNDy",
"status": "Scheduled",
"updated": "2024-03-19T14:00:35Z"
}{
"message": "<string>",
"status_code": 400
}{
"message": "<string>",
"status_code": 401
}{
"message": "<string>",
"status_code": 403
}{
"message": "<string>",
"status_code": 404
}{
"message": "<string>",
"status_code": 429
}{
"status": "Maintenance in progress"
}Authorizations
API key used to authenticate and authorise every request.
Include it in the x-api-key header.
Headers
Defines the response type.
application/vnd.Creative Force.v2.3+json, application/vnd.Creative Force.v2.3+xml Defines the languages included in the response. If non are provided, the account default language is returned.
Value all overrides any other values present.
You can request multiple languages using a comma-separated string of languages.
The selected language must be supported by your account or a 400 error is returned.
all, ar_AR, bg_BG, bn_IN, ca_ES, cs_CZ, cy_GB, da_DK, de_DE, en_GB, en_US, el_GR, es_NN, es_LA, et_EE, fa_NN, fi_FI, fr_FR, fr_CA, he_IL, hi_IN, hr_HR, hu_HU, hy_AM, it_IT, ja_JP, ko_KR, lt_LT, ms_MY, nl_NL, nb_NO, pl_PL, pt_BR, ro_RO, ru_RU, sk_SK, sl_SI, sq_AL, sr_RS, sv_SE, sw_NN, th_TH, tr_TR, uk_UA, vi_VN, zh_CN, zh_HK Path Parameters
Slug of the allocation payment.
^[A-Za-z]{8}$Response
Allocation payment retrieved.
Scheduled or recorded disbursement of funds against an allocation.
Allocation the payment is drawn against.
Show child attributes
Show child attributes
Amount of the payment, in the fund's currency.
Comment log attached to the payment, formatted as newline-joined author (timestamp): body entries, empty when there are none.
Date and time when the payment was created.
ISO 4217 currency code of the payment's amounts, drawn from the fund's currency.
Date and time when the payment is due, null if not set.
Date and time when the payment was made, null if not yet paid.
External identifier of the payment, used to reconcile with downstream systems, empty when none is set.
Grant status of the application, null when there is none.
Show child attributes
Show child attributes
Payment method recorded against the payment, null when none is set.
Show child attributes
Show child attributes
Free-text reference for the payment, empty when none is set.
Season the payment belongs to.
Show child attributes
Show child attributes
URL-safe identifier of the payment.
Lifecycle status of the payment, returned as a localised label such as Scheduled, Processing, Paid, Failed, or Failed permanently.
Date and time when the payment was last updated.
Total amount of the allocation the payment is drawn against, in the fund's currency.
Applicant who owns the application, null when there is none.
Show child attributes
Show child attributes
Application the allocation belongs to, null when there is none.
Show child attributes
Show child attributes
Fund the allocation draws from.
Show child attributes
Show child attributes