Retrieve a Digital Card Profile

Changed on
get/digital_card_profiles/{digital_card_profile_id}

Request

  • Base URL
    https://api.increase.com
  • URL
    https://api.increase.com/digital_card_profiles/{digital_card_profile_id}
  • Auth
    HTTP bearer

Path parameters

digital_card_profile_idstring required

The identifier of the Digital Card Profile.

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

The name of your company or card program, shown to the user as who to contact for support with 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.

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",
  "apple_pay": {
    "associated_application_identifiers": [
      {
        "identifier": "ABCDE12345.com.example.app"
      }
    ],
    "associated_store_identifiers": [
      {
        "identifier": "1234567890"
      }
    ]
  },
  "background_image_file_id": "file_makxrc67oh9l6sg7w9yc",
  "card_description": "Black Card",
  "contact_email": "user@example.com",
  "contact_name": "National Phonograph Company",
  "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,
  "status": "active",
  "text_color": {
    "blue": 230,
    "green": 255,
    "red": 189
  },
  "type": "digital_card_profile"
}

Changes

  • 405a5c466a4dRevision changes
    • info

      added the required property to the response with the status

  • a8de01fba2b5Revision changes
    • breaking

      removed the required property from the response with the status

    • info

      added the required property to the response with the status