KeelsonDocs
    Judge Mode

    API reference Mandates

    Hold one cart of a multi-merchant mandate

    POST/v1/mandates/{id}/holds

    For a mandate that allows several merchants, creates the PayPal AUTHORIZE order for exactly one cart, keyed by the request id it will be countersigned under. The user approves it like a mandate hold.

    Path parameters

    idstringRequired

    Headers

    Content-Typeapplication/jsonRequired
    idempotency-keystringRequired
    Idempotency-KeystringRequired
    1 to 255 characters. A retry with the same key returns the first answer.

    Request body

    application/json

    requestIdstringRequired
    The request id the purchase is countersigned under.
    merchantstringRequired
    currencystringRequired
    amountMinorstringRequired
    The checkout total the purchase is countersigned for, tax and shipping included, in minor units.
    cartHashstringRequired
    closedMandatestringRequired
    The mandate's open mandate closed by the agent key over requestId and cartHash; it proves the caller is the mandate's agent.

    Responses

    • 201The order the buyer approves
    • 401No valid access token
    • 403The caller is not the mandate's agent
    • 404No such mandate
    • 409The mandate holds its whole budget, is not active, or the request id is already used
    • 422The cart is outside the mandate, its open cart holds with this one exceed the remaining budget, Keelson cannot capture for it, PayPal refused, or the hold would pass the hosted operator's total cap (hosted-cap)
    • 503PayPal is unavailable

    201 response

    requestIdstringRequired
    orderIdstringRequired