Skip to main content
POST
Create a card payment method

Authorizations

Authorization
string
header
required

Short-lived access token minted by POST /v1/oauth/token.

Headers

Idempotency-Key
string
required

Unique client-generated key for this create-card attempt. Re-use the same value only when retrying the same request.

Minimum string length: 1

Body

application/json

Raw card payload accepted only on the secure card-capture hostname. At most one billing-address input may be supplied: use billing_address_id to re-use an existing party address, send billing_address to use a transient address for this card, or omit both so Monterey falls back to the selected borrower's current billing address.

account_id
string
required
card
object
required
party_id
string
cardholder_name
string
Maximum string length: 255
billing_address_id
string
nickname
string
Maximum string length: 100
set_default
boolean
default:false
billing_address
object

Response

Card payment method created.

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.