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.

Events

Your application can listen to webhooks about this resource. The events about Digital Card Profiles will have the categories "digital_card_profile.created" or "digital_card_profile.updated" .

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.

More about Files.

background_image_file_id

string

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

More about Files.

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 Digital Card Profile was created.

description

string

A description you can use to identify the Card Profile.

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

import Increase from 'increase';

const client = new Increase({
  apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const digitalCardProfile of client.digitalCardProfiles.list()) {
  console.log(digitalCardProfile.id);
}

import os
from increase import Increase

client = Increase(
    api_key=os.environ.get("INCREASE_API_KEY"),  # This is the default and can be omitted
)
page = client.digital_card_profiles.list()
page = page.data[0]
print(page.id)

require "increase"

increase = Increase::Client.new(
  api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
)

page = increase.digital_card_profiles.list

puts(page)

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/Increase/increase-go"
	"github.com/Increase/increase-go/option"
)

func main() {
	client := increase.NewClient(
		option.WithAPIKey(os.Getenv("INCREASE_API_KEY")), // This is the default and can be omitted
	)
	page, err := client.DigitalCardProfiles.List(context.TODO(), increase.DigitalCardProfileListParams{})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", page)
}

package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.digitalcardprofiles.DigitalCardProfileListPage;
import com.increase.api.models.digitalcardprofiles.DigitalCardProfileListParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        IncreaseClient client = IncreaseOkHttpClient.fromEnv();

        DigitalCardProfileListPage page = client.digitalCardProfiles().list();
    }
}

package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.digitalcardprofiles.DigitalCardProfileListPage
import com.increase.api.models.digitalcardprofiles.DigitalCardProfileListParams

fun main() {
    val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()

    val page: DigitalCardProfileListPage = client.digitalCardProfiles().list()
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Increase\Client;
use Increase\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('INCREASE_API_KEY'));

try {
  $page = $client->digitalCardProfiles->list(
    cursor: 'cursor',
    idempotencyKey: 'x',
    limit: 1,
    status: ['in' => ['pending']],
  );

  var_dump($page);
} catch (APIException $e) {
  echo $e->getMessage();
}

using System;
using Increase.Api;
using Increase.Api.Models.DigitalCardProfiles;

IncreaseClient client = new();

DigitalCardProfileListParams parameters = new();

var page = await client.DigitalCardProfiles.List(parameters);
await foreach (var item in page.Paginate())
{
    Console.WriteLine(item);
}

Returns a list response :

{
  "data": [
    { /* Digital Card Profile object */ },
    { /* Digital Card Profile object */ }
    /* ... */
  ],
  "next_cursor": "v57w5d",
}

Parameters

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.

Between 1 and 200 characters

cursor

string

limit

integer

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
    }
  }'

import Increase from 'increase';

const client = new Increase({
  apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});

const digitalCardProfile = await client.digitalCardProfiles.create({
  app_icon_file_id: 'file_8zxqkwlh43wo144u8yec',
  background_image_file_id: 'file_1ai913suu1zfn1pdetru',
  card_description: 'MyBank Signature Card',
  description: 'My Card Profile',
  issuer_name: 'MyBank',
});

console.log(digitalCardProfile.id);

import os
from increase import Increase

client = Increase(
    api_key=os.environ.get("INCREASE_API_KEY"),  # This is the default and can be omitted
)
digital_card_profile = client.digital_card_profiles.create(
    app_icon_file_id="file_8zxqkwlh43wo144u8yec",
    background_image_file_id="file_1ai913suu1zfn1pdetru",
    card_description="MyBank Signature Card",
    description="My Card Profile",
    issuer_name="MyBank",
)
print(digital_card_profile.id)

require "increase"

increase = Increase::Client.new(
  api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
)

digital_card_profile = increase.digital_card_profiles.create(
  app_icon_file_id: "file_8zxqkwlh43wo144u8yec",
  background_image_file_id: "file_1ai913suu1zfn1pdetru",
  card_description: "MyBank Signature Card",
  description: "My Card Profile",
  issuer_name: "MyBank"
)

puts(digital_card_profile)

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/Increase/increase-go"
	"github.com/Increase/increase-go/option"
)

