Make a payment method the default

POST

https://api.schematichq.com/checkout/paymentmethod/update

POST

/checkout/paymentmethod/update

const url = 'https://api.schematichq.com/checkout/paymentmethod/update';
const options = {
  method: 'POST',
  headers: {'X-Schematic-Api-Key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"payment_method_id":"string"}'
};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "data": {
    "created_at": "2024-01-15T09:30:00Z",
    "customer_external_id": "string",
    "environment_id": "string",
    "external_id": "string",
    "id": "string",
    "payment_method_type": "string",
    "provider_type": "metronome",
    "updated_at": "2024-01-15T09:30:00Z",
    "account_last4": "string",
    "account_name": "string",
    "bank_name": "string",
    "billing_email": "string",
    "billing_name": "string",
    "card_brand": "string",
    "card_exp_month": 1,
    "card_exp_year": 1,
    "card_last4": "string",
    "company_id": "string"
  },
  "params": {}
}

Makes a method on file the one the company’s charges use. The body’s payment_method_id is the provider’s id of the method, the external_id the list returns; usePaymentMethods().setDefault calls this and reloads the list. A card saved during a checkout joins the methods on file and becomes the default the same way.

Authentication

X-Schematic-Api-Keystring

A temporary access token in the X-Schematic-Api-Key header. Your server mints it with POST /temporary-access-tokens on the secret-key API for a company, optionally for one of its users, and hands it to the page. The token fixes the company every request reads and writes.

Request

This endpoint expects an object.

payment_method_idstringRequired<=255 characters

Response

Created

dataobject

paramsobject

Input parameters

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error