Skip to content

Ramp: Physical card schemas

11 Ramp schemas with complete fields and constraints.

← Physical card operations · All schemas

Create a physical card — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
automatic_routing_enabledbooleanOptionalSet to true to enable automatic routing. Can only be set if this card is the primary card of a user. If this field is set to True, fund_id cannot be set.
fund_idJSONOptional
fund_id (anyOf 1)stringAlternativeSpecify id to set the fund this card is associated with. If set, auto_routing_enabled cannot be passed in, and will automatically be set to False.
Format: uuid
fund_id (anyOf 2)nullAlternative
shipping_addressModelRequired within parentExpand Create a physical card — request body — body shipping address
Shipping address for the physical card.
user_idstringRequired within parentID of the user receiving this card.
Format: uuid

Referenced models: Create a physical card — request body — body shipping address

Create a physical card — request body — body shipping address

FieldTypePresenceDescription and constraints
$objectRoot
address1stringRequired within parent
address2JSONOptional
address2 (anyOf 1)stringAlternative
address2 (anyOf 2)nullAlternative
citystringRequired within parent
countrystringRequired within parent
postal_codestringRequired within parent
stateJSONOptional
state (anyOf 1)stringAlternative
state (anyOf 2)nullAlternative

List physical cards — response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentResources returned in this page.
data[]ModelEach itemExpand Suspend a card — response body
pageModelRequired within parentExpand List bills — response body — page
Pagination details for this response.

Referenced models: List bills — response body — page, Suspend a card — response body

Suspend a card — response body

FieldTypePresenceDescription and constraints
$objectRoot
automatic_routing_enabledbooleanOptionalWhether automatic routing is enabled
cardholder_idstringOptionalUnique identifier of the card holder.
Format: uuid
cardholder_namestringOptionalCard holder's full name.
created_atstringOptionalDate time at which the card is created. It conforms to ISO8601 format
Format: date-time
display_namestringRequired within parentCosmetic display name of the card.
Read only: true
expirationstringRequired within parentExpiration date in the format of MMYY.
Read only: true
fulfillmentJSONRequired within parent
fulfillment (anyOf 1)ModelAlternativeExpand Suspend a card — response body — fulfillment / fulfillment_status: DELIVERED, DIGITALLY PRESENTED, ISSUED, ORDERED, REJECTED, SHIPPED
Fulfillment details of a Ramp card. For physical cards only.
Read only: true
fulfillment (anyOf 2)nullAlternative
fund_idJSONOptional
fund_id (anyOf 1)stringAlternativeUnique identifier of the fund associated with this physical card.
Format: uuid
Read only: true
fund_id (anyOf 2)nullAlternative
has_program_overriddenbooleanRequired within parentWhether the card has overridden the default settings from its card program.
Read only: true
idstringOptionalUnique identifier of the card.
Format: uuid
is_physicalbooleanOptionalWhether this is a physical card
is_primarybooleanOptionalWhether this is a primary card for this user. This will always be True
is_suspendedbooleanRequired within parentWhether the card is suspended.
Read only: true
last_fourstringRequired within parentLast four digits of the card number.
Read only: true
statestringOptionalState of the card
Known values: ACTIVE, CHIP_LOCKED, SUSPENDED, TERMINATED, UNACTIVATED

Referenced models: Suspend a card — response body — fulfillment / fulfillment_status: DELIVERED, DIGITALLY PRESENTED, ISSUED, ORDERED, REJECTED, SHIPPED

Suspend a card — response body — fulfillment / fulfillment_status: DELIVERED, DIGITALLY PRESENTED, ISSUED, ORDERED, REJECTED, SHIPPED

FieldTypePresenceDescription and constraints
$objectRoot
card_personalizationModelOptionalExpand Suspend a card — response body — fulfillment / fulfillment_status: DELIVERED, DIGITALLY PRESENTED, ISSUED, ORDERED, REJECTED, SHIPPED card personalization
cardholder_uuidJSONOptional
cardholder_uuid (anyOf 1)stringAlternativeFormat: uuid
cardholder_uuid (anyOf 2)nullAlternative
fulfillment_statusstringOptionalFulfillment status of the card
Known values: DELIVERED, DIGITALLY_PRESENTED, ISSUED, ORDERED, REJECTED, SHIPPED
shippingModelOptionalExpand Suspend a card — response body — fulfillment / fulfillment_status: DELIVERED, DIGITALLY PRESENTED, ISSUED, ORDERED, REJECTED, SHIPPED shipping
shipping_datestringOptionalDate on which the card is shipped out, presented in ISO8601 format
Format: date-time
shipping_etastringOptionalEstimated arrival time, presented in ISO8601 format
Format: date-time
shipping_tracking_urlstringOptionalTracking url

