Private API Reference

Encrypted Card PINs

Cards may operate on credit, debit, or prepaid BINs. They’ll immediately work for online purchases after you create them. All cards work on a good funds model, and maintain a maximum limit of 100% of the Account’s available balance at the time of transaction. Funds are deducted from the Account upon transaction settlement.

Update a Card's PIN from an encrypted PIN

Set a Card’s PIN from a PIN that was encrypted in your end user’s browser, so that the plaintext PIN never passes through your systems. Use the Increase card PIN library to produce the encrypted_pin, passing it the identifier of this Card. Each encrypted_pin can only be submitted once, can only be used with the Card it was encrypted for, and expires 15 minutes after it is created. This returns the Card rather than its details, so that the PIN is not sent back to you.

curl -X "POST" \
  --url "${INCREASE_URL}/cards/card_oubs0hwk5rn6knuecxg2/update_encrypted_pin" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "encrypted_pin": "gV6PRtNPz0DTU0PPQrPnPQ=="
  }'

Returns a Card object:

{
  "account_id": "account_in71c4amph0vgo2qllky",
  "authorization_controls": {
    "merchant_acceptor_identifier": null,
    "merchant_category_code": {
      "allowed": null,
      "blocked": [
        {
          "code": "5734"
        }
      ]
    },
    "merchant_country": null,
    "usage": {
      "category": "multi_use",
      "multi_use": {
        "spending_limits": [
          {
            "interval": "per_month",
            "merchant_category_codes": null,
            "settlement_amount": 100000
          }
        ]
      },
      "single_use": null
    }
  },
  "billing_address": {
    "city": "New York",
    "line1": "33 Liberty Street",
    "line2": null,
    "postal_code": "10045",
    "state": "NY"
  },
  "bin": "42424242",
  "cardholder_name": {
    "first": "Ian",
    "last": "Crease",
    "middle": null
  },
  "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"
}

Parameters

card_id

string

Required

The identifier of the Card to update the PIN for.

More about Cards.

encrypted_pin

string

Required

The PIN, encrypted in your end user’s browser with the Increase card PIN library for this Card. Treat this as an opaque string.

Between 1 and 1024 characters