Skip to main content
PATCH
/
payment-methods
/
{payment_method_id}
Update a payment method
curl --request PATCH \
  --url https://api.montereyfinancial.app/payment-methods/{payment_method_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "nickname": "<string>",
  "holder_name": "<string>"
}
'
{
  "id": "<string>",
  "party_id": "<string>",
  "instrument_type": "<string>",
  "is_active": true,
  "last_four": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "holder_name": "<string>",
  "nickname": "<string>",
  "card_brand": "<string>",
  "card_exp_month": 123,
  "card_exp_year": 123,
  "bank_name": "<string>",
  "bank_account_type": "<string>",
  "wallet_type": "<string>"
}

Authorizations

​
Authorization
string
header
required

Static API key issued via the client portal. Treat it like a password.

Path Parameters

​
payment_method_id
string
required

Body

application/json

Editable payment-method fields. Instrument data (type, digits, expiry, bank, wallet) is immutable — requests naming any other field are rejected with a 422.

​
nickname
string | null

Borrower-chosen label for this payment method.

Maximum string length: 100
​
holder_name
string | null

Name of the card or account holder.

Maximum string length: 255

Response

Successful Response

A stored payment instrument (card, bank account, or wallet) belonging to a borrower. Carries display-safe metadata only — never full card or account numbers.

​
id
string
required
​
party_id
string
required

The person (borrower) this payment method belongs to.

​
instrument_type
string
required

Kind of instrument. One of: card, bank_account, wallet.

​
is_active
boolean
required

False once the payment method has been removed. Inactive methods cannot be attached to autopay or payments.

​
last_four
string
required

Last four digits of the card or account number.

​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
holder_name
string | null

Name of the card or account holder.

​
nickname
string | null

Borrower-chosen label for this payment method.

​
card_brand
string | null

Card network (e.g. visa, mastercard). Cards only.

​
card_exp_month
integer | null

Card expiration month (1-12). Cards only.

​
card_exp_year
integer | null

Card expiration year (four digits). Cards only.

​
bank_name
string | null

Bank name. Bank accounts only.

​
bank_account_type
string | null

Bank account type (e.g. checking, savings). Bank accounts only.

​
wallet_type
string | null

Wallet provider (e.g. apple_pay, google_pay). Wallets only.