KeelsonDocs
    Judge Mode

    API reference Mandates

    Authorize an approved hold

    POST/v1/mandates/{id}/hold/authorize

    Authorizes the order stored for the mandate, checks the authorization against the signed mandate (amount, currency, custom_id, payee) and moves the mandate to ACTIVE. An authorization that does not match is voided.

    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

    orderIdstringRequired

    Responses

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

    200 response

    statestringRequired
    One of ACTIVE
    authorizationIdstringRequired
    expiresAtstringRequired
    When PayPal expires the authorization, 29 days after it was created.