func main() {
	client := increase.NewClient(
		option.WithAPIKey(os.Getenv("INCREASE_API_KEY")), // This is the default and can be omitted
	)
	digitalCardProfile, err := client.DigitalCardProfiles.New(context.TODO(), increase.DigitalCardProfileNewParams{
		AppIconFileID:         increase.F("file_8zxqkwlh43wo144u8yec"),
		BackgroundImageFileID: increase.F("file_1ai913suu1zfn1pdetru"),
		CardDescription:       increase.F("MyBank Signature Card"),
		Description:           increase.F("My Card Profile"),
		IssuerName:            increase.F("MyBank"),
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", digitalCardProfile.ID)
}

package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.digitalcardprofiles.DigitalCardProfile;
import com.increase.api.models.digitalcardprofiles.DigitalCardProfileCreateParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        IncreaseClient client = IncreaseOkHttpClient.fromEnv();

        DigitalCardProfileCreateParams params = DigitalCardProfileCreateParams.builder()
            .appIconFileId("file_8zxqkwlh43wo144u8yec")
            .backgroundImageFileId("file_1ai913suu1zfn1pdetru")
            .cardDescription("MyBank Signature Card")
            .description("My Card Profile")
            .issuerName("MyBank")
            .build();
        DigitalCardProfile digitalCardProfile = client.digitalCardProfiles().create(params);
    }
}

package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.digitalcardprofiles.DigitalCardProfile
import com.increase.api.models.digitalcardprofiles.DigitalCardProfileCreateParams

fun main() {
    val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()

    val params: DigitalCardProfileCreateParams = DigitalCardProfileCreateParams.builder()
        .appIconFileId("file_8zxqkwlh43wo144u8yec")
        .backgroundImageFileId("file_1ai913suu1zfn1pdetru")
        .cardDescription("MyBank Signature Card")
        .description("My Card Profile")
        .issuerName("MyBank")
        .build()
    val digitalCardProfile: DigitalCardProfile = client.digitalCardProfiles().create(params)
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Increase\Client;
use Increase\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('INCREASE_API_KEY'));

try {
  $digitalCardProfile = $client->digitalCardProfiles->create(
    appIconFileID: 'file_8zxqkwlh43wo144u8yec',
    backgroundImageFileID: 'file_1ai913suu1zfn1pdetru',
    cardDescription: 'MyBank Signature Card',
    description: 'My Card Profile',
    issuerName: 'MyBank',
    contactEmail: 'user@example.com',
    contactPhone: '+18885551212',
    contactWebsite: 'https://example.com',
    textColor: ['blue' => 59, 'green' => 43, 'red' => 26],
  );

  var_dump($digitalCardProfile);
} catch (APIException $e) {
  echo $e->getMessage();
}

using System;
using Increase.Api;
using Increase.Api.Models.DigitalCardProfiles;

IncreaseClient client = new();

DigitalCardProfileCreateParams parameters = new()
{
    AppIconFileID = "file_8zxqkwlh43wo144u8yec",
    BackgroundImageFileID = "file_1ai913suu1zfn1pdetru",
    CardDescription = "MyBank Signature Card",
    Description = "My Card Profile",
    IssuerName = "MyBank",
};

var digitalCardProfile = await client.DigitalCardProfiles.Create(parameters);

Console.WriteLine(digitalCardProfile);

Parameters

app_icon_file_id

string

Required

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

More about Files.

background_image_file_id

string

Required

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

More about Files.

card_description

string

Required

A user-facing description for the card itself.

Between 1 and 32 characters

contact_email

string

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

Between 1 and 32 characters

contact_phone

string

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

Between 1 and 32 characters

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.

Between 1 and 200 characters

issuer_name

string

Required

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

Between 1 and 32 characters

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

import Increase from 'increase';

const client = new Increase({
  apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});

const digitalCardProfile = await client.digitalCardProfiles.retrieve(
  'digital_card_profile_s3puplu90f04xhcwkiga',
);

console.log(digitalCardProfile.id);

import os
from increase import Increase

client = Increase(
    api_key=os.environ.get("INCREASE_API_KEY"),  # This is the default and can be omitted
)
digital_card_profile = client.digital_card_profiles.retrieve(
    "digital_card_profile_s3puplu90f04xhcwkiga",
)
print(digital_card_profile.id)

require "increase"

increase = Increase::Client.new(
  api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
)

digital_card_profile = increase.digital_card_profiles.retrieve("digital_card_profile_s3puplu90f04xhcwkiga")

