Docs
Guides
Explanatory and how-to content
API Reference
Technical documentation
Changelog
Release notes
Dashboard
Manage your account
Status
Service status
API Reference
Digital Card Profiles

This contains artwork and metadata relating to a Card's appearance in digital wallet apps like Apple Pay and Google Pay. For more information, see our guide on digital card artwork.

The Digital Card Profile object
{
  "app_icon_file_id": "file_makxrc67oh9l6sg7w9yc",
  "background_image_file_id": "file_makxrc67oh9l6sg7w9yc",
  "card_description": "Black Card",
  "contact_email": "user@example.com",
  "contact_phone": "+18882988865",
  "contact_website": "https://example.com",
  "created_at": "2020-01-31T23:59:59Z",
  "description": "Corporate logo Apple Pay Card",
  "id": "digital_card_profile_s3puplu90f04xhcwkiga",
  "idempotency_key": null,
  "issuer_name": "National Phonograph Company",
  "status": "active",
  "text_color": {
    "blue": 230,
    "green": 255,
    "red": 189
  },
  "type": "digital_card_profile"
}
Attributes
app_icon_file_id
string

The identifier of the File containing the card's icon image.

background_image_file_id
string

The identifier of the File containing the card's front image.

card_description
string

A user-facing description for the card itself.

contact_email
string
Nullable

An email address the user can contact to receive support for their card.

contact_phone
string
Nullable

A phone number the user can contact to receive support for their card.

contact_website
string
Nullable

A website the user can visit to view and receive support for their card.

created_at
string

The ISO 8601 date and time at which the Card Dispute was created.

description
string

A description you can use to identify the Card Profile.

id
string

The Card Profile identifier.

idempotency_key
string
Nullable

The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

issuer_name
string

A user-facing description for whoever is issuing the card.

status
enum

The status of the Card Profile.

text_color
dictionary

The Card's text color, specified as an RGB triple.

type
string

A constant representing the object's type. For this resource it will always be digital_card_profile.

List Card Profiles
curl \
  --url "${INCREASE_URL}/digital_card_profiles" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

status.in
array of strings

Filter Digital Card Profiles for those with the specified digital wallet status or statuses. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

idempotency_key
string

Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

200 character maximum
Create a Digital Card Profile
curl -X "POST" \
  --url "${INCREASE_URL}/digital_card_profiles" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "app_icon_file_id": "file_8zxqkwlh43wo144u8yec",
    "background_image_file_id": "file_1ai913suu1zfn1pdetru",
    "card_description": "MyBank Signature Card",
    "contact_email": "user@example.com",
    "contact_phone": "+18885551212",
    "contact_website": "https://example.com",
    "description": "My Card Profile",
    "issuer_name": "MyBank",
    "text_color": {
      "blue": 59,
      "green": 43,
      "red": 26
    }
  }'
Parameters
app_icon_file_id
string
Required

The identifier of the File containing the card's icon image.

background_image_file_id
string
Required

The identifier of the File containing the card's front image.

card_description
string
Required

A user-facing description for the card itself.

32 character maximum
contact_email
string

An email address the user can contact to receive support for their card.

32 character maximum
contact_phone
string

A phone number the user can contact to receive support for their card.

32 character maximum
contact_website
string

A website the user can visit to view and receive support for their card.

description
string
Required

A description you can use to identify the Card Profile.

200 character maximum
issuer_name
string
Required

A user-facing description for whoever is issuing the card.

32 character maximum
text_color
dictionary

The Card's text color, specified as an RGB triple. The default is white.

Retrieve a Digital Card Profile
curl \
  --url "${INCREASE_URL}/digital_card_profiles/digital_card_profile_s3puplu90f04xhcwkiga" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
digital_card_profile_id
string
Required

The identifier of the Digital Card Profile.

Archive a Digital Card Profile
curl -X "POST" \
  --url "${INCREASE_URL}/digital_card_profiles/digital_card_profile_s3puplu90f04xhcwkiga/archive" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
digital_card_profile_id
string
Required

The identifier of the Digital Card Profile to archive.

Clones a Digital Card Profile
curl -X "POST" \
  --url "${INCREASE_URL}/digital_card_profiles/digital_card_profile_s3puplu90f04xhcwkiga/clone" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "background_image_file_id": "file_1ai913suu1zfn1pdetru"
  }'
Parameters
digital_card_profile_id
string
Required

The identifier of the Digital Card Profile to clone.

app_icon_file_id
string

The identifier of the File containing the card's icon image.

background_image_file_id
string

The identifier of the File containing the card's front image.

card_description
string

A user-facing description for the card itself.

32 character maximum
contact_email
string

An email address the user can contact to receive support for their card.

32 character maximum
contact_phone
string

A phone number the user can contact to receive support for their card.

32 character maximum
contact_website
string

A website the user can visit to view and receive support for their card.

description
string

A description you can use to identify the Card Profile.

200 character maximum
issuer_name
string

A user-facing description for whoever is issuing the card.

32 character maximum
text_color
dictionary

The Card's text color, specified as an RGB triple. The default is white.