Retrieve a Card Profile

v1.0.0

Input

{
  "type": "object",
  "properties": {
    "card_profile_id": {
      "type": "string",
      "description": "The identifier of the Card Profile."
    }
  },
  "required": [
    "card_profile_id"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "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](https://increase.com/documentation/card-art)",
  "required": [
    "created_at",
    "description",
    "digital_wallets",
    "id",
    "status",
    "type"
  ],
  "properties": {
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Card Dispute was created."
    },
    "description": {
      "type": "string",
      "description": "A description you can use to identify the Card Profile."
    },
    "digital_wallets": {
      "type": "object",
      "description": "How Cards should appear in digital wallets such as Apple Pay. Different wallets will use these values to render card artwork appropriately for their app.",
      "required": [
        "app_icon_file_id",
        "background_image_file_id",
        "card_description",
        "contact_email",
        "contact_phone",
        "contact_website",
        "issuer_name",
        "text_color"
      ],
      "properties": {
        "app_icon_file_id": {
          "type": "string",
          "description": "The identifier of the File containing the card's icon image."
        },
        "background_image_file_id": {
          "type": "string",
          "description": "The identifier of the File containing the card's front image."
        },
        "card_description": {
          "type": "string",
          "description": "A user-facing description for the card itself."
        },
        "contact_email": {
          "type": "string",
          "description": "An email address the user can contact to receive support for their card."
        },
        "contact_phone": {
          "type": "string",
          "description": "A phone number the user can contact to receive support for their card."
        },
        "contact_website": {
          "type": "string",
          "description": "A website the user can visit to view and receive support for their card."
        },
        "issuer_name": {
          "type": "string",
          "description": "A user-facing description for whoever is issuing the card."
        },
        "text_color": {
          "type": "object",
          "description": "The Card's text color, specified as an RGB triple.",
          "required": [
            "blue",
            "green",
            "red"
          ],
          "properties": {
            "blue": {
              "type": "integer",
              "description": "The value of the blue channel in the RGB color."
            },
            "green": {
              "type": "integer",
              "description": "The value of the green channel in the RGB color."
            },
            "red": {
              "type": "integer",
              "description": "The value of the red channel in the RGB color."
            }
          }
        }
      }
    },
    "id": {
      "type": "string",
      "description": "The Card Profile identifier."
    },
    "status": {
      "type": "string",
      "description": "The status of the Card Profile.",
      "enum": [
        "pending",
        "rejected",
        "active",
        "archived"
      ]
    },
    "type": {
      "type": "string",
      "description": "A constant representing the object's type. For this resource it will always be `card_profile`.",
      "enum": [
        "card_profile"
      ]
    }
  }
}