# Revoke payment instrument

Revokes an active <a href="https://docs.solidgate.com/billing/manage-customers/payment-instruments/" target="_blank">payment instrument</a> and prevents it from being used for future payments.

Endpoint: POST /payment-instruments/revoke
Version: 2.0.0
Security: bearerAuth

## Request fields (application/json):

  - `id` (string, required)
    Unique payment instrument identifier.
    Example: pi_01J1Z2X3Y4W5V6U7T8S9R0

## Response 200 fields (application/json):

  - `payment_method` (string, required)
    Payment method.
    Example: CARD

  - `card_details` (object, required)
    Card details for a payment instrument.

  - `card_details.last_four` (string, required)
    Last four digits of the card number.
    Example: 4242

  - `card_details.bin` (string, required)
    Bank identification number of the card.
    Example: 424242

  - `card_details.brand` (string, required)
    Card brand.
    Example: VISA

  - `card_details.type` (string, required)
    Card type.
    Example: DEBIT

  - `card_details.bank` (string, required)
    Issuing bank name.
    Example: Chase Bank

  - `card_details.expiry_month` (string, required)
    Card expiration month in MM format.
    Example: 12

  - `card_details.expiry_year` (string, required)
    Card expiration year in YYYY format.
    Example: 2030

  - `paypal_details` (object, required)
    PayPal details for a payment instrument.

  - `paypal_details.email` (string, required)
    PayPal account email.
    Example: customer@example.com

## Response 400 fields (application/json):

  - `code` (string, required)
    Code identifying the error type.
    Enum: "VALIDATION"

  - `message` (string, required)
    Message describing the error.
    Example: One or more fields failed validation due to constraints

  - `context` (object, required)
    Additional context about the validation error, including specific constraints.
    Example: {"constraints":{"email":{"type":"TYPE","message":"The 'email' field must be a valid email address"},"age":{"type":"MIN","message":"The 'age' field must be a number greater than or equal to 18"}}}

## Response 401 fields (application/json):

  - `code` (string, required)
    Code identifying the error type.
    Enum: "UNAUTHENTICATED"

  - `message` (string, required)
    Message describing the error.
    Example: Credentials are invalid or missing

## Response 403 fields (application/json):

  - `code` (string, required)
    Code identifying the error type.
    Enum: "PERMISSION_DENIED"

  - `message` (string, required)
    Message describing the error.
    Example: Permission denied

## Response 404 fields (application/json):

  - `code` (string, required)
    Code identifying the error type.
    Enum: "NOT_FOUND"

  - `message` (string, required)
    Message describing the error. The entity varies by endpoint.
    Example: The requested resource could not be found

## Response 422 fields (application/json):

  - `code` (string, required)
    Code identifying the error type.
    Enum: "INCOMPATIBLE_STATUS"

  - `message` (string, required)
    Message describing the error.
    Example: The request conflicts with the current state

## Response 429 fields (application/json):

  - `code` (string, required)
    Code identifying the error type.
    Enum: "RATE_LIMIT"

  - `message` (string, required)
    Message describing the error.
    Example: Rate limit exhausted

  - `context` (object)
    Additional context about the error.

  - `context.next_try_at` (string)
    Timestamp indicating when to retry the request.
    Example: 2024-12-31T23:59:59.000000Z