> ## Documentation Index > Fetch the complete documentation index at: https://docs.synctera.com/llms.txt > Use this file to discover all available pages before exploring further. # List Card Products ## OpenAPI ````yaml openapi.json get /cards/products openapi: 3.0.3 info: description: >- This is the official reference documentation for Synctera APIs. If you need something specific or have a question, contact us.

license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html title: Synctera API version: 0.213.0 servers: - description: Sandbox (no real world financial impact) url: https://api-sandbox.synctera.com/v0 - description: Production url: https://api.synctera.com/v0 security: - bearerAuth: [] tags: - description: Lookup merchant information name: Merchants - description: Requests to generate simulated webhooks name: Card Webhook Simulations - description: >- Account programs define configurations for payment rails and transaction capabilities across different account types. name: Account Programs - description: Simulate receiving ACH transactions and returns name: ACH Transaction Simulations - description: Requests for risk evaluation and decisioning name: Risk Evaluations - description: Requests to link and manage External Cards name: External Cards - description: | The disclosures resource is used to track the status of disclosures and ensure that all parties have been shown the necessary disclosures to meet regulatory obligations. name: Disclosures - description: Create and manage Cash Order and Cash Deposit transfers name: Cash Orders and Deposits (alpha) - description: Requests to initiate customer verification. name: KYC Verification (deprecated) - description: Request to create and manage users name: Users - description: See balance history name: BalanceHistory - description: >- Migration mappings associate resources from an old tenant identity with a new tenant identity. name: Migration Mappings - description: | The External Account resource is used for managing links to accounts that operate outside of the Synctera ecosystem. name: External Accounts - description: Requests to create and manage account products, including fees, interest. name: Account Products - description: Requests to create and manage webhooks name: Webhooks - description: Create and manage documents. name: Documents - description: >- Create and manage same currency and multi-currency international wire transfers name: International Wires (alpha) - description: Requests for transaction risk detection name: Transaction risk - description: >- Used to configure bank accounts for which synctera accounts are considered a "subledger" to name: Bank Account - description: Request to create and manage party groups and party group members name: Party Groups - description: Requests to manage addresses name: Addresses - description: Requests to manage monitoring subscriptions and alerts for customers. name: Monitoring - description: Requests to search and manage compliance searches name: Compliance Searches - description: Requests to create and manage customers name: Customers - description: | The internal account resource is used for managing links to internal accounts where the funds are managed by integrators. name: Internal Accounts - description: Create and manage spending controls name: Spend Controls - description: Retrieve user identity information name: Identity - description: Requests to manage banks name: Banks - description: | The Disclosures resource is used to track the status of disclosures and ensure that customers have been shown the necessary disclosures to meet regulatory obligations. name: Disclosures (deprecated) - description: Create and manage wire transfers name: Wires - description: Requests to issue and manage Cards name: Cards - description: Request to create and manage edd name: Trust - description: Request to enroll, renew, or cancel watchlist monitors name: Watchlist (deprecated) - description: Endpoints for modifying or fetching posting dates name: Posting Dates - description: Transaction lines API name: transactions - description: Request to create and manage accounts name: Accounts - description: Requests to create and manage notes name: Notes - description: Account Template name: Account Templates - description: API for effective balances name: effective_balances - description: Requests to create and manage personal ID configurations name: Personal ID Configuration - description: > A natural person (individual human) that is relevant to the Synctera platform in some way: e.g. a personal customer or a director/officer/owner of a business. name: Persons - description: > Represents the relationships between parties. A relationship can exist between personal customers, business customers, or non-customer persons/organizations. name: Relationships - description: > A legal entity (corporation, partnership, etc.) that is relevant to the Synctera platform in some way: a business customer or some other organization that has an ownership share in such a business customer. name: Businesses - description: Request to create and manage payment_schedules name: Cronut - description: Requests to manage partners name: Partners - description: Request to create and manage deposits using remote deposit capture name: Remote Check Deposit - description: Requests to create and manage API keys name: API Keys - description: Requests to create and manage ban rules name: Ban Rules - description: Admin API for Middesk configuration using the tenants API keys. name: Middesk - description: Request to create and manage exclusions name: Stately - description: Request to create and manage partner configurations name: Quickstart - description: Manage contacts for bank and fintech partners name: Contacts - description: Create and manage transactions name: Transactions - description: Request to create and manage rdc configurations name: RDC Config - description: Create and manage holds name: Hold - description: Requests to create and manage roles name: Roles - description: Simulate receiving Wire transactions and returns name: Wire Transaction Simulations - description: Requests to create licenses name: Licenses - description: Requests to Admins to grant permissions to user name: Request Permissions - description: Configure vendor secrets for egress requests name: Egress Gateway Vendor Secret CRUD API - description: Requests to screen parties against sanctions watchlists name: Sanctions Screening - description: Create and manage payments name: ACH - description: Requests to calculate and manage CRR name: CRR - description: Requests to search financial institutions name: Institutions (Beta) - description: Create and manage tenant configurations name: Tenant Configs - description: Create and manage sweep configurations name: Configs - description: > Represents the compliance rules that are used to verify certain kinds of money movement. name: Compliance Rules - description: Configure webhook secrets for egress requests name: Egress Gateway Webhook Secret CRUD API - description: Create and manage transactions name: Transactions (internal) - description: History name: History - description: Create and manage EFT Canada transfers name: EFT Canada (Beta) - description: Requests to generate simulated transactions name: Card Transaction Simulations - description: Requests to initiate customer verification. name: KYC/KYB Verifications paths: /cards/products: get: tags: - Cards summary: List Card Products operationId: listCardProducts parameters: - $ref: '#/components/parameters/form_query' - $ref: '#/components/parameters/page_token' - $ref: '#/components/parameters/limit' responses: '200': content: application/json: schema: $ref: '#/components/schemas/card_product_list_response' description: List of available Card Products '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '500': $ref: '#/components/responses/internal_server_error' components: parameters: form_query: description: The format of the card in: query name: form schema: $ref: '#/components/schemas/form' page_token: in: query name: page_token schema: description: >- Optional pagination token to be provided to retrieve subsequent pages, returned from previous get example: a8937a0d type: string limit: in: query name: limit schema: default: 100 description: > Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100. example: 100 minimum: 1 type: integer schemas: card_product_list_response: allOf: - properties: card_products: description: Array of Card Products items: $ref: '#/components/schemas/card_product_response' type: array required: - card_products type: object - $ref: '#/components/schemas/paginated_response' form: description: PHYSICAL or VIRTUAL. enum: - PHYSICAL - VIRTUAL type: string card_product_response: allOf: - $ref: '#/components/schemas/card_product' - properties: three_ds_policy: $ref: '#/components/schemas/three_ds_policy' required: - three_ds_policy type: object required: - active - card_program_id - creation_time - digital_wallet_tokenization - end_date - form - id - last_modified_time - name - start_date - three_ds_policy paginated_response: properties: next_page_token: description: >- If returned, use the next_page_token to query for the next page of results. Not returned if there are no more rows. example: a8937a0d type: string title: Paginated List response type: object error: description: >- Synctera error responses in API v0 follow [RFC 7807](https://datatracker.ietf.org/doc/html/rfc7807). Following that standard, the field for a machine-readable "error code" in API v0 is `type`. In our future API v1, we are phasing out RFC 7807 and adopting a custom error format. That format will be documented in our API v1 spec. But you may see some v0 error responses with a machine-readable `code` field while we are making the transition from v0 to v1. properties: code: description: >- An optional “sneak preview” of our future API v1 error responses. This is provided to give integrators a chance to work with our future error codes. Error codes for the same error may change between v0 and v1. example: BAD_REQUEST_BODY type: string detail: description: | A human-readable string explaining this particular error. example: 'missing required fields: first_name, dob' type: string status: description: the HTTP status code for this response example: 400 type: integer title: description: > A human-readable string for this general category of error, which corresponds 1-to-1 with error types (`title` is the human-readable version of `type`). There can be multiple distinct titles for the same HTTP status code, and the same `title` can result in many different `detail` strings. This field will be removed in API v1. example: Bad Request Body type: string type: description: > A machine-readable string that identifies the error for programmatic use. This is a URI, i.e. a globally unique identifier. It is _not_ necessarily a URL, so do not expect it to resolve to a web page. You can use this whole string as an error code, or just everything after the last slash. This field will be removed in API v1. example: https://dev.synctera.com/errors/bad-request-body type: string title: Standard error response (RFC 7807 problem report) type: object card_product: allOf: - properties: active: description: Indicates whether the Card Product is active type: boolean bin_country: $ref: '#/components/schemas/country_code' bypass_risk_errors: $ref: '#/components/schemas/bypass_risk_errors' card_brand: $ref: '#/components/schemas/card_brand' card_category: $ref: '#/components/schemas/card_category' card_fulfillment_country: $ref: '#/components/schemas/country_code' card_fulfillment_provider: $ref: '#/components/schemas/card_fulfillment_provider' card_program_id: description: Card Program ID example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid type: string card_type: $ref: '#/components/schemas/card_program_type' color: description: >- Color code for dynamic card elements such as PAN and card holder name pattern: ^[0-9A-F]{6}$ type: string creation_time: description: The timestamp representing when the Card Product was created example: '2010-05-06T12:23:34.321Z' format: date-time readOnly: true type: string cross_border_enabled: $ref: '#/components/schemas/cross_border_enabled' digital_wallet_tokenization: $ref: '#/components/schemas/digital_wallet_tokenization' end_date: description: The time when the Card Product is decommissioned example: '2050-06-07T21:32:43.321Z' format: date-time type: string id: description: Card Product ID example: 7d943c51-e4ff-4e57-9558-08cab6b963c7 format: uuid readOnly: true type: string image: description: >- Indicates whether or not there is an overlay image of the card product available type: boolean image_mode: $ref: '#/components/schemas/card_image_mode' issue_without_kyc: description: Allow issuing cards on this product without requiring KYC type: boolean l2l3_enabled: $ref: '#/components/schemas/l2l3_enabled' last_modified_time: description: >- The timestamp representing when the Card Product was last modified example: '2010-05-06T12:23:34.321Z' format: date-time readOnly: true type: string name: description: The name of the Card Product maxLength: 40 minLength: 1 type: string notification_language: $ref: '#/components/schemas/notification_language' orientation: description: Card orientation enum: - HORIZONTAL - VERTICAL type: string package_id: description: Card fulfillment provider’s package ID maxLength: 50 minLength: 1 type: string physical_card_format: $ref: '#/components/schemas/physical_card_format' return_address: $ref: '#/components/schemas/shipping' start_date: description: The time when the Card Product goes live example: '2010-05-06T12:23:34.321Z' format: date-time type: string txn_enhancer: $ref: '#/components/schemas/txn_enhancer' required: - active - card_program_id - name - start_date type: object - $ref: '#/components/schemas/card_format' description: Card Product three_ds_policy: description: > EMV 3-D Secure policy. Whenever a 3DS decision gateway refers to a card product, the policy for that card product is always DECISION_GATEWAY. Policy | Description ---------------- | ----------- SMS_OTP | Use the card holder's phone number on file to perform advanced authentication via SMS EXEMPT | Transactions will be exempted from advanced authentication DECISION_GATEWAY | Fintech 3DS decision gateway will decide the 3DS action for each transaction enum: - DECISION_GATEWAY - EXEMPT - SMS_OTP type: string country_code: description: ISO-3166-1 Alpha-2 country code example: US maxLength: 2 minLength: 2 type: string bypass_risk_errors: description: Allow bypassing risk engine errors. type: boolean card_brand: description: The brand of a card product enum: - MASTERCARD - VISA type: string card_category: description: The category of the card enum: - COMMERCIAL - CONSUMER type: string card_fulfillment_provider: description: card fulfillment provider for physical cards enum: - ARROWEYE - GD type: string card_program_type: description: >- The type of the card program and BIN. This includes CREDIT and PREPAID as a way to use these types of products prior to v1 being available. Until v1 card program and BIN APIs are available you can create CREDIT and PREPAID BINs and card programs using the v1 API. Note that dealing with CREDIT and PREPAID cards requires the v1 API. enum: - CREDIT - DEBIT - PREPAID type: string cross_border_enabled: default: false description: > Enable/Disable cross border transaction - transaction will be automatically declined when merchant country is different than BIN country when disabled. Cross-Border transaction are disabled by default. type: boolean digital_wallet_tokenization: properties: card_art_id: description: >- Specifies the digital wallet card art identifier for the card product. type: string provisioning_controls: $ref: '#/components/schemas/provisioning_controls' type: object card_image_mode: description: > The image mode of a card product. If the card product supports custom card images, this value determines how the images will be handled during card issuance. REQUIRED means that cards issued with this card product must have the ID of an image that has been uploaded. Note that the image does not necessarily have to have been approved prior to the issuance request. This mode is currently disabled. REQUIRED_APPROVED_FIRST means that cards issued with this card product must have the ID of an image that has been uploaded and approved. enum: - REQUIRED - REQUIRED_APPROVED_FIRST type: string l2l3_enabled: default: false description: > Enable/Disable l2l3 transaction - L2l3 transaction are disabled by default. type: boolean notification_language: description: >- Specifies the language for 3D Secure and digital wallet token notifications sent to cardholders. By default, notifications are sent in English. Limited list of ISO 639-3 languages codes are supported. enum: - ces - deu - ell - eng - fra - ita - nld - pol - por - ron - spa type: string physical_card_format: description: The format of a physical card product enum: - CHIP - CONTACT - CONTACTLESS - MAGNETIC_STRIPE - PHYSICAL_COMBO type: string shipping: description: >- Details about the shipping method. If supplied this will override the default shipping address of the customer or account. properties: address: allOf: - $ref: '#/components/schemas/address1' description: >- The address to which the card will be shipped - Defaults to account shipping address if none supplied care_of_line: description: The name of the person to send in care of type: string is_expedited_fulfillment: default: false deprecated: true description: Is the shipment expedited type: boolean method: default: LOCAL_MAIL description: > The shipping method. * `INTERNATIONAL_GROUND` is only available for addresses in Canada and Mexico. enum: - INTERNATIONAL - INTERNATIONAL_GROUND - INTERNATIONAL_PRIORITY - LOCAL_MAIL - LOCAL_PRIORITY - OVERNIGHT - TWO_DAY example: LOCAL_MAIL type: string phone_number: description: The phone number of the recipient example: '+14374570680' pattern: ^\+[1-9]\d{1,14}$ type: string recipient_name: $ref: '#/components/schemas/recipient_name' type: object txn_enhancer: default: MX description: >- Whether to use a transaction enhancer and/or which vendor to use. Enhancer is a third party service that provides additional data for card transactions. MX is included by default. enum: - MX - NONE example: NONE type: string card_format: properties: form: description: PHYSICAL or VIRTUAL. enum: - PHYSICAL - VIRTUAL type: string required: - form type: object provisioning_controls: properties: in_app_provisioning: $ref: '#/components/schemas/in_app_provisioning' manual_entry: $ref: '#/components/schemas/manual_entry' wallet_provider_card_on_file: $ref: '#/components/schemas/wallet_provider_card_on_file' type: object address1: properties: address_line_1: description: Street address line 1 example: 100 Main St. maxLength: 100 type: string address_line_2: description: Street address line 2 example: Suite 99 maxLength: 100 type: string city: description: City example: New York type: string country_code: description: ISO-3166-1 Alpha-2 country code example: US type: string postal_code: description: Postal code example: '49633' type: string state: description: State, region, province, or prefecture example: NY type: string required: - address_line_1 - city - country_code - postal_code - state type: object recipient_name: description: The name of the recipient to whom the card will be shipped properties: first_name: example: Jane maxLength: 30 type: string last_name: example: Smith maxLength: 30 type: string middle_name: example: Anne maxLength: 30 type: string required: - first_name - last_name type: object in_app_provisioning: properties: address_verification: $ref: '#/components/schemas/digital_wallet_token_address_verification' enabled: type: boolean type: object manual_entry: properties: address_verification: $ref: '#/components/schemas/digital_wallet_token_address_verification' enabled: type: boolean type: object wallet_provider_card_on_file: properties: address_verification: $ref: '#/components/schemas/digital_wallet_token_address_verification' enabled: type: boolean type: object digital_wallet_token_address_verification: properties: validate: example: false type: boolean type: object responses: unauthorized: content: application/problem+json: schema: $ref: '#/components/schemas/error' description: Unauthorized forbidden: content: application/problem+json: schema: $ref: '#/components/schemas/error' description: Forbidden error internal_server_error: content: application/problem+json: schema: $ref: '#/components/schemas/error' description: Internal server error securitySchemes: bearerAuth: bearerFormat: api_key scheme: bearer type: http ````