cards

Create Card

post/v2/cards/

Request body

exp_yearinteger required

Year expiration in YYYY format

exp_monthinteger required

Month expiration in MM format

customerstring

Customer to assign the card

cvcstring

Card security code used to secure the transaction

numberstring required

Card number

preferred_network'national' | 'visa' | 'mastercard'

Card network to use for co-branded card

zip_codestring

zip code in 2 to 8 digit format

external_idstring

Unique id with unicity check

namestring

custome name given to the card, often the card holder name

tokenizeboolean

Define if card can be reused for future payments

Example request

{
  "exp_year": 2022,
  "exp_month": 12,
  "customer": "cust_yWYfCSzsUUhr9KwMv7vuLZHX",
  "cvc": "123",
  "number": "4242424242424242",
  "preferred_network": "national",
  "zip_code": "75001",
  "external_id": "UniqueId123",
  "name": "My card",
  "tokenize": true
}

Response

Successful Response

customerstring

Associated customer

brandstring required

Card brand

countrystring required

Country of the card issuer

createdstring date-time required

Date of creation in Epoch timestamp

exp_monthinteger required

Month in MM format

exp_yearinteger required

Year expiration in YYYY format

external_idstring

Unique id with unicity check

funding'credit' | 'debit' | 'prepaid' | 'universal' | 'charge' | 'deferred' | 'unknown'

An enumeration.

idstring required
last4string required

Last 4 digit of the card number

namestring

Custom name given to the card, often the card holder name

nature'personal' | 'corporate' | 'unknown'

An enumeration.

preferred_network'national' | 'visa' | 'mastercard'
network'unknown' | 'national' | 'visa' | 'mastercard'

An enumeration.

zip_codestring

Zip code in 2 to 8 digit format

deletedboolean required

Example response

{
  "brand": "visa",
  "country": "FR",
  "created": "1512518400",
  "exp_month": 12,
  "exp_year": 2022,
  "external_id": "UniqueId123",
  "id": "card_yWYfCSzsUUhr9KwMv7vuLZHX",
  "last4": "4242",
  "name": "My card",
  "zip_code": "75001"
}

Changes