List payment methods

GET

https://api.schematichq.com/company/payment-methods

GET

/company/payment-methods

const url = 'https://api.schematichq.com/company/payment-methods';
const options = {method: 'GET', headers: {'X-Schematic-Api-Key': '<apiKey>'}};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "data": {
    "count": 1,
    "payment_methods": [
      {
        "can_remove": true,
        "external_id": "string",
        "id": "string",
        "is_default": true,
        "type": "string",
        "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"
      }
    ]
  },
  "params": {}
}

The company's payment methods on file, with the default marked and whether each can be removed.

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.

Response

dataobject

paramsobject

Input parameters

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error