Scheme notices

List and retrieve scheme notices for accessible organisations.

Base URL: https://api.chargebackstop.com/v1/scheme-notices/

Authentication: Bearer token via API key.

Required abilities:

  • scheme_notices:read for GET endpoints

Access scope model:

  • Organisation-level keys can access scheme notices for their own organisation only.

  • Admin partner-group keys can access scheme notices across all organisations for their partner.

  • Non-admin partner-group keys can access scheme notices only for organisations assigned to their group.


GET /v1/scheme-notices - list scheme notices

Returns a paginated list of scheme notices accessible to the authenticated key.

API level: Organisation-level and partner-level Authentication: scheme_notices:read

Query parameters

Parameter
Type
Description

scheme_notice_type

string

Filter by notice type: TC15, TC40, SAFE

organisation_id

string

Filter by organisation ID

merchant_id

string

Filter by merchant ID

reported_at_gte

datetime

Include scheme notices reported at or after this timestamp (ISO 8601, inclusive)

reported_at_lte

datetime

Include scheme notices reported at or before this timestamp (ISO 8601, inclusive)

sort

string

Sort field: -reported_at (default), reported_at

limit

integer

Number of results per page

offset

integer

Number of results to skip

Important behaviour

  • If both reported_at_gte and reported_at_lte are sent, reported_at_gte must be less than or equal to reported_at_lte.

  • Default sort order is newest reported notice first (-reported_at).

Example 1 request

Example 1 response


GET /v1/scheme-notices/{scheme_notice_id} - get scheme notice by ID

Returns one scheme notice if it is visible to the authenticated key.

API level: Organisation-level and partner-level Authentication: scheme_notices:read

URL parameters

Parameter
Type
Description

scheme_notice_id

string

Scheme notice ID

Important behaviour

  • The same access rules as list scheme notices apply.

  • Detail responses include raw/source metadata fields that are not present in the list response.

  • Non-existent scheme notices return 404 Not found.

Example 2 request

Example 2 response


Common error responses

Error responses use this shape:

Example 3 response - 401 unauthorised

Example 4 response - 403 forbidden

Example 5 response - 404 not found

Example 6 response - 422 invalid date range

Last updated

Was this helpful?