add credit card

1 min

POST

https://api.upstartcommerce.com/v1/customer/profile/creditcards/cards

This endpoint allows the currently-logged-in consumer to add a credit card, as keyed by label.

Authorized roles:

customer.default

Header Parameters

x-upstart-tenantstringrequired
Description
Tenant identifier associated with the site this call is for.
x-upstart-sitestring
Description
Unique identifier for the site.

Body Parameters

bodyCreditCardrequired
Description
The credit card to store against the customer.
- cardNumberstringrequired
  Example
  8111
  Description
  This should be the last 4 digits of the consumer's payment card.
  Pattern
  [0-9]{4}
- cardTypestringrequired
  Example
  Visa
  Description
  The type of payment card (Visa, Mastercard, Discover, Debit etc.)
- expirationMonthstringrequired
  Example
  10
  Description
  The 2-digit month on which the card expires.
  Pattern
  ^[0,1][0-9]$
- expirationYearstringrequired
  Example
  2025
  Description
  This should be the 4-digit year on which the card expires.
  Pattern
  ^2[0-9]{3}$
- labelstringrequired
  Example
  Personal
  Description
  This is a user-friendly label the consumer can use to identify this particular card.
- tokenstringrequired
  Example
  65FZG32BYZ756JH345
  Description
  A token provided by the payment gateway that can be used transactionally and represents the actual card PAN.

Responses

200

Success-credit card data added.

400The request contained information that the server was unable to process. Appropriate errors are provided in the response body.

ValidationErrorResponse
Description
Error payload returned when a request fails validation, identifying the offending input by name, code and detail.
- namestringrequired
- codestringrequired
- detailstring

401The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.

ErrorResponse
Description
Standard error payload identifying a failure by name, code and detail, with an optional machine-readable reason.
- namestringrequired
- codestringrequired
- detailstringrequired
- reasonstring

403

An update to this resource requires the if-match and if-unmodified-since headers to be sent in order to process the request.

ErrorResponse
Description
Standard error payload identifying a failure by name, code and detail, with an optional machine-readable reason.
- namestringrequired
- codestringrequired
- detailstringrequired
- reasonstring

404The requested resource was not found in the NoChannel system.

ErrorResponse
Description
Standard error payload identifying a failure by name, code and detail, with an optional machine-readable reason.
- namestringrequired
- codestringrequired
- detailstringrequired
- reasonstring

curl

curl --request POST \
     --url https://api.upstartcommerce.com/v1/customer/profile/creditcards/cards \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-upstart-tenant: string' \
     --data '{
     "cardNumber": "8111",
     "cardType": "Visa",
     "expirationMonth": "10",
     "expirationYear": "2025",
     "label": "Personal",
     "token": "65FZG32BYZ756JH345"
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
myHeaders.append("x-upstart-tenant", "string");

var raw = JSON.stringify({
   "cardNumber": "8111",
   "cardType": "Visa",
   "expirationMonth": "10",
   "expirationYear": "2025",
   "label": "Personal",
   "token": "65FZG32BYZ756JH345"
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api.upstartcommerce.com/v1/customer/profile/creditcards/cards", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.upstartcommerce.com/v1/customer/profile/creditcards/cards")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request["x-upstart-tenant"] = "string"
request.body = JSON.dump({
   "cardNumber": "8111",
   "cardType": "Visa",
   "expirationMonth": "10",
   "expirationYear": "2025",
   "label": "Personal",
   "token": "65FZG32BYZ756JH345"
})

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.upstartcommerce.com/v1/customer/profile/creditcards/cards"

payload = json.dumps({
   "cardNumber": "8111",
   "cardType": "Visa",
   "expirationMonth": "10",
   "expirationYear": "2025",
   "label": "Personal",
   "token": "65FZG32BYZ756JH345"
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json',
   'x-upstart-tenant': 'string'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

200

// Success-credit card data added.

400

// The request contained information that the server was unable to process. Appropriate errors are provided in the response body.
{
  "name": "",
  "code": "",
  "detail": ""
}

401

// The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.
{
  "name": "",
  "code": "",
  "detail": "",
  "reason": ""
}

403

// An update to this resource requires the if-match and if-unmodified-since headers to be sent in order to process the request.
{
  "name": "",
  "code": "",
  "detail": "",
  "reason": ""
}

404

// The requested resource was not found in the NoChannel system.
{
  "name": "",
  "code": "",
  "detail": "",
  "reason": ""
}