puts(digital_card_profile)

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/Increase/increase-go"
	"github.com/Increase/increase-go/option"
)

func main() {
	client := increase.NewClient(
		option.WithAPIKey(os.Getenv("INCREASE_API_KEY")), // This is the default and can be omitted
	)
	digitalCardProfile, err := client.DigitalCardProfiles.Get(context.TODO(), "digital_card_profile_s3puplu90f04xhcwkiga")
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", digitalCardProfile.ID)
}

package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.digitalcardprofiles.DigitalCardProfile;
import com.increase.api.models.digitalcardprofiles.DigitalCardProfileRetrieveParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        IncreaseClient client = IncreaseOkHttpClient.fromEnv();

        DigitalCardProfile digitalCardProfile = client.digitalCardProfiles().retrieve("digital_card_profile_s3puplu90f04xhcwkiga");
    }
}

package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.digitalcardprofiles.DigitalCardProfile
import com.increase.api.models.digitalcardprofiles.DigitalCardProfileRetrieveParams

fun main() {
    val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()

    val digitalCardProfile: DigitalCardProfile = client.digitalCardProfiles().retrieve("digital_card_profile_s3puplu90f04xhcwkiga")
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Increase\Client;
use Increase\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('INCREASE_API_KEY'));

try {
  $digitalCardProfile = $client->digitalCardProfiles->retrieve(
    'digital_card_profile_s3puplu90f04xhcwkiga'
  );

  var_dump($digitalCardProfile);
} catch (APIException $e) {
  echo $e->getMessage();
}

using System;
using Increase.Api;
using Increase.Api.Models.DigitalCardProfiles;

IncreaseClient client = new();

DigitalCardProfileRetrieveParams parameters = new()
{
    DigitalCardProfileID = "digital_card_profile_s3puplu90f04xhcwkiga"
};

var digitalCardProfile = await client.DigitalCardProfiles.Retrieve(parameters);

Console.WriteLine(digitalCardProfile);

Parameters

digital_card_profile_id

string

Required

The identifier of the Digital Card Profile.

More about Digital Card Profiles.

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

import Increase from 'increase';

const client = new Increase({
  apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});

const digitalCardProfile = await client.digitalCardProfiles.archive(
  'digital_card_profile_s3puplu90f04xhcwkiga',
);

console.log(digitalCardProfile.id);

import os
from increase import Increase

client = Increase(
    api_key=os.environ.get("INCREASE_API_KEY"),  # This is the default and can be omitted
)
digital_card_profile = client.digital_card_profiles.archive(
    "digital_card_profile_s3puplu90f04xhcwkiga",
)
print(digital_card_profile.id)

require "increase"

increase = Increase::Client.new(
  api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
)

digital_card_profile = increase.digital_card_profiles.archive("digital_card_profile_s3puplu90f04xhcwkiga")

puts(digital_card_profile)

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/Increase/increase-go"
	"github.com/Increase/increase-go/option"
)

func main() {
	client := increase.NewClient(
		option.WithAPIKey(os.Getenv("INCREASE_API_KEY")), // This is the default and can be omitted
	)
	digitalCardProfile, err := client.DigitalCardProfiles.Archive(context.TODO(), "digital_card_profile_s3puplu90f04xhcwkiga")
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", digitalCardProfile.ID)
}

package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.digitalcardprofiles.DigitalCardProfile;
import com.increase.api.models.digitalcardprofiles.DigitalCardProfileArchiveParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        IncreaseClient client = IncreaseOkHttpClient.fromEnv();

        DigitalCardProfile digitalCardProfile = client.digitalCardProfiles().archive("digital_card_profile_s3puplu90f04xhcwkiga");
    }
}

package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.digitalcardprofiles.DigitalCardProfile
import com.increase.api.models.digitalcardprofiles.DigitalCardProfileArchiveParams

fun main() {
    val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()

    val digitalCardProfile: DigitalCardProfile = client.digitalCardProfiles().archive("digital_card_profile_s3puplu90f04xhcwkiga")
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Increase\Client;
use Increase\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('INCREASE_API_KEY'));

try {
  $digitalCardProfile = $client->digitalCardProfiles->archive(
    'digital_card_profile_s3puplu90f04xhcwkiga'
  );

  var_dump($digitalCardProfile);
} catch (APIException $e) {
  echo $e->getMessage();
}

