Set a payment method as the customer's default
Flips `is_default = true` for this customer **at your merchant account only**. Cards can be shared across merchants via Easy Connect, so the default is per-merchant: this never changes which card is default anywhere else, and any prior default of yours for the same customer is cleared in the same operation. Returns 400 if the method is archived at your merchant account.
Authorization
apiKey Merchant API key. Publishable keys (pk_test_* / pk_live_) are safe for browser/frontend use and carry a limited scope set (sessions, payment_instruments, customers, orders writes; products, product_prices, payment_links reads). Secret keys (sk_test_ / sk_live_*) grant full admin access and must only be used server-side.
In: header
Path Parameters
uuidResponse Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://loading/v1/api/payment-methods/497f6eca-6276-4993-bfeb-53cbbbba6f08/set-default"{
"success": true,
"timestamp": "2019-08-24T14:15:22Z",
"data": null,
"message": "string",
"pagination": {
"total": 0,
"limit": 1,
"offset": 0,
"has_more": true,
"truncated": true,
"cursors": {
"first": "string",
"last": "string"
}
}
}{
"success": false,
"timestamp": "2019-08-24T14:15:22Z",
"error": {
"code": "string",
"message": "string",
"details": null
}
}{
"success": false,
"timestamp": "2019-08-24T14:15:22Z",
"error": {
"code": "string",
"message": "string",
"details": null
}
}{
"success": false,
"timestamp": "2019-08-24T14:15:22Z",
"error": {
"code": "string",
"message": "string",
"details": null
}
}{
"success": false,
"timestamp": "2019-08-24T14:15:22Z",
"error": {
"code": "string",
"message": "string",
"details": null
}
}Soft-delete a payment method
Removes the payment method **from your merchant account only**, and clears its default flag there if set. Cards can be shared across merchants via Easy Connect, so this never removes the card from another merchant. Idempotent — calling on an already-archived method returns the existing row. The row itself is preserved, not deleted, so historical transfer joins still resolve.
Update payment-method display metadata
Patch the display metadata on a canonical payment method. Today only `exp_month` / `exp_year` are mutable (for issuer-driven card reissues). Card brand / last4 / type are derived from the underlying Finix PI and not patchable here.