v1 - Cards

Create card

Creates a new card. Use metadata type 'VENDOR' for vendor cards or 'EMPLOYEE' for employee cards.

post/v1/cards

Request

  • Base URL
    https://light.inc (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header Authorization
    • or HTTP bearer

Headers

X-Idempotency-Keystring

Request body

balanceAccountIdstring uuid

ID of the card balance account to associate with this card.

ownerIdstring uuid

ID of the user who will own/manage this card.

descriptionstring nullable

Optional description or memo for this card.

formFactor'PHYSICAL' | 'VIRTUAL' nullable

Card form factor. Defaults to VIRTUAL when omitted. PHYSICAL ships a plastic card and requires deliveryContact to be set. VIRTUAL must be sent with deliveryContact left null. Mismatches are rejected with PHYSICAL_CARD_DELIVERY_CONTACT_REQUIRED or VIRTUAL_CARD_DELIVERY_CONTACT_NOT_ALLOWED.

⚠️ This enum is not exhaustive; new values may be added in the future.

providerIdstring nullable

Issuer-supplied card ID, for external (non-Adyen) cards only. Prefer sending this when known, since it makes repeat imports idempotent. A synthetic ID is generated when omitted. Ignored for cards on an Adyen-backed balance account.

lastFourstring nullable

Last four digits of the card number, for external (non-Adyen) cards only. Required when the balance account is external. Ignored for cards on an Adyen-backed balance account.

cardholderNamestring nullable

Name embossed on the card, for external (non-Adyen) cards only. Required when the balance account is external. Ignored for cards on an Adyen-backed balance account.

Example request

{
  "limits": [
    {
      "currency": "USD"
    }
  ]
}

Response

default response

idstring uuid
companyEntityIdstring uuid
companyIdstring uuid
ownerIdstring uuid
cardBalanceAccountIdstring uuid
form'PHYSICAL' | 'VIRTUAL'

⚠️ This enum is not exhaustive; new values may be added in the future.

status'ACTIVE' | 'FROZEN' | 'CLOSED' | 'UPDATE_IN_PROGRESS'

⚠️ This enum is not exhaustive; new values may be added in the future.

descriptionstring
binstring
lastFourstring
cardholderNamestring
createdAtstring date-time
updatedAtstring date-time
type'VENDOR' | 'EMPLOYEE'

⚠️ This enum is not exhaustive; new values may be added in the future.

Example response

{
  "limits": [
    {
      "currency": "USD"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.