Skip to content
YutaiDocs
GET /v1/statusGet API key

API reference / API reference

List the fulfilments waiting on this distributor

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/fulfilmentsCallable today

The key presents the claims.write scope.

What it answers

The calling distributor's own pending fulfilments, newest first: each names the claim it opens beside, the benefit it credits and the instant it was opened, with the waiting state the pending row carries. Nothing personal rides the answer.

  • fulfilments

    Required. A list of objects with the fields below.

    • Each item

      Required. An object with the fields below.

      • fulfilmentId

        The fulfilment's own opaque id, the address its confirm answers at.

        Required. A string.

      • claimId

        The claim this fulfilment opens beside, by its own opaque id.

        Required. A string.

      • benefitId

        The benefit this fulfilment credits, by its own opaque id.

        Required. A string.

      • benefitName

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

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

      • state

        Where the fulfilment stands in plain words: waiting on the venue until its confirm lands, then credited by the venue.

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

        • waiting on the venue
        • credited by the venue

      • createdAt

        The instant the fulfilment was opened, the moment the credit began waiting on the venue.

        Required. An instant in the ISO 8601 form.

      • venueReference

        The venue's own reference for the credit, one to the stored maximum characters; present only once credited.

        Optional. A string. It carries at least 1 and at most 256 characters.

      • confirmedAt

        The instant the venue's confirm was recorded; present only once the row is credited by the venue.

        Optional. 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/fulfilments 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.
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.