Ramp · Schema

Ramp Card

Schema describing a physical or virtual Ramp card.

FinanceSpend ManagementCorporate CardsExpense ManagementAccounts PayableBill PayAccountingReimbursements

Properties

Name Type Description
id string
cardholder_id string
display_name string
last_four string
state string
is_physical boolean
spending_restrictions object
View JSON Schema on GitHub

JSON Schema

ramp-card.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ramp/refs/heads/main/json-schema/ramp-card.json",
  "title": "Ramp Card",
  "description": "Schema describing a physical or virtual Ramp card.",
  "type": "object",
  "properties": {
    "id": { "type": "string" },
    "cardholder_id": { "type": "string" },
    "display_name": { "type": "string" },
    "last_four": { "type": "string", "minLength": 4, "maxLength": 4 },
    "state": { "type": "string", "enum": ["ACTIVE", "SUSPENDED", "TERMINATED", "UNACTIVATED"] },
    "is_physical": { "type": "boolean" },
    "spending_restrictions": {
      "type": "object",
      "properties": {
        "amount": { "type": "number" },
        "interval": { "type": "string", "enum": ["DAILY", "WEEKLY", "MONTHLY", "QUARTERLY", "YEARLY", "TOTAL"] }
      }
    }
  },
  "required": ["id", "state"]
}