Add Payment Method

Add a payment method to a shopper's Bolt account Wallet. For security purposes, this request must come from your backend because authentication requires the use of your private key.

Note: Before using this API, the credit card details must be tokenized using Bolt's JavaScript library function, which is documented in Install the Bolt Tokenizer.

Authorization

OAuth bolt.account.manageX-API-Key

AuthorizationBearer <token>

Bolt utilizes the OAuth flow that developers can use to attain access to Bolt Account data via APIs. For all APIs that require authorization, please provide your access_token returned from /v1/oauth/token via the basic auth bearer header Authorization: bearer ${TOKEN}. Read more about the OAuth token endpoint.

In: header

Scope: bolt.account.manage

X-API-Key<token>

Admins and Developers can obtain their Bolt API key from the Bolt Merchant Dashboard.

In: header

Header Parameters

X-Publishable-Key?string

The publicly viewable identifier used to identify a merchant division. This key is found in the Developer > API section of the Bolt Merchant Dashboard [RECOMMENDED].

Idempotency-Key?string

A key created by merchants that ensures POST and PATCH requests are only performed once. Read more about Idempotent Requests here.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

The credit_card object is used to to pay for guest checkout transactions or save payment method details to an account. Once saved, you can reference the credit card with the associated credit_card_id for future transactions.

billing_address*

The Address object is used for billing, shipping, and physical store address use cases.

billing_address_id?|

The unique Bolt ID associated with a saved shopper address. This can be obtained by accessing a shopper's account details. If you use this field, you do not need to use billing_address.

bin?string

The Bank Identification Number for the credit card. This is typically the first 4-6 digits of the credit card number.

Length4 <= length <= 6

cryptogram?string

eci?string

expiration*string

The expiration date of the credit card.

last4?string

The last 4 digits of the credit card number.

Length4 <= length <= 4

metadata?|

A key-value pair object that allows users to store arbitrary information associated with an object. For any individual account object, we allow up to 50 keys. Keys can be up to 40 characters long and values can be up to 500 characters long. Metadata should not contain any sensitive customer information, like PII (Personally Identifiable Information). For more information about metadata, see our documentation.

network?string

Value in

"visa"
"mastercard"
"amex"
"discover"
"dinersclub"
"jcb"
"unionpay"
"alliancedata"
"citiplcc"
"unknown"

number?string

Used to provide ApplePay DPAN or private label credit card PAN when applicable. Required when charging a private label credit card.

postal_code?string

Used for the postal or zip code associated with the credit card.

Lengthlength <= 32

priority?integer

Used to indicate the card's priority. '1' indicates primary, while '2' indicates a secondary card.

Value in

save?boolean

Determines whether or not the credit card will be saved to the shopper's account. Defaults to true.

token*string

The Bolt token associated to the credit card.

token_type?string

Used to define which payment processor generated the token for this credit card. For those using Bolt's tokenizer, the value must be bolt.

Value in

"vantiv"
"applepay"
"bolt"
"stripe"
"plcc"

currency?string

This can be left empty. A 3-digit ISO code for currency that will be used in the credit card authorization.

Response Body

`application/json`

curl -X POST "https://example.com/v1/account/payment_methods" \  -H "Content-Type: application/json" \  -d '{    "billing_address": {      "country_code": "US",      "email": "alan.watts@example.com",      "first_name": "Alan",      "last_name": "Watts",      "locality": "Brooklyn",      "postal_code": "10044",      "region": "NY",      "street_address1": "888 main street"    },    "expiration": "2025-11",    "token": "a1B2c3D4e5F6G7H8i9J0k1L2m3N4o5P6Q7r8S9t0"  }'

{  "billing_address": {    "company": "Bolt",    "country": "United States",    "country_code": "US",    "door_code": "123456",    "email_address": "alan.watts@example.com",    "first_name": "Alan",    "id": "string",    "last_name": "Watts",    "locality": "Brooklyn",    "name": "Alan Watts",    "phone_number": "+12125550199",    "postal_code": "10044",    "priority": "primary",    "region": "NY",    "region_code": "NY",    "street_address1": "888 main street",    "street_address2": "apt 3021",    "street_address3": "c/o Alicia Watts",    "street_address4": "Bridge Street Apartment Building B"  },  "id": "string",  "last4": "4021",  "exp_month": 11,  "exp_year": 2024,  "network": "visa",  "default": true,  "type": "card",  "description": "string",  "metadata": {    "customer_id": 234  }}

Add Payment Method

Authorization

Header Parameters

Request Body

Response Body

200application/json

`application/json`