API Reference — Increase

Cards are commercial credit cards. They'll immediately work for online purchases after you create them. All cards maintain a credit limit of 100% of the Account’s available balance at the time of transaction. Funds are deducted from the Account upon transaction settlement.

The Card object

{
  "account_id": "account_in71c4amph0vgo2qllky",
  "billing_address": {
    "city": "New York",
    "line1": "33 Liberty Street",
    "line2": null,
    "postal_code": "10045",
    "state": "NY"
  },
  "created_at": "2020-01-31T23:59:59Z",
  "description": "Office Expenses",
  "digital_wallet": {
    "digital_card_profile_id": "digital_card_profile_s3puplu90f04xhcwkiga",
    "email": "user@example.com",
    "phone": "+16505046304"
  },
  "entity_id": null,
  "expiration_month": 11,
  "expiration_year": 2028,
  "id": "card_oubs0hwk5rn6knuecxg2",
  "idempotency_key": null,
  "last4": "4242",
  "status": "active",
  "type": "card"
}

Attributes

account_id

string

The identifier for the account this card belongs to.

billing_address

dictionary

The Card's billing address.

created_at

string

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

description

string

Nullable

The card's description for display purposes.

digital_wallet

dictionary

Nullable

The contact information used in the two-factor steps for digital wallet card creation. At least one field must be present to complete the digital wallet steps.

entity_id

string

Nullable

The identifier for the entity associated with this card.

expiration_month

integer

The month the card expires in M format (e.g., August is 8).

expiration_year

integer

The year the card expires in YYYY format (e.g., 2025).

string

The card 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.

last4

string

The last 4 digits of the Card's Primary Account Number.

status

enum

This indicates if payments can be made with the card.

type

string

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

List Cards

curl \
  --url "${INCREASE_URL}/cards?account_id=account_in71c4amph0vgo2qllky" \
  -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.

account_id

string

Filter Cards to ones belonging to the specified Account.

created_at.after

string

Return results after this ISO 8601 timestamp.

created_at.before

string

Return results before this ISO 8601 timestamp.

created_at.on_or_after

string

Return results on or after this ISO 8601 timestamp.

created_at.on_or_before

string

Return results on or before this ISO 8601 timestamp.

status.in

array of strings

Filter Cards by status. 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 Card

curl -X "POST" \
  --url "${INCREASE_URL}/cards" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "account_id": "account_in71c4amph0vgo2qllky",
    "description": "Card for Ian Crease"
  }'

Parameters

account_id

string

Required

The Account the card should belong to.

billing_address

dictionary

The card's billing address.

description

string

The description you choose to give the card.

200 character maximum

digital_wallet

dictionary

The contact information used in the two-factor steps for digital wallet card creation. To add the card to a digital wallet, you may supply an email or phone number with this request. Otherwise, subscribe and then action a Real Time Decision with the category digital_wallet_token_requested or digital_wallet_authentication_requested.

entity_id

string

The Entity the card belongs to. You only need to supply this in rare situations when the card is not for the Account holder.

Retrieve a Card

curl \
  --url "${INCREASE_URL}/cards/card_oubs0hwk5rn6knuecxg2" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

card_id

string

Required

The identifier of the Card.

Update a Card

curl -X "PATCH" \
  --url "${INCREASE_URL}/cards/card_oubs0hwk5rn6knuecxg2" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "description": "New description"
  }'

Parameters

card_id

string

Required

The card identifier.

billing_address

dictionary

The card's updated billing address.

description

string

The description you choose to give the card.

200 character maximum

digital_wallet

dictionary

The contact information used in the two-factor steps for digital wallet card creation. At least one field must be present to complete the digital wallet steps.

entity_id

string

The Entity the card belongs to. You only need to supply this in rare situations when the card is not for the Account holder.

status

enum

The status to update the Card with.

Retrieve sensitive details for a Card

curl \
  --url "${INCREASE_URL}/cards/card_oubs0hwk5rn6knuecxg2/details" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Returns a Card Details object:

{
  "card_id": "card_oubs0hwk5rn6knuecxg2",
  "expiration_month": 7,
  "expiration_year": 2025,
  "pin": "1234",
  "primary_account_number": "4242424242424242",
  "type": "card_details",
  "verification_code": "123"
}

Parameters

card_id

string

Required

The identifier of the Card to retrieve details for.