KeelsonDocs
    Judge Mode

    API reference Mandates

    Get a mandate

    GET/v1/mandates/{id}

    Renders the card of the signed mandate. The user answered for every field when signing, so fields that were ambiguous at compile time show with the colors the engine enforces, not gray.

    Path parameters

    idstringRequired

    Responses

    • 200The mandate
    • 401Not signed in
    • 404No such mandate for this user

    200 response

    idstringRequired
    statestringRequired
    One of DRAFTCOMPILEDSIGNEDHOLD_PENDINGACTIVEEXHAUSTEDEXPIREDREVOKED
    railstringRequired
    card when each purchase is paid with its own single-use card.One of paypalcard
    mandateHashstringRequired
    budgetobjectRequired
    The mandate's budget and what is left of it, in minor units.
    expiresAtstringRequired
    holdone ofRequired
    The PayPal hold of the mandate's budget, once its order exists.
    cardone ofRequired
    The card rendered from the stored payload, before any checkout evidence.
    purchasesarray of objectRequired
    The mandate's latest 100 purchases, newest first.
    pendingHoldsarray of objectRequired
    Purchase holds of a several-store mandate still waiting for the buyer's PayPal approval, oldest first. Later changes arrive as mandate.purchase_hold events.