KeelsonDocs
    Judge Mode

    API reference Mandates

    Authorize an approved cart hold

    POST/v1/mandates/{id}/holds/{requestId}/authorize

    Authorizes the order stored for the request and checks the authorization against it (amount, currency, custom_id, payee). An authorization that does not match is voided.

    Path parameters

    idstringRequired
    requestIdstringRequired

    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

    orderIdstringRequired

    Responses

    • 200The cart is held
    • 202PayPal holds the authorization as pending
    • 401Not signed in
    • 404No such hold for this user
    • 409The mandate is not active, the hold is not pending, or the order is not its order
    • 422The authorization does not match the hold, or PayPal refused
    • 503PayPal is unavailable

    200 response

    requestIdstringRequired
    statestringRequired
    One of AUTHORIZEDPENDING
    authorizationIdstringRequired