using System;
using Increase.Api;
using Increase.Api.Models.DigitalCardProfiles;

IncreaseClient client = new();

DigitalCardProfileArchiveParams parameters = new()
{
    DigitalCardProfileID = "digital_card_profile_s3puplu90f04xhcwkiga"
};

var digitalCardProfile = await client.DigitalCardProfiles.Archive(parameters);

Console.WriteLine(digitalCardProfile);

Parameters

digital_card_profile_id

string

Required

The identifier of the Digital Card Profile to archive.

More about Digital Card Profiles.

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

import Increase from 'increase';

const client = new Increase({
  apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});

const digitalCardProfile = await client.digitalCardProfiles.clone(
  'digital_card_profile_s3puplu90f04xhcwkiga',
);

console.log(digitalCardProfile.id);

import os
from increase import Increase

client = Increase(
    api_key=os.environ.get("INCREASE_API_KEY"),  # This is the default and can be omitted
)
digital_card_profile = client.digital_card_profiles.clone(
    digital_card_profile_id="digital_card_profile_s3puplu90f04xhcwkiga",
)
print(digital_card_profile.id)

require "increase"

increase = Increase::Client.new(
  api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
)

digital_card_profile = increase.digital_card_profiles.clone_("digital_card_profile_s3puplu90f04xhcwkiga")

puts(digital_card_profile)

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/Increase/increase-go"
	"github.com/Increase/increase-go/option"
)

func main() {
	client := increase.NewClient(
		option.WithAPIKey(os.Getenv("INCREASE_API_KEY")), // This is the default and can be omitted
	)
	digitalCardProfile, err := client.DigitalCardProfiles.Clone(
		context.TODO(),
		"digital_card_profile_s3puplu90f04xhcwkiga",
		increase.DigitalCardProfileCloneParams{},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", digitalCardProfile.ID)
}

package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.digitalcardprofiles.DigitalCardProfile;
import com.increase.api.models.digitalcardprofiles.DigitalCardProfileCloneParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        IncreaseClient client = IncreaseOkHttpClient.fromEnv();

        DigitalCardProfile digitalCardProfile = client.digitalCardProfiles().clone("digital_card_profile_s3puplu90f04xhcwkiga");
    }
}

package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.digitalcardprofiles.DigitalCardProfile
import com.increase.api.models.digitalcardprofiles.DigitalCardProfileCloneParams

fun main() {
    val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()

    val digitalCardProfile: DigitalCardProfile = client.digitalCardProfiles().clone("digital_card_profile_s3puplu90f04xhcwkiga")
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Increase\Client;
use Increase\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('INCREASE_API_KEY'));

try {
  $digitalCardProfile = $client->digitalCardProfiles->clone(
    'digital_card_profile_s3puplu90f04xhcwkiga',
    appIconFileID: 'app_icon_file_id',
    backgroundImageFileID: 'file_1ai913suu1zfn1pdetru',
    cardDescription: 'x',
    contactEmail: 'dev@stainless.com',
    contactPhone: 'x',
    contactWebsite: 'contact_website',
    description: 'x',
    issuerName: 'x',
    textColor: ['blue' => 0, 'green' => 0, 'red' => 0],
  );

  var_dump($digitalCardProfile);
} catch (APIException $e) {
  echo $e->getMessage();
}

using System;
using Increase.Api;
using Increase.Api.Models.DigitalCardProfiles;

IncreaseClient client = new();

DigitalCardProfileCloneParams parameters = new()
{
    DigitalCardProfileID = "digital_card_profile_s3puplu90f04xhcwkiga"
};

var digitalCardProfile = await client.DigitalCardProfiles.Clone(parameters);

Console.WriteLine(digitalCardProfile);

Parameters

digital_card_profile_id

string

Required

The identifier of the Digital Card Profile to clone.

More about Digital Card Profiles.

app_icon_file_id

string

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

More about Files.

background_image_file_id

string

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

More about Files.

card_description

string

A user-facing description for the card itself.

Between 1 and 32 characters

contact_email

string

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

Between 1 and 32 characters

contact_phone

string

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

Between 1 and 32 characters

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.

Between 1 and 200 characters

issuer_name

string

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

Between 1 and 32 characters

text_color

dictionary

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