Update Payment Method

PUT

/api/:account_id/payments/payment_methods/:payment_method_id

Update a payment method (name, active flag, or meta).

Authentication

AuthorizationBearer

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

Path parameters

payment_method_idstringRequired

Payment method ID

account_idstringRequired

Request

This endpoint expects an object.

namestring or nullOptional

is_activeboolean or nullOptional

metadatamap from strings to any or nullOptional

Response

Successful Response

idstring

account_idstring

customer_idstring or null

provider_typeenum

Type of payment method.

namestring

is_activeboolean

metadatamap from strings to any or null

Free-form metadata about the payment method. For credit cards this includes last4, brand, exp_month, exp_year, and (for VGS-vaulted cards) issuer intelligence resolved at setup time:

bin — issuer BIN, 6 or 8 digits (string; may be absent).
card_attributes — VGS card attribute object (may be absent; fields within may be absent; values are UPPERCASE as returned by VGS). Includes card_type, card_segment_type, prepaid_card, virtual_card, country_name, country_numeric, regulated, and additional card details.

Read with e.g. metadata?.bin and metadata?.card_attributes?.card_type.

created_atdatetime

updated_atdatetime

used_in_subscriptionbooleanOptionalDefaults to false

network_token_statusstring or nullOptional

Errors

422

Unprocessable Entity Error

$	curl -X PUT https://app.paymentkit.com/api/account_id/payments/payment_methods/payment_method_id \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"id": "pm_8f3b2c9d7a1e4f6b",
3	"account_id": "acct_1234567890abcdef",
4	"customer_id": "cust_9876543210fedcba",
5	"provider_type": "credit_card",
6	"name": "Visa ending in 4242",
7	"is_active": true,
8	"metadata": {},
9	"created_at": "2024-01-15T09:30:00Z",
10	"updated_at": "2024-01-15T09:30:00Z",
11	"used_in_subscription": false,
12	"network_token_status": "active"
13	}