Attach Instrument to Customer | BigCommerce Developer Center

curl -X POST https://payments.bigcommerce.com/stores/store_hash/stored-instruments \
     -H "Accept: application/vnd.bc+json" \
     -H "X-Auth-Token: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "payment_method_id": "braintree.paypal",
  "currency_code": "USD",
  "customer_id": "1",
  "instrument": {
    "number": "4111111111111111",
    "expiration_year": 2024,
    "expiration_month": 12,
    "verification_value": "123",
    "cardholder_name": "test name",
    "type": "raw_card"
  },
  "billing_address": {
    "first_name": "Tester",
    "email": "example@email.com",
    "street_1": "1 Sample Street",
    "city": "Tampa",
    "country_code": "US",
    "last_name": "Tester",
    "company": "",
    "street_2": "",
    "state_or_province_code": "NV",
    "phone": "101-192-0293",
    "postal_code": "55555"
  }
}'

{
  "data": {
    "customer_id": "1",
    "token": "e4e43db4454391cee7608673d530d91fc87ea3d5c75315601bd939d1281f70e2",
    "type": "paypal_account",
    "is_default": true,
    "billing_address": {
      "first_name": "Tester",
      "last_name": "Tester",
      "email": "example@email.com",
      "company": "",
      "street_1": "1 Sample Street",
      "street_2": "",
      "city": "",
      "state_or_province_code": "NV",
      "country_code": "US",
      "phone": "101-192-0293",
      "postal_code": "55555"
    },
    "email": "bc-buyer-paypal-express@bigcommerce.com"
  },
  "meta": {}
}

Adds an instrument to customer.

Request

This endpoint expects an object.

payment_method_idstringRequired

Identifier for payment method that will be used for this instrument obtained from Payment Methods API.

currency_codestringRequired

The instrument currency.

customer_idstringRequired

The ID of the customer to add instrument for.

instrumentobjectRequired

billing_addressobjectRequired

default_instrumentbooleanOptional

Set this instrument as default for customer?

trusted_shipping_addresseslist of objectsOptional

Trusted shipping address for instrument.

Response

Created instrument

dataobject

metaobject

Response metadata.

Errors

401

Unauthorized Error

422

Unprocessable Entity Error

Headers

Request

Response

Errors