Update a payment method

Beta

PATCH

/v2/payment-methods/:paymentMethodReference

PATCH

/api/v2/payment-methods/:paymentMethodReference

curl -X PATCH https://api-sandbox.payabli.com/api/v2/payment-methods/019ff142-454b-7721-96a3-c8628b9d568f \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "nickname": "Primary operating account",
  "usage": [
    "deposits",
    "billing"
  ]
}'

{
  "success": true,
  "message": "Payment method updated successfully",
  "traceId": "0HNNN6HH5NE2H:00000016",
  "data": {
    "paymentMethodReference": "019ff142-454b-7721-96a3-c8628b9d568f",
    "type": "bank_account",
    "accountOwner": "019fed1a-3d6e-75d3-a81e-cba3874b0a55",
    "ownerType": "business",
    "status": "PENDING",
    "createdAt": "2026-08-11T14:38:00.0117762Z",
    "lastUpdated": "2026-08-11T14:39:12.4471182Z",
    "_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"
    ]
  }
}

Applies a partial update to a payment method. Send only the fields you want to change. Only payment methods in PENDING status can be updated. Once a payment method is active, change it through the bank account change process instead.

Authentication

AuthorizationBearer

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

Path parameters

paymentMethodReferencestringRequired

The payment method reference.

Request

This endpoint expects an object.

nicknamestringOptional

An optional label for the payment method.

financialInstitutionstringOptional

The bank or financial institution that holds the account.

accountTypestringOptional

The account type, for example checking or savings.

accountNumberstringOptional

The bank account number.

routingNumberstringOptional

The bank routing number.

usagelist of enumsOptional

What the payment method is used for. Provide at least one value.

Response

Payment method updated.

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 updated payment method.

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error