KeelsonDocs
    Judge Mode

    API reference Mandates

    Hold a mandate's budget

    POST/v1/mandates/{id}/hold

    Creates the PayPal AUTHORIZE order for the budget of a signed mandate, bound to the signed mandate hash by its custom_id, and moves the mandate to HOLD_PENDING. With the user's saved PayPal, PayPal authorizes the order as it creates it (approved); otherwise the buyer approves it in PayPal. While the mandate waits for approval the same order is returned; an order PayPal no longer offers is replaced.

    Path parameters

    idstringRequired

    Headers

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

    Responses

    • 200The order the buyer approves
    • 401Not signed in
    • 404No such mandate for this user
    • 409The mandate is not signed, or it holds each purchase separately
    • 422Keelson cannot capture for the mandate's merchant, PayPal refused, or the hold would pass the hosted operator's total cap (hosted-cap)
    • 503PayPal is unavailable

    200 response

    orderIdstringRequired
    statestringRequired
    One of HOLD_PENDING
    approvedbooleanRequired
    The user's saved PayPal paid the order, so PayPal shows the buyer nothing: authorize it next.