Update a card for an existing customer on an account

PUT /accounts/{account_id}/customers/{customer_id}/cards

Path parameters

account_id string Required

Account ID
customer_id string Required

Customer ID

Body

spend_limit integer | null

Spending limit of card (in cents). If not provided, spending is still subject to the spend limit set at the issuer processor account (if any).

Minimum value is 1.
lithic object
Hide lithic attributes Show lithic attributes object
- token string Required
  
  External identifier for card in Lithic.
- memo string
  
  Friendly name to identify the card
- state string
  
  The new state of the card. Note: "CLOSED" cannot be undone.
  
  Values are OPEN, PAUSED, or CLOSED.

Responses

200

Successfully created a new card for the customer.
Hide response attributes Show response attributes array[object] | null
- spend_limit integer | null
  
  Spending limit of card (in cents). If not provided, spending is still subject to the spend limit set at the issuer processor account (if any).
  
  Minimum value is 1.
- lithic object
  
  Hide lithic attributes Show lithic attributes object
  
  type string
  
  The type of card being returned
  
  Values are UNLOCKED, MERCHANT_LOCKED, or SINGLE_USE.
  
  state string
  
  The current state of the card
  
  Values are OPEN, PAUSED, or CLOSED.
  
  token string(uuid)
  
  Unique external identifier for the card
  
  last_four string
  
  Last four digits of the card
  
  memo string
  
  Friendly name to identify the card
- Additional properties are allowed
401

Unauthorized.
403

Forbidden.
422

Invalid input
429

Too many requests.
default

Unexpected Error.

PUT /accounts/{account_id}/customers/{customer_id}/cards

curl \
 -X PUT https://sandbox-api.canopyservicing.com/accounts/31mNprzLd2bKl6koVna68ARM/customers/jNxDp2ybR5M72LaBA83e06md/cards \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"spend_limit":8000000,"lithic":{"token":"5c7678a6-db0e-4c24-9ad4-73eb0f719724","memo":"Primary Business Card","state":"OPEN"}}'

Request example

{
  "spend_limit": 8000000,
  "lithic": {
    "token": "5c7678a6-db0e-4c24-9ad4-73eb0f719724",
    "memo": "Primary Business Card",
    "state": "OPEN"
  }
}

Request examples

{
  "spend_limit": 8000000,
  "lithic": {
    "token": "5c7678a6-db0e-4c24-9ad4-73eb0f719724",
    "memo": "Primary Business Card",
    "state": "OPEN"
  }
}

Response examples (200)

[
  {
    "spend_limit": 8000000,
    "lithic": {
      "type": "UNLOCKED",
      "state": "OPEN",
      "token": "adccd28d-532e-480b-a063-a46a77a15570",
      "last_four": "0690",
      "memo": "Conference Event Card"
    }
  }
]

Response examples (200)

[
  {
    "spend_limit": 8000000,
    "lithic": {
      "type": "UNLOCKED",
      "state": "OPEN",
      "token": "adccd28d-532e-480b-a063-a46a77a15570",
      "last_four": "0690",
      "memo": "Conference Event Card"
    }
  }
]