Bulk Import Instruments | BigCommerce Developer Center

curl -X POST https://api.bigcommerce.com/stores/store_hash/v3/payments/stored-instruments \
     -H "X-Auth-Token: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '[
  {
    "payment_method_id": "braintree.credit_card",
    "currency_code": "USD",
    "customer_id": 1,
    "instrument": {
      "vault_token": "5292sx35",
      "provider_customer_id": "321123",
      "type": "credit_card",
      "brand": "visa",
      "expiry_year": 26,
      "expiry_month": 11,
      "last_4": "1111",
      "iin": "411111"
    },
    "billing_address": {
      "first_name": "Sam",
      "last_name": "Williams",
      "email": "sam.williams@email.com",
      "company": "BigCommerce",
      "street_1": "1 Sample Street",
      "street_2": "Bldg 5",
      "city": "Austin",
      "state_or_province_code": "TX",
      "country_code": "US",
      "phone": "101-192-0293",
      "postal_code": "55555"
    }
  }
]'

{
  "data": [
    {
      "customer_id": 1,
      "provider_vault_token": "provider_token",
      "instrument": {
        "token": "84596bea275fa254da820056bdc3e495bdf01fd11c51b0336347d447ee16200c",
        "type": "paypal_account",
        "is_default": true,
        "email": "bc-buyer-paypal-express@bigcommerce.com"
      }
    },
    {
      "customer_id": 1,
      "provider_vault_token": "provider_token",
      "instrument": {
        "token": "84596bea275fa254da820056bdc3e495bdf01fd11c51b0336347d447ee16200c",
        "type": "bank_account",
        "is_default": true,
        "issuer": "011000015",
        "masked_account_number": "0000"
      }
    },
    {
      "customer_id": 1,
      "provider_vault_token": "provider_token",
      "instrument": {
        "token": "84596bea275fa254da820056bdc3e495bdf01fd11c51b0336347d447ee16200c",
        "type": "credit_card",
        "is_default": true,
        "brand": "visa",
        "expiry_month": 1,
        "expiry_year": 1,
        "iin": "411111",
        "last_4": "1111",
        "billing_address": {
          "first_name": "Tester",
          "last_name": "Tester",
          "email": "example@email.com",
          "company": "",
          "address1": "1 Sample Street",
          "address2": "",
          "city": "",
          "state_or_province": "Nevada",
          "state_or_province_code": "NV",
          "country_code": "US",
          "phone": "101-192-0293",
          "postal_code": "55555"
        }
      }
    }
  ],
  "errors": [],
  "meta": {
    "total": 3,
    "success": 3,
    "failed": 0
  }
}

Imports instruments that were vaulted outside the store.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Create Payments	create	`store_payments_access_token_create`
Get Payment Methods	read-only	`store_payments_methods_read`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

### OAuth scopes | UI Name | Permission | Parameter | |:--------|:-----------|:----------| | Create Payments | create | `store_payments_access_token_create` | | Get Payment Methods | read-only | `store_payments_methods_read` | ### Authentication header | Header | Argument | Description | |:-------|:---------|:------------| | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). | ### Further reading For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).

Request

This endpoint expects a list of objects.

payment_method_idstringRequired

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

currency_codestringRequired

The instrument currency.

customer_idintegerRequired

The ID of the customer.

instrumentobjectRequired

The instrument details.

billing_addressobjectRequired

trusted_shipping_addresseslist of objectsOptional

The trusted shipping address for an instrument.

default_instrumentbooleanOptional

Make instrument default.

Response

All instruments were successfully imported.

datalist of objects

Successfully imported instruments.

errorslist of objects

Errors with detailed errors indexed by input parameters.

metaobject

Response metadata.

Errors

401

Unauthorized Error

422

Unprocessable Entity Error