Deactivate a payment method

{
  "success": true,
  "message": "Payment method deactivated successfully",
  "traceId": "0HNNN6HH5NE2S:0000000A",
  "data": {
    "paymentMethodReference": "019ff142-454b-7721-96a3-c8628b9d568f",
    "type": "bank_account",
    "accountOwner": "019fed1a-3d6e-75d3-a81e-cba3874b0a55",
    "ownerType": "business",
    "status": "INACTIVE",
    "createdAt": "2026-08-11T14:38:00.0117762Z",
    "lastUpdated": "2026-08-11T14:40:03.1182233Z",
    "_links": {
      "self": "/api/v2/payment-methods/019ff142-454b-7721-96a3-c8628b9d568f",
      "owner": "/api/v2/businesses/019fed1a-3d6e-75d3-a81e-cba3874b0a55"
    },
    "fingerprint": "2a0c2a64d03492ba45af4d01f329f22b41513411cab7658072739d17ed570675",
    "tokenReference": "deacc32d-81eb-470b-9cff-0ad2fab87096",
    "nickname": "Primary operating account",
    "financialInstitution": "Bank of Example",
    "accountType": "Checking",
    "accountNumber": "****6789",
    "routingNumber": "*****0021",
    "usage": [
      "deposits",
      "billing"
    ]
  }
}

Deactivates a payment method. This is a soft delete: the payment method moves to INACTIVE and the record is kept.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

paymentMethodReferencestringRequired

The payment method reference.

Response

Payment method deactivated.

successboolean

Whether the request succeeded.

messagestring or null

A human-readable result message.

traceIdstring or null

The trace identifier for the request, useful for support.

dataobject or null

The deactivated payment method.

Errors

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error