KeelsonDocs
    Judge Mode

    API reference Purchases

    A purchase

    GET/v1/purchases/{id}

    The purchase's state: its log index, its coverage and its capture once each is recorded. Readable by the mandate's owner and by the client that asked for the countersign; an app acting for a user, only for that user.

    Path parameters

    idstringRequired

    Responses

    • 200The purchase
    • 404No such purchase, or not the caller's

    200 response

    idstringRequired
    mandateIdstringRequired
    modestringRequired
    One of 2of2degradednull
    amountobjectRequired
    statestringRequired
    logIndexstring
    The leaf's index in the Alibi log.
    coverageobject
    The lockCoverage transaction of the operator's bond.
    captureobject
    The PayPal capture of the countersigned amount.
    failureobject
    The step that failed and why; nothing was captured.
    blockedarray of string
    For a DENIED cart, the mandate fields whose check failed.
    reasonsarray of object
    For a DENIED cart, each failed field with what the mandate allowed and what the cart had, as text.
    checksarray of object
    For a purchase the engine checked, each mandate field with what the mandate allowed, what the cart had and whether it held.
    cardobject
    A card purchase: its single-use card (never its number) and every authorization the card network sent it, with both legs' decision. CAPTURED once the merchant's capture settles.
    liveobject
    A purchase the buyer pays at the store's own checkout: the store's origin and the PayPal transaction id once the agent recorded it. Never covered nor captured.