Skip to content
YutaiDocs
GET /v1/statusGet API key

API reference / API reference

Read one claim this distributor recorded

One call of the distributor API, read from the interface description Yutai publishes. Every sample answer on this page is simulated: no real holder's data stands behind it. The formats every value travels in are the identifiers page's.

View as .md

The call

GET/v1/claims/{id}Callable today

The key presents the claims.write scope.

The parameters

id
Required. The claim's own id, the one the claim answer carried: a clm_ prefixed ULID. It sits in the call's address.

What it answers

The claim's own facts: its id, the benefit it claimed and the instant it was recorded, with its state in words - granted, or, when the benefit is one the venue credits itself, the venue credit's state (waiting on the venue, or credited once the venue confirmed), or rejected, or voided, when the grant was taken back. Nothing personal rides the answer.

  • claimId

    The claim's own opaque id, the address the claim read answers at.

    Required. A string.

  • benefitId

    The benefit the claim was recorded for, by its own opaque id.

    Required. A string.

  • benefitName

    The benefit's name as the programme carries it, so a claim reads without a second lookup.

    Required. A string. It carries at least 1 and at most 128 characters.

  • state

    Where the claim stands in plain words: whether the grant stands, was refused or taken back, or the venue's credit is still to come.

    Required. A string that is one of the values below.

    • granted
    • rejected
    • voided
    • waiting on the venue
    • credited by the venue

  • createdAt

    The instant Yutai recorded the claim and its decision.

    Required. An instant in the ISO 8601 form.

The errors

Every refused call answers one object with one field, message: the plain sentence that says what did not happen. The sentence carries 1 to 512 characters, so a refusal never carries an id, a code or an exception's text.

The errors the call for GET /v1/claims/{id} answers
StatusWhat it answers
401The key is missing, malformed, unknown, revoked or expired.
403The key does not carry the scope. The call is also refused with 403, nothing read, when the distributor is paused, suspended or closed, when the key is paused, or when the key presents from an origin it does not allow.
404No claim answers this id under this distributor's key: an unknown id, or one another distributor's key recorded. The answer is the same for both, so no claim id can be probed.
429The key made too many calls this minute. The Retry-After header names the seconds until the next window opens. Nothing was read.
500The read failed inside Yutai. Nothing was changed.