Private API Reference

Card Programs

A Card Program is a set of cards you offer to your users under a single brand. Increase submits each Card Program to the card network for approval before you can start issuing cards under it.

The Card Program object

{
  "created_at": "2020-01-31T23:59:59Z",
  "entity_id": "entity_n8y8tnk2p9339ti393yi",
  "id": "card_program_b9v1az87138o8lvw6fjy",
  "idempotency_key": null,
  "name": "Karat Business Credit",
  "network": "visa",
  "type": "card_program",
  "visa": {
    "description": "A credit card for small business owners.",
    "estimates": {
      "year_1": {
        "number_of_cards": 200,
        "usd_volume": 100
      },
      "year_2": {
        "number_of_cards": 200,
        "usd_volume": 100
      },
      "year_3": {
        "number_of_cards": 200,
        "usd_volume": 100
      },
      "year_4": {
        "number_of_cards": 200,
        "usd_volume": 100
      },
      "year_5": {
        "number_of_cards": 200,
        "usd_volume": 100
      }
    },
    "target_audience": "Small business owners in the United States."
  }
}

Attributes

created_at

string

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

entity_id

string

The identifier of the Entity that will offer the Card Program to its users.

More about Entities.

string

The Card Program 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.

name

string

The name you chose for the Card Program.

network

enum

The network the Card Program is offered on. Details specific to the network will be under the object with the same identifier as the network.

type

string

A constant representing the object’s type. For this resource it will always be card_program.

visa

dictionary

Nullable

The details Visa requires in order to approve the Card Program. This field will be present in the JSON response if and only if network is equal to visa.

List Card Programs

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

Returns a list response :

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

Parameters

entity_id

string

Filter Card Programs to those offered by the specified Entity.

More about Entities.

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

More parameters

Create a Card Program

curl -X "POST" \
  --url "${INCREASE_URL}/card_programs" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "entity_id": "entity_n8y8tnk2p9339ti393yi",
    "name": "Karat Business Credit",
    "network": "visa",
    "visa": {
      "description": "A credit card for small business owners.",
      "estimates": {
        "year_1": {
          "number_of_cards": 200,
          "usd_volume": 100
        },
        "year_2": {
          "number_of_cards": 200,
          "usd_volume": 100
        },
        "year_3": {
          "number_of_cards": 200,
          "usd_volume": 100
        },
        "year_4": {
          "number_of_cards": 200,
          "usd_volume": 100
        },
        "year_5": {
          "number_of_cards": 200,
          "usd_volume": 100
        }
      },
      "target_audience": "Small business owners in the United States."
    }
  }'

Parameters

entity_id

string

Required

The identifier of the Entity that will offer the Card Program to its users.

More about Entities.

name

string

Required

The name you choose for the Card Program.

Between 1 and 200 characters

network

enum

Required

The network the Card Program is offered on. Details specific to the network are required under the sub-object with the same identifier as the network.

visa

dictionary

The details Visa requires in order to approve the Card Program. Required if and only if network is visa.

Retrieve a Card Program

curl \
  --url "${INCREASE_URL}/card_programs/card_program_b9v1az87138o8lvw6fjy" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

card_program_id

string

Required

The identifier of the Card Program.