Referenced models: Suspend a card — response body — fulfillment / fulfillment_status: DELIVERED, DIGITALLY PRESENTED, ISSUED, ORDERED, REJECTED, SHIPPED card personalization, Suspend a card — response body — fulfillment / fulfillment_status: DELIVERED, DIGITALLY PRESENTED, ISSUED, ORDERED, REJECTED, SHIPPED shipping

Suspend a card — response body — fulfillment / fulfillment_status: DELIVERED, DIGITALLY PRESENTED, ISSUED, ORDERED, REJECTED, SHIPPED card personalization

FieldTypePresenceDescription and constraints
$objectRoot
textModelOptionalExpand Suspend a card — response body — fulfillment / fulfillment_status: DELIVERED, DIGITALLY PRESENTED, ISSUED, ORDERED, REJECTED, SHIPPED card personalization text

Referenced models: Suspend a card — response body — fulfillment / fulfillment_status: DELIVERED, DIGITALLY PRESENTED, ISSUED, ORDERED, REJECTED, SHIPPED card personalization text

Suspend a card — response body — fulfillment / fulfillment_status: DELIVERED, DIGITALLY PRESENTED, ISSUED, ORDERED, REJECTED, SHIPPED card personalization text

FieldTypePresenceDescription and constraints
$objectRoot
name_line_1ModelOptionalExpand Suspend a card — response body — fulfillment / fulfillment_status: DELIVERED, DIGITALLY PRESENTED, ISSUED, ORDERED, REJECTED, SHIPPED card personalization text name line 1
name_line_2ModelOptionalExpand Suspend a card — response body — fulfillment / fulfillment_status: DELIVERED, DIGITALLY PRESENTED, ISSUED, ORDERED, REJECTED, SHIPPED card personalization text name line 1

Referenced models: Suspend a card — response body — fulfillment / fulfillment_status: DELIVERED, DIGITALLY PRESENTED, ISSUED, ORDERED, REJECTED, SHIPPED card personalization text name line 1

Suspend a card — response body — fulfillment / fulfillment_status: DELIVERED, DIGITALLY PRESENTED, ISSUED, ORDERED, REJECTED, SHIPPED card personalization text name line 1

FieldTypePresenceDescription and constraints
$objectRoot
valueJSONOptional
value (anyOf 1)stringAlternative
value (anyOf 2)nullAlternative

Suspend a card — response body — fulfillment / fulfillment_status: DELIVERED, DIGITALLY PRESENTED, ISSUED, ORDERED, REJECTED, SHIPPED shipping

FieldTypePresenceDescription and constraints
$objectRoot
methodJSONOptional
method (anyOf 1)stringAlternative
method (anyOf 2)nullAlternative
recipient_addressModelOptionalExpand Suspend a card — response body — fulfillment / fulfillment_status: DELIVERED, DIGITALLY PRESENTED, ISSUED, ORDERED, REJECTED, SHIPPED shipping recipient address
recipient_address_verification_stateJSONOptional
recipient_address_verification_state (anyOf 1)stringAlternativeKnown values: NOT_VERIFIED, OVERRIDEN, VERIFIED
recipient_address_verification_state (anyOf 2)nullAlternative
return_addressJSONOptional
return_address (anyOf 1)ModelAlternativeExpand Suspend a card — response body — fulfillment / fulfillment_status: DELIVERED, DIGITALLY PRESENTED, ISSUED, ORDERED, REJECTED, SHIPPED shipping recipient address
return_address (anyOf 2)nullAlternative

Referenced models: Suspend a card — response body — fulfillment / fulfillment_status: DELIVERED, DIGITALLY PRESENTED, ISSUED, ORDERED, REJECTED, SHIPPED shipping recipient address

Suspend a card — response body — fulfillment / fulfillment_status: DELIVERED, DIGITALLY PRESENTED, ISSUED, ORDERED, REJECTED, SHIPPED shipping recipient address

FieldTypePresenceDescription and constraints
$objectRoot
address1stringRequired within parent
address2JSONOptional
address2 (anyOf 1)stringAlternative
address2 (anyOf 2)nullAlternative
citystringRequired within parent
countrystringRequired within parent
first_namestringRequired within parentMaximum length: 50
last_namestringRequired within parentMaximum length: 50
phoneJSONOptional
phone (anyOf 1)stringAlternative
phone (anyOf 2)nullAlternative
postal_codestringRequired within parent
stateJSONOptional
state (anyOf 1)stringAlternative
state (anyOf 2)nullAlternative

Update a physical card — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
automatic_routing_enabledbooleanOptionalSet to true to enable automatic routing. Can only be set if this card is the primary card of a user. If this field is set to True, fund_id cannot be set.
display_namestringOptionalCosmetic display name of the card. If a card is associated with a single spend limit, its display name will use the spend limit's display name.
fund_idJSONOptional
fund_id (anyOf 1)stringAlternativeSpecify id to set the fund this card is associated with. If set, auto_routing_enabled cannot be passed in, and will automatically be set to False.
Format: uuid
fund_id (anyOf 2)nullAlternative

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.