> ## Documentation Index > Fetch the complete documentation index at: https://docs.slash.com/llms.txt > Use this file to discover all available pages before exploring further. # Request a card > Ask for a card for yourself. An approver decides in Slash. ## OpenAPI ````yaml /openapi-v2.json post /v2/card-requests openapi: 3.1.0 info: title: Slash Public API V2 description: >- Send money for a Slash legal entity. Every request uses an API key. Transfer creation returns a Transfer that links its resulting transactions. version: 0.0.1 servers: - url: https://api.slash.com description: production security: - api_key: [] paths: /v2/card-requests: parameters: - name: x-legal-entity in: header required: true description: >- The legal entity to act on. Required on every request; a user API key can act on any legal entity its user has access to. schema: type: string pattern: ^le_[a-zA-Z0-9]+$ post: summary: Request a card description: Ask for a card for yourself. An approver decides in Slash. parameters: - name: X-Idempotency-Key in: header required: true description: >- Unique caller-generated key for one create request. Once an authenticated, schema-valid request reaches the operation, the key is permanently consumed for that operation and legal entity whether the operation succeeds or fails. Reusing it in that scope returns `409` and never replays a response, unlike API v1, which replays the original response for a matching key. schema: type: string minLength: 1 maxLength: 255 example: invoice-1042-attempt-1 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/card-request-create' responses: '200': description: The card request. content: application/json: schema: $ref: '#/components/schemas/card-request' '400': $ref: '#/components/responses/PublicApiV2Error400CardRequestsCreate' '401': $ref: '#/components/responses/PublicApiV2Error401Unauthorized' '403': $ref: '#/components/responses/PublicApiV2Error403CardRequestsCreate' '404': $ref: '#/components/responses/PublicApiV2Error404CardRequestsCreate' '409': $ref: '#/components/responses/PublicApiV2Error409CardRequestsCreate' '429': $ref: '#/components/responses/PublicApiV2RateLimited' '500': $ref: '#/components/responses/PublicApiV2Error500Internal' security: - api_key: [] components: schemas: card-request-create: title: CardRequestCreate oneOf: - $ref: '#/components/schemas/card-request-create-virtual' - $ref: '#/components/schemas/card-request-create-physical' discriminator: propertyName: type mapping: virtual: '#/components/schemas/card-request-create-virtual' physical: '#/components/schemas/card-request-create-physical' card-request: title: CardRequest description: A request for a card that an approver decides on in Slash. type: object properties: id: type: string description: Card request id with the `card_request_` prefix. example: card_request_2rj4l7hmrrrcv status: type: string enum: - pending - approved - rejected - canceled - expired description: >- `approved` requests issue their card shortly after; `cardId` is set once it exists. type: type: string enum: - virtual - physical name: type: string example: Ads – Meta accountId: type: string example: sa_group_2rj4l7hmrrrcv virtualAccountId: type: string example: subaccount_2rj4l7hmrrrcv cardGroupId: type: string example: card_group_2rj4l7hmrrrcv requesterUserId: type: string example: u_2rj4l7hmrrrcv requestedLimit: $ref: '#/components/schemas/card-request-limit' memo: type: string cardId: type: string description: The card issued for the request. example: c_2rj4l7hmrrrcv createdAt: type: string format: date-time resolvedAt: type: string format: date-time required: - id - status - type - name - accountId - requesterUserId - createdAt additionalProperties: false card-request-create-virtual: title: CardRequestCreateVirtual type: object properties: type: type: string enum: - virtual name: type: string minLength: 1 maxLength: 255 accountId: type: string description: >- The account to request the card on. Required when the legal entity has more than one card account. virtualAccountId: type: string description: Defaults to the account's primary virtual account. cardGroupId: type: string requestedLimit: $ref: '#/components/schemas/card-request-limit' memo: type: string maxLength: 1000 required: - type - name additionalProperties: false card-request-create-physical: title: CardRequestCreatePhysical description: Requests order plastic cards embossed with the requester's name. type: object properties: type: type: string enum: - physical name: type: string minLength: 1 maxLength: 255 accountId: type: string description: >- The account to request the card on. Required when the legal entity has more than one card account. virtualAccountId: type: string description: Defaults to the account's primary virtual account. cardGroupId: type: string requestedLimit: $ref: '#/components/schemas/card-request-limit' memo: type: string maxLength: 1000 physical: type: object properties: secondLine: type: string minLength: 1 maxLength: 19 pattern: ^[A-Za-z0-9\-'& ]+$ description: The line embossed under the requester's name. shipping: type: object properties: address: allOf: - $ref: '#/components/schemas/address' description: US addresses need a state and a postal code. service: type: string enum: - standard - express - priority default: standard description: '`priority` ships to US addresses only.' required: - address additionalProperties: false required: - shipping additionalProperties: false required: - type - name - physical additionalProperties: false card-request-limit: title: CardRequestLimit type: object properties: amount: $ref: '#/components/schemas/UsdMoney' period: type: string enum: - daily - weekly - monthly - yearly - lifetime required: - amount - period additionalProperties: false PublicApiV2ErrorCardAccountRequired: title: PublicApiV2ErrorCardAccountRequired description: >- The legal entity issues cards from more than one account, so the request must name one with `accountId`. List them with `GET /v2/accounts`. allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: type: string enum: - account_required details: type: object properties: field: type: string description: Dot path of the request field at fault. id: type: string description: The identifier that field carried, when it is one. additionalProperties: false required: - code - details PublicApiV2ErrorCardGroupInOtherAccount: title: PublicApiV2ErrorCardGroupInOtherAccount description: >- The card group holds the cards of another account or virtual account. Pick a group of the card’s virtual account. allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: type: string enum: - card_group_in_other_account details: type: object properties: field: type: string description: Dot path of the request field at fault. id: type: string description: The identifier that field carried, when it is one. additionalProperties: false required: - code - details PublicApiV2ErrorPhysicalCardsNotAvailable: title: PublicApiV2ErrorPhysicalCardsNotAvailable description: >- The account’s card program has no physical card stock. Issue a virtual card, or a physical card from another account. allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: type: string enum: - physical_cards_not_available details: type: object properties: field: type: string description: Dot path of the request field at fault. id: type: string description: The identifier that field carried, when it is one. additionalProperties: false required: - code - details PublicApiV2ErrorShippingCountryRestricted: title: PublicApiV2ErrorShippingCountryRestricted description: >- Shipping restrictions rule out the destination country. Ship to an address in another country. allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: type: string enum: - shipping_country_restricted details: type: object properties: countryCode: type: string description: The destination country. example: RU field: type: string description: Dot path of the request field at fault. id: type: string description: The identifier that field carried, when it is one. required: - countryCode additionalProperties: false required: - code - details PublicApiV2ErrorInvalidRequestShape: title: PublicApiV2ErrorInvalidRequestShape description: >- The body, query, or headers failed validation, or a required header is missing. `details` has one entry per failing location, keyed by JSON pointer or header name. allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: type: string enum: - invalid_request details: type: object properties: {} additionalProperties: type: string required: - code - details PublicApiV2ErrorUnauthorized: title: PublicApiV2ErrorUnauthorized description: API key authentication is missing or invalid. allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: type: string enum: - unauthorized details: type: object properties: {} additionalProperties: false required: - code - details PublicApiV2ErrorFeatureNotEnabled: title: PublicApiV2ErrorFeatureNotEnabled description: >- The feature this request uses is not enabled for the legal entity. Contact Slash support to enable it. allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: type: string enum: - feature_not_enabled details: type: object properties: {} additionalProperties: false required: - code - details PublicApiV2ErrorForbidden: title: PublicApiV2ErrorForbidden description: >- The credential is not permitted to perform this action on the resource. When the resource is a field of the request, `details` names that `field` and the `id` it received. allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: type: string enum: - forbidden details: type: object properties: field: type: string description: Dot path of the request field at fault. id: type: string description: The identifier that field carried, when it is one. additionalProperties: false required: - code - details PublicApiV2ErrorInternationalShippingNotEnabled: title: PublicApiV2ErrorInternationalShippingNotEnabled description: >- Physical cards ship to US addresses unless international shipping is enabled for the legal entity. Contact Slash support. allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: type: string enum: - international_shipping_not_enabled details: type: object properties: field: type: string description: Dot path of the request field at fault. id: type: string description: The identifier that field carried, when it is one. additionalProperties: false required: - code - details PublicApiV2ErrorForbiddenLegalEntity: title: PublicApiV2ErrorForbiddenLegalEntity description: The credential is not permitted to act for the selected legal entity. allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: type: string enum: - forbidden details: type: object properties: {} additionalProperties: false required: - code - details PublicApiV2ErrorNotAvailable: title: PublicApiV2ErrorNotAvailable description: >- Public API v2 is not yet available. Use [Public API v1](https://docs.slash.com/introduction) in the meantime. allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: type: string enum: - not_available details: type: object properties: {} additionalProperties: false required: - code - details PublicApiV2ErrorUserApiKeyRequired: title: PublicApiV2ErrorUserApiKeyRequired description: >- The API key is scoped to a legal entity rather than a user. Every v2 request needs a user API key, created under Settings → API keys in the Slash dashboard, together with the `x-legal-entity` header. allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: type: string enum: - user_api_key_required details: type: object properties: {} additionalProperties: false required: - code - details PublicApiV2ErrorNotFound: title: PublicApiV2ErrorNotFound description: >- No resource matches the identifier. When the identifier is a field of the request, `details` names that `field` and the `id` it received. allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: type: string enum: - not_found details: type: object properties: field: type: string description: Dot path of the request field at fault. id: type: string description: The identifier that field carried, when it is one. additionalProperties: false required: - code - details PublicApiV2ErrorCardAccountLocked: title: PublicApiV2ErrorCardAccountLocked description: >- Slash has locked the account, during a review or while it closes, so cards cannot be issued on it or changed. Contact Slash support. allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: type: string enum: - account_locked details: type: object properties: field: type: string description: Dot path of the request field at fault. id: type: string description: The identifier that field carried, when it is one. additionalProperties: false required: - code - details PublicApiV2ErrorCardGroupArchived: title: PublicApiV2ErrorCardGroupArchived description: Archived card groups cannot change or take new cards. allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: type: string enum: - card_group_archived details: type: object properties: field: type: string description: Dot path of the request field at fault. id: type: string description: The identifier that field carried, when it is one. additionalProperties: false required: - code - details PublicApiV2ErrorCardRequesterNotIssuable: title: PublicApiV2ErrorCardRequesterNotIssuable description: >- Cards on this account need the requester to have an approved profile with the card issuer. Request the card again once it is approved. allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: type: string enum: - card_requester_not_issuable details: type: object properties: {} additionalProperties: false required: - code - details PublicApiV2ErrorConflictIdempotencyKeyReused: title: PublicApiV2ErrorConflictIdempotencyKeyReused description: >- A consumed `X-Idempotency-Key` was reused; the original response is not replayed. allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: type: string enum: - conflict details: type: object properties: {} additionalProperties: false required: - code - details PublicApiV2ErrorInternal: title: PublicApiV2ErrorInternal description: >- Slash could not complete the request. Quote `referenceId` when contacting Slash support. allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: type: string enum: - internal details: type: object properties: {} additionalProperties: false required: - code - details address: title: Address type: object properties: line1: type: string minLength: 1 line2: type: string city: type: string minLength: 1 state: type: string postalCode: type: string countryCode: type: string minLength: 2 maxLength: 2 description: ISO 3166-1 alpha-2 country code. required: - line1 - city additionalProperties: false UsdMoney: type: object description: A positive USD amount expressed in cents. properties: amount: type: integer minimum: 1 description: Amount in cents. For example, `1250` represents USD 12.50. example: 1250 currency: type: string enum: - USD required: - amount - currency additionalProperties: false title: UsdMoney Error: type: object properties: code: type: string description: >- Machine-readable reason; branch on this, not on `message`. Every code an endpoint can return is listed on its reference page; the ones shared by all endpoints are explained in the Errors guide. example: invalid_request message: type: string description: >- Human-readable explanation, safe to show to an operator. Wording may change; use `code` and `details` programmatically. details: type: object description: >- The values behind `message`, keyed per `code`. For example `insufficient_funds` carries `available` and `requested`; `invalid_request` from contract validation carries one entry per failing field, keyed by JSON pointer. Empty when the code has no variable data. additionalProperties: type: string example: available: $120.00 requested: $500.00 referenceId: type: string description: Unique id of this failure. Quote it when contacting Slash support. example: 4001-2alj5if required: - code - message - details - referenceId additionalProperties: false title: Error responses: PublicApiV2Error400CardRequestsCreate: description: >- - `account_required` — The legal entity issues cards from more than one account, so the request must name one with `accountId`. List them with `GET /v2/accounts`. - `card_group_in_other_account` — The card group holds the cards of another account or virtual account. Pick a group of the card’s virtual account. - `physical_cards_not_available` — The account’s card program has no physical card stock. Issue a virtual card, or a physical card from another account. - `shipping_country_restricted` — Shipping restrictions rule out the destination country. Ship to an address in another country. - `invalid_request (request shape)` — The body, query, or headers failed validation, or a required header is missing. `details` has one entry per failing location, keyed by JSON pointer or header name. content: application/json: schema: anyOf: - title: account_required allOf: - $ref: '#/components/schemas/PublicApiV2ErrorCardAccountRequired' - title: card_group_in_other_account allOf: - $ref: >- #/components/schemas/PublicApiV2ErrorCardGroupInOtherAccount - title: physical_cards_not_available allOf: - $ref: >- #/components/schemas/PublicApiV2ErrorPhysicalCardsNotAvailable - title: shipping_country_restricted allOf: - $ref: >- #/components/schemas/PublicApiV2ErrorShippingCountryRestricted - title: invalid_request (request shape) allOf: - $ref: '#/components/schemas/PublicApiV2ErrorInvalidRequestShape' examples: account_required_account_id: summary: account_required (accountId) value: code: account_required message: >- accountId is required because this legal entity has more than one card account. details: field: accountId id: sa_group_2rj4l7hmrrrcv referenceId: 4001-2alj5if card_group_in_other_account_card_group_id: summary: card_group_in_other_account (cardGroupId) value: code: card_group_in_other_account message: >- The card group belongs to a different account or virtual account. details: field: cardGroupId id: card_group_2rj4l7hmrrrcv referenceId: 4001-2alj5if physical_cards_not_available_account_id: summary: physical_cards_not_available (accountId) value: code: physical_cards_not_available message: This account cannot issue physical cards. details: field: accountId id: sa_group_2rj4l7hmrrrcv referenceId: 4001-2alj5if shipping_country_restricted_physical_shipping_address_country_code: summary: >- shipping_country_restricted (physical.shipping.address.countryCode) value: code: shipping_country_restricted message: Physical cards cannot be shipped to RU. details: countryCode: RU field: physical.shipping.address.countryCode referenceId: 4001-2alj5if invalid_request_request_shape: summary: invalid_request (request shape) value: code: invalid_request message: 'Invalid `X-Idempotency-Key`: This header is required.' details: X-Idempotency-Key: This header is required. referenceId: 4001-2alj5if PublicApiV2Error401Unauthorized: description: '- `unauthorized` — API key authentication is missing or invalid.' content: application/json: schema: $ref: '#/components/schemas/PublicApiV2ErrorUnauthorized' examples: unauthorized: summary: unauthorized value: code: unauthorized message: API key authentication is missing or invalid. details: {} referenceId: 4011-2alj5if PublicApiV2Error403CardRequestsCreate: description: >- - `feature_not_enabled` — The feature this request uses is not enabled for the legal entity. Contact Slash support to enable it. - `forbidden` — The credential is not permitted to perform this action on the resource. When the resource is a field of the request, `details` names that `field` and the `id` it received. - `international_shipping_not_enabled` — Physical cards ship to US addresses unless international shipping is enabled for the legal entity. Contact Slash support. - `forbidden (legal entity)` — The credential is not permitted to act for the selected legal entity. - `not_available` — Public API v2 is not yet available. Use [Public API v1](https://docs.slash.com/introduction) in the meantime. - `user_api_key_required` — The API key is scoped to a legal entity rather than a user. Every v2 request needs a user API key, created under Settings → API keys in the Slash dashboard, together with the `x-legal-entity` header. content: application/json: schema: anyOf: - title: feature_not_enabled allOf: - $ref: '#/components/schemas/PublicApiV2ErrorFeatureNotEnabled' - title: forbidden allOf: - $ref: '#/components/schemas/PublicApiV2ErrorForbidden' - title: international_shipping_not_enabled allOf: - $ref: >- #/components/schemas/PublicApiV2ErrorInternationalShippingNotEnabled - title: forbidden (legal entity) allOf: - $ref: '#/components/schemas/PublicApiV2ErrorForbiddenLegalEntity' - title: not_available allOf: - $ref: '#/components/schemas/PublicApiV2ErrorNotAvailable' - title: user_api_key_required allOf: - $ref: '#/components/schemas/PublicApiV2ErrorUserApiKeyRequired' examples: feature_not_enabled: summary: feature_not_enabled value: code: feature_not_enabled message: >- This feature is not enabled for you. Please contact support to get it. details: {} referenceId: 4031-2alj5if forbidden_account_id: summary: forbidden (accountId) value: code: forbidden message: >- This credential is not permitted to do that on `accountId` sa_group_2rj4l7hmrrrcv. details: field: accountId id: sa_group_2rj4l7hmrrrcv referenceId: 4031-2alj5if international_shipping_not_enabled_physical_shipping_address_country_code: summary: >- international_shipping_not_enabled (physical.shipping.address.countryCode) value: code: international_shipping_not_enabled message: Shipping physical cards outside the US is not enabled. details: field: physical.shipping.address.countryCode referenceId: 4031-2alj5if forbidden_legal_entity: summary: forbidden (legal entity) value: code: forbidden message: This credential is not permitted to do that. details: {} referenceId: 4031-2alj5if not_available: summary: not_available value: code: not_available message: >- Public API v2 is not yet available. Use Public API v1 (https://docs.slash.com/introduction) in the meantime. details: {} referenceId: 4031-2alj5if user_api_key_required: summary: user_api_key_required value: code: user_api_key_required message: >- Public API v2 requires a user API key. Create one under Settings → API keys in the Slash dashboard. details: {} referenceId: 4031-2alj5if PublicApiV2Error404CardRequestsCreate: description: >- - `not_found` — No resource matches the identifier. When the identifier is a field of the request, `details` names that `field` and the `id` it received. content: application/json: schema: $ref: '#/components/schemas/PublicApiV2ErrorNotFound' examples: not_found_account_id: summary: not_found (accountId) value: code: not_found message: '`accountId` sa_group_2rj4l7hmrrrcv was not found.' details: field: accountId id: sa_group_2rj4l7hmrrrcv referenceId: 4041-2alj5if not_found_virtual_account_id: summary: not_found (virtualAccountId) value: code: not_found message: '`virtualAccountId` subaccount_2rj4l7hmrrrcv was not found.' details: field: virtualAccountId id: subaccount_2rj4l7hmrrrcv referenceId: 4041-2alj5if not_found_card_group_id: summary: not_found (cardGroupId) value: code: not_found message: '`cardGroupId` card_group_2rj4l7hmrrrcv was not found.' details: field: cardGroupId id: card_group_2rj4l7hmrrrcv referenceId: 4041-2alj5if PublicApiV2Error409CardRequestsCreate: description: >- - `account_locked` — Slash has locked the account, during a review or while it closes, so cards cannot be issued on it or changed. Contact Slash support. - `card_group_archived` — Archived card groups cannot change or take new cards. - `card_requester_not_issuable` — Cards on this account need the requester to have an approved profile with the card issuer. Request the card again once it is approved. - `conflict (idempotency key reused)` — A consumed `X-Idempotency-Key` was reused; the original response is not replayed. content: application/json: schema: anyOf: - title: account_locked allOf: - $ref: '#/components/schemas/PublicApiV2ErrorCardAccountLocked' - title: card_group_archived allOf: - $ref: '#/components/schemas/PublicApiV2ErrorCardGroupArchived' - title: card_requester_not_issuable allOf: - $ref: >- #/components/schemas/PublicApiV2ErrorCardRequesterNotIssuable - title: conflict (idempotency key reused) allOf: - $ref: >- #/components/schemas/PublicApiV2ErrorConflictIdempotencyKeyReused examples: account_locked_account_id: summary: account_locked (accountId) value: code: account_locked message: The card account is locked. details: field: accountId id: sa_group_2rj4l7hmrrrcv referenceId: 4091-2alj5if card_group_archived_card_group_id: summary: card_group_archived (cardGroupId) value: code: card_group_archived message: The card group is archived. details: field: cardGroupId id: card_group_2rj4l7hmrrrcv referenceId: 4091-2alj5if card_requester_not_issuable: summary: card_requester_not_issuable value: code: card_requester_not_issuable message: The card issuer has not approved you as a cardholder yet. details: {} referenceId: 4091-2alj5if conflict_idempotency_key_reused: summary: conflict (idempotency key reused) value: code: conflict message: >- This request has already been submitted (duplicate idempotency key). details: {} referenceId: 4091-2alj5if PublicApiV2RateLimited: description: >- The request exceeded the applicable rate limit. The response body is plain text, not the error object; clients must not depend on its wording. content: text/plain: schema: type: string example: You are rate limited PublicApiV2Error500Internal: description: >- - `internal` — Slash could not complete the request. Quote `referenceId` when contacting Slash support. content: application/json: schema: $ref: '#/components/schemas/PublicApiV2ErrorInternal' examples: internal: summary: internal value: code: internal message: >- An unexpected error occurred. If this keeps happening, contact Slash support with the reference id below. details: {} referenceId: 5001-2alj5if securitySchemes: api_key: type: apiKey name: X-API-Key in: header description: >- User API key authentication. Create a key under Settings → API keys in the Slash dashboard (https://app.slash.com/global-settings/api-keys) and send the `x-legal-entity` header naming the legal entity to act on with every request. Keys scoped to a legal entity are rejected with `403 user_api_key_required`. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.