Update allocation payment
Update the allocation payment identified by the specified slug.
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}$Body
Allocation payment update payload.
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 the payment is due.
Accepts Y-m-d or Y-m-d\TH:i:s\Z format.
Date the payment was made.
Accepts Y-m-d or Y-m-d\TH:i:s\Z format. Required when status is paid.
External identifier of the payment, used to reconcile it with downstream systems.
255Slug of the payment method.
^[A-Za-z]{8}$Free-text reference for the payment.
32Lifecycle status of the payment.
failed, failed_permanently, paid, processing, scheduled Response
Allocation payment updated.
Scheduled or recorded disbursement of funds against an allocation.
Allocation the payment is drawn against.
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.
Payment method recorded against the payment, null when none is set.
Free-text reference for the payment, empty when none is set.
Season the payment belongs to.
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.
Application the allocation belongs to, null when there is none.
Fund the allocation draws from.