--- title: "Search Cards" method: GET path: "/business/v2/cards" tags: ["Cards"] --- # Search Cards `GET /business/v2/cards` Endpoint to find `Cards` using filtering parameters. ## Query parameters - `type` 'wallet' | 'company' | 'employee' | 'onlineAd' | 'subscription' | 'purchase' — The type of a resource the `Card` is attached to. - `id` string — The ID of the `type` resource (it's not applicable for `company` resource; it's not required for `employees`). - `customreferenceId` string — The custom reference ID of the `type` resource. - `status` 'Normal' | 'Do not honor' | 'Lost card' | 'Stolen card' | 'Expired card' | 'Restricted card' | 'Security Violation' | 'Cardholder to contact the issuer' | 'Card Destroyed' - `groupId` string — The ID of the `Group` the `Card` is related to. - `name` string — The name of the `Card`. - `label` string — The label of the `Card`. - `p` integer — It indicates the specific page to display (the counter starts from zero). - `s` integer — It indicates the number of items per page. - `d` 'ASC' | 'DESC' — It indicates how the pages are ordered. - `props` string[] — It indicates the sorting direction applied to the above parameters. To apply a sorting on multiple parameters, set as many times the `props` parameter in the request. ## Response `200` The result is an array containing `Cards`. - Cards - `total` integer — It represents the total number of available items in the list. - `pages` integer — It represents the total number of available pages. - `page_size` integer — It represents the number of items per page. - `current_page` integer — It indicates the current page (the counter starts from zero). - `results_size` integer — It indicates the size of the array results. - `results` Card[] - `id` string — The `Card` ID (sortable: yes). - `name` string — The name of the `Card` (sortable: yes). - `label` string — The label of the `Card (sortable: no)`. - `masked_pan` string — The masked PAN of the `Card` (sortable: yes). - `card_holder` string — The name and surname of the Cardholder of the `Card`, only available when `owner_type` is `employee` (sortable: yes). - `expiration_date` string — The expiration date and time of the `Card` (sortable: yes). - `creation_time` string — The date and time when the `Card` was created (sortable: yes). - `last_update` string — The date and time when the `Card` was last updated (sortable: yes). - `type` 'PLASTIC' | 'VIRTUAL' | 'FUEL' | 'GOOGLE_CARD' - `status` 'Normal' | 'Do not honor' | 'Lost card' | 'Stolen card' | 'Expired card' | 'Restricted card' | 'Security Violation' | 'Cardholder to contact the issuer' | 'Card Destroyed' - `owner_type` 'company' | 'employee' - `owner_public_id` string — The ID of the Cardholder available when `owner_type` is `employee`. - `custom_reference_id` string — The custom reference ID of the Cardholder (sortable: no). - `wallet_id` string — The ID of the `Wallet` the `Card` is linked to (sortable: no). - `currency_code` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VED' | 'VEF' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL' - `emboss_line4` string — The fourth line printed on the `Card` (sortable: no). - `active` boolean — It determines whether the `Card` is active (sortable: yes). - `group_id` string — The ID of the `Group` the `Card` is related to (sortable: no). In case of multiple groups associated this field contains the first one for backward compatibility. - `groups` string[] — The list of `Group` ID the `Card` is related to (sortable: no). - `sensitive_data` CardSensitiveData - `encrypted_full_pan` string — The encrypted PAN of the card. - `encrypted_cvv` string — The encrypted cvv of the card. - `encrypted_pin` string — The encrypted pin of the card (only valid for PLASTIC or FUEL card type). - `vehicle_id` string — The ID of the `Vehicle` assigned to the card (sortable: no). - `assignees` string[] — List of `User` IDs currently assigned to the `Card`, when `owner_type` is `employee` there is only one assignee, when is `company` there could be none or more assignees (sortable: no). - `payment_method` 'SUBSCRIPTION' | 'ONLINE_ADS' | 'PURCHASE' - `payment_method_id` string — The payment method ID (sortable: no). - `preset_id` string — The `cardRulePreset` ID assigned to the `Card`. - `shipping_address_id` string — The `shippingAddress` ID assigned to the `Card`. - `renewal_info` CardRenewalInfo - `expiring_soon` boolean — Whether the `Card` is approaching its expiration date. - `renewed_card_ready_for_activation` boolean — Whether the renewed `Card` is ready to be activated. ## Other responses - `400` — Your request has missing arguments or is malformed. --- [API](https://skmtc.net/soldo/apis/soldo-business-api-v2-0.md) · [All operations](https://skmtc.net/soldo/apis/soldo-business-api-v2-0/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/soldo/soldo-business-api-v2-0/revisions/7be21448a2b3/schema)