Sign in

v4

OpenAPI 3.1.02026-08-012402353.8 MB

Create a Digital Card Profile

post/digital_card_profiles

Request body

app_icon_file_idstring required

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

background_image_file_idstring required

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

card_descriptionstring required

A user-facing description for the card itself.

contact_emailstring email

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

contact_phonestring

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

contact_websitestring

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

descriptionstring required

A description you can use to identify the Card Profile.

issuer_namestring required

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

Example request

{
  "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
  }
}

Response

Digital Card Profile

app_icon_file_idstring required

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

background_image_file_idstring required

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

card_descriptionstring required

A user-facing description for the card itself.

contact_emailstring nullable required

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

contact_phonestring nullable required

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

contact_websitestring nullable required

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

created_atstring date-time required

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

descriptionstring required

A description you can use to identify the Card Profile.

idstring required

The Card Profile identifier.

idempotency_keystring nullable required

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_namestring required

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

status'pending' | 'rejected' | 'active' | 'archived' required

The status of the Card Profile.

type'digital_card_profile' required

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

Example response

{
  "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"
}