Update an allocation payment

{
  "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": "Ada Lovelace",
    "first_name": "Ada",
    "last_name": "Lovelace",
    "email": "ada.lovelace@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": 422,
  "errors": {}
}

{
  "message": "<string>",
  "status_code": 429
}

{
  "status": "Maintenance in progress"
}

PUT

allocation-payment

{allocation_payment_slug}

{
  "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": "Ada Lovelace",
    "first_name": "Ada",
    "last_name": "Lovelace",
    "email": "ada.lovelace@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": 422,
  "errors": {}
}

{
  "message": "<string>",
  "status_code": 429
}

{
  "status": "Maintenance in progress"
}

Authorizations

x-api-key

string

header

required

API key used to authenticate and authorise every request. Include it in the x-api-key header.

Headers

enum<string>

required

Defines the response type.

Available options:

application/vnd.Creative Force.v2.3+json,

application/vnd.Creative Force.v2.3+xml

x-api-language

enum<string>[]

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.

Available options:

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

allocation_payment_slug

string

required

Slug of the allocation payment.

Pattern: ^[A-Za-z]{8}$

Body

application/json

Allocation payment update payload.

amount

number

Amount of the payment, in the currency of the allocation's fund.

Cannot exceed the allocation's unscheduled balance, with the payment's current amount added back.

date_due

string | null

Date the payment is due.

Accepts Y-m-d or Y-m-d\TH:i:s\Z format.

date_paid

string | null

Date the payment was made.

Accepts Y-m-d or Y-m-d\TH:i:s\Z format. Required when status is paid.

external_id

string | null

External identifier of the payment, used to reconcile it with downstream systems.

Maximum string length: 255

payment_method

string | null

Slug of the payment method.

Pattern: ^[A-Za-z]{8}$

reference

string | null

Free-text reference for the payment.

Maximum string length: 32

status

enum<string>

Lifecycle status of the payment.

Available options:

failed,

failed_permanently,

paid,

processing,

scheduled

Response

Allocation payment updated.

Scheduled or recorded disbursement of funds against an allocation, the application-level grant slot drawn from a fund's budget.

Carries the payment amount and currency, its lifecycle status, the due and paid dates, and references to the related allocation, fund, season, payment method, and grant status.

allocation

object

Allocation the payment is drawn against.

Show child attributes

amount

number

Amount of the payment, in the fund's currency.

comments

string

Comment log attached to the payment, rendered as a newline-joined export string of author (timestamp): body items. Empty string when the payment has no comments.

created

string<date-time>

Date and time when the payment was created.

currency

string

ISO 4217 currency code of the payment's amounts, drawn from the fund's currency.

date_due

string<date-time> | null

Date and time when the payment is due. null when no due date is set.

date_paid

string<date-time> | null

Date and time when the payment was made. null when the payment has not been made.

external_id

string

External identifier of the payment, used to reconcile it with downstream systems. Empty string when none is set.

grant_status

object | null

Grant status of the application the allocation belongs to.

null when the application has no grant status.

Show child attributes

payment_method

object | null

Payment method recorded against the payment.

null when no payment method is set.

Show child attributes

reference

string

Free-text reference for the payment. Empty string when none is set.

season

object

Season the payment belongs to.

Show child attributes

slug

string

URL-safe identifier of the payment.

status

string

Lifecycle status of the payment, returned as a localised label rendered in the account's language.

Typical English labels are Scheduled, Processing, Paid, Failed, and Failed permanently.

updated

string<date-time>

Date and time when the payment was last updated.

allocation_amount

number

Total amount of the allocation the payment is drawn against, in the fund's currency.

applicant

object | null

Applicant who owns the application the allocation belongs to.

null when the application has no applicant.

Show child attributes

application

object | null

Application the allocation belongs to.

null when the payment has no associated application.

Show child attributes

fund

object

Fund the allocation draws from.

Show child attributes

Retrieve an allocation payment Delete an allocation payment

Account

Action tasks

Allocation payments

Allocations

Applications

Applications (realtime)

Assignments

Attachments

Categories

Chapters

Contributors

Documents

Fields

Files

Forms

Funds

Grant statuses

Leaderboard

Rounds

Score sets

Seasons

Taxes

Users

Webhooks

Grant reports

Update an allocation payment

Authorizations

Headers

Path Parameters

Body

Response