Ramp: Physical card schemas
11 Ramp schemas with complete fields and constraints.
← Physical card operations · All schemas
Create a physical card — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
automatic_routing_enabled | boolean | Optional | Set 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_id | JSON | Optional | |
fund_id (anyOf 1) | string | Alternative | Specify 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) | null | Alternative | |
shipping_address | Model | Required within parent | Expand Create a physical card — request body — body shipping address Shipping address for the physical card. |
user_id | string | Required within parent | ID 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address1 | string | Required within parent | |
address2 | JSON | Optional | |
address2 (anyOf 1) | string | Alternative | |
address2 (anyOf 2) | null | Alternative | |
city | string | Required within parent | |
country | string | Required within parent | |
postal_code | string | Required within parent | |
state | JSON | Optional | |
state (anyOf 1) | string | Alternative | |
state (anyOf 2) | null | Alternative |
List physical cards — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Resources returned in this page. |
data[] | Model | Each item | Expand Suspend a card — response body |
page | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
automatic_routing_enabled | boolean | Optional | Whether automatic routing is enabled |
cardholder_id | string | Optional | Unique identifier of the card holder. Format: uuid |
cardholder_name | string | Optional | Card holder's full name. |
created_at | string | Optional | Date time at which the card is created. It conforms to ISO8601 format Format: date-time |
display_name | string | Required within parent | Cosmetic display name of the card. Read only: true |
expiration | string | Required within parent | Expiration date in the format of MMYY. Read only: true |
fulfillment | JSON | Required within parent | |
fulfillment (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
fund_id | JSON | Optional | |
fund_id (anyOf 1) | string | Alternative | Unique identifier of the fund associated with this physical card. Format: uuid Read only: true |
fund_id (anyOf 2) | null | Alternative | |
has_program_overridden | boolean | Required within parent | Whether the card has overridden the default settings from its card program. Read only: true |
id | string | Optional | Unique identifier of the card. Format: uuid |
is_physical | boolean | Optional | Whether this is a physical card |
is_primary | boolean | Optional | Whether this is a primary card for this user. This will always be True |
is_suspended | boolean | Required within parent | Whether the card is suspended. Read only: true |
last_four | string | Required within parent | Last four digits of the card number. Read only: true |
state | string | Optional | State 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
card_personalization | Model | Optional | Expand Suspend a card — response body — fulfillment / fulfillment_status: DELIVERED, DIGITALLY PRESENTED, ISSUED, ORDERED, REJECTED, SHIPPED card personalization |
cardholder_uuid | JSON | Optional | |
cardholder_uuid (anyOf 1) | string | Alternative | Format: uuid |
cardholder_uuid (anyOf 2) | null | Alternative | |
fulfillment_status | string | Optional | Fulfillment status of the card Known values: DELIVERED, DIGITALLY_PRESENTED, ISSUED, ORDERED, REJECTED, SHIPPED |
shipping | Model | Optional | Expand Suspend a card — response body — fulfillment / fulfillment_status: DELIVERED, DIGITALLY PRESENTED, ISSUED, ORDERED, REJECTED, SHIPPED shipping |
shipping_date | string | Optional | Date on which the card is shipped out, presented in ISO8601 format Format: date-time |
shipping_eta | string | Optional | Estimated arrival time, presented in ISO8601 format Format: date-time |
shipping_tracking_url | string | Optional | Tracking 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
text | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
name_line_1 | Model | Optional | Expand Suspend a card — response body — fulfillment / fulfillment_status: DELIVERED, DIGITALLY PRESENTED, ISSUED, ORDERED, REJECTED, SHIPPED card personalization text name line 1 |
name_line_2 | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
value | JSON | Optional | |
value (anyOf 1) | string | Alternative | |
value (anyOf 2) | null | Alternative |
Suspend a card — response body — fulfillment / fulfillment_status: DELIVERED, DIGITALLY PRESENTED, ISSUED, ORDERED, REJECTED, SHIPPED shipping
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
method | JSON | Optional | |
method (anyOf 1) | string | Alternative | |
method (anyOf 2) | null | Alternative | |
recipient_address | Model | Optional | Expand Suspend a card — response body — fulfillment / fulfillment_status: DELIVERED, DIGITALLY PRESENTED, ISSUED, ORDERED, REJECTED, SHIPPED shipping recipient address |
recipient_address_verification_state | JSON | Optional | |
recipient_address_verification_state (anyOf 1) | string | Alternative | Known values: NOT_VERIFIED, OVERRIDEN, VERIFIED |
recipient_address_verification_state (anyOf 2) | null | Alternative | |
return_address | JSON | Optional | |
return_address (anyOf 1) | Model | Alternative | Expand Suspend a card — response body — fulfillment / fulfillment_status: DELIVERED, DIGITALLY PRESENTED, ISSUED, ORDERED, REJECTED, SHIPPED shipping recipient address |
return_address (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address1 | string | Required within parent | |
address2 | JSON | Optional | |
address2 (anyOf 1) | string | Alternative | |
address2 (anyOf 2) | null | Alternative | |
city | string | Required within parent | |
country | string | Required within parent | |
first_name | string | Required within parent | Maximum length: 50 |
last_name | string | Required within parent | Maximum length: 50 |
phone | JSON | Optional | |
phone (anyOf 1) | string | Alternative | |
phone (anyOf 2) | null | Alternative | |
postal_code | string | Required within parent | |
state | JSON | Optional | |
state (anyOf 1) | string | Alternative | |
state (anyOf 2) | null | Alternative |
Update a physical card — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
automatic_routing_enabled | boolean | Optional | Set 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_name | string | Optional | Cosmetic 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_id | JSON | Optional | |
fund_id (anyOf 1) | string | Alternative | Specify 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) | null | Alternative |