--- title: "Retrieve allocation payments" method: GET path: "/allocation-payment" tags: ["Allocation payment"] --- # Retrieve allocation payments `GET /allocation-payment` Retrieves allocation payments. ## Query parameters - `trashed` 'only' | 'all' | 'none' - `order` 'amount' | 'created' | 'currency' | 'date_due' | 'date_paid' | 'external_id' | 'reference' | 'slug' | 'status' | 'updated' - `dir` 'asc' | 'desc' - `page` string - `per_page` string ## Headers - `Accept` 'application/vnd.Creative Force.v2.3+json' | 'application/vnd.Creative Force.v2.3+xml', required - `x-api-language` string[] ## Response `200` Allocation payments retrieved. - AllocationPaymentList — Pagination envelope returned by every list endpoint. Wraps the result set with positional fields (`current_page`, `from`, `to`, `total`) and navigation URLs (`first_page_url`, `last_page_url`, `next_page_url`, `prev_page_url`) for traversing the full list. The records themselves are returned in a sibling `data` array supplied by the wrapping schema. - `current_page` integer — Number of the page returned by this response. The first page is `1`. - `first_page_url` string, uri — URL of the first page in the result set. - `from` integer — Position of the first record on this page within the full result set. The first record is at position `1`. - `last_page` integer — Number of the last page. Equals the total number of pages. - `last_page_url` string, uri — URL of the last page in the result set. - `next_page_url` string — URL of the next page in the result set. Empty string when the current page is the last page. - `path` string, uri — Canonical URL of the endpoint, without query parameters. - `per_page` integer — Maximum number of records returned per page. - `prev_page_url` string — URL of the previous page in the result set. Empty string when the current page is the first page. - `to` integer — Position of the last record on this page within the full result set. - `total` integer — Total number of records across all pages. - `data` AllocationPaymentSummary[] - `allocation` object — Allocation the payment is drawn against. - `slug` string — URL-safe identifier of the allocation. - `link` string, uri — Canonical URL of the allocation resource. - `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` entries. 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, nullable — Date and time when the payment is due. `null` when no due date is set. - `date_paid` string, date-time, nullable — 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, nullable — Grant status of the entry the allocation belongs to. Present only when the grants feature is enabled on the account. `null` when the entry has no grant status. - `slug` string — URL-safe identifier of the grant status. - `link` string, uri — Canonical URL of the grant status resource. - `name` object — Name of the grant status. Map keyed by locale code (for example, `en_GB` or `fr_FR`). Keys are drawn from the languages enabled on the account. Values are the translated string. - `payment_method` object, nullable — Payment method recorded against the payment. `null` when no payment method is set. - `slug` string — URL-safe identifier of the payment method. - `link` string, uri — Canonical URL of the payment method resource. - `name` object — Name of the payment method. Map keyed by locale code (for example, `en_GB` or `fr_FR`). Keys are drawn from the languages enabled on the account. Values are the translated string. - `reference` string — Free-text reference for the payment. Empty string when none is set. - `season` object — Season the payment belongs to. - `slug` string — URL-safe identifier of the season. - `link` string, uri — Canonical URL of the season resource. - `name` object — Name of the season. Map keyed by locale code (for example, `en_GB` or `fr_FR`). Keys are drawn from the languages enabled on the account. Values are the translated string. - `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. ## Other responses - `400` — Request was rejected before the endpoint could process it. Common causes: invalid `Accept` header, unsupported `x-api-language` code, empty request body on `POST` / `PUT`, invalid JSON in the request body, or an invalid slug format in a path parameter. - `401` — Missing `x-api-key` header. - `403` — Authenticated request denied. Common causes: invalid or unknown API key, suspended account, or `api` feature not enabled for the account. - `429` — Rate limit of 60 requests per minute exceeded. - `503` — Service is temporarily unavailable due to regional maintenance. ## Changes - **2026-07-01** (v2) `e96a96d4507e` — 6 info - added the media type `application/xml` for the response with the status `200` - added the media type `application/xml` for the response with the status `400` - added the media type `application/xml` for the response with the status `401` - added the media type `application/xml` for the response with the status `403` - …2 more - **2026-06-30** (v2) `716dc98bb1c3` — 1 info - endpoint added [Change history](https://skmtc.dev/tectonic/apis/award-force-api/changes/allocation-payment/get.md) --- [API](https://skmtc.dev/tectonic/apis/award-force-api.md) · [All operations](https://skmtc.dev/tectonic/apis/award-force-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/tectonic/award-force-api/revisions/e96a96d4507e/schema)