{
  "opencollection": "1.0.0",
  "info": {
    "name": "Accounts Account Card Lifecycle API",
    "version": "v1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Card Lifecycle",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Activate card",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.sandbox.toq.io/wallet/api/customers/:customerId/cards/:cardId/activate",
            "params": [
              {
                "name": "customerId",
                "value": "cust-123",
                "type": "path",
                "description": "Unique identifier of the customer"
              },
              {
                "name": "cardId",
                "value": "card-abc123",
                "type": "path",
                "description": "Unique identifier of the card"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Activates (unfreezes) a suspended card. Requires card token for activation.\n\n**Business Context**: Called when a cardholder or administrator wants to activate a suspended card. The activation reason is determined by the requester's role (owner, director, or admin). Requires security code verification."
        },
        {
          "info": {
            "name": "Activate card with OTP verification",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.sandbox.toq.io/wallet/api/customers/:customerId/cards/:cardId/activateOTP",
            "params": [
              {
                "name": "customerId",
                "value": "cust-123",
                "type": "path",
                "description": "Unique identifier of the customer"
              },
              {
                "name": "cardId",
                "value": "card-abc123",
                "type": "path",
                "description": "Unique identifier of the card"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Activates a card using OTP (One-Time Password) verification for enhanced security.\n\n**Business Context**: Used when the banking provider requires OTP verification for card activation (e.g., first-time activation)."
        },
        {
          "info": {
            "name": "Cancel card",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.sandbox.toq.io/wallet/api/customers/:customerId/cards/:cardId/cancel",
            "params": [
              {
                "name": "customerId",
                "value": "cust-123",
                "type": "path",
                "description": "Unique identifier of the customer"
              },
              {
                "name": "cardId",
                "value": "card-abc123",
                "type": "path",
                "description": "Unique identifier of the card"
              }
            ]
          },
          "docs": "Permanently cancels a card. Unlike suspend, a cancelled card cannot be reactivated.\n\n**Business Context**: Used when permanently deactivating a card (e.g., employee termination, compromised card). The card is removed from the available cards list in the frontend but remains in the system for audit purposes."
        },
        {
          "info": {
            "name": "Get card details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.sandbox.toq.io/wallet/api/customers/:customerId/cards/:cardId",
            "params": [
              {
                "name": "customerId",
                "value": "cust-123",
                "type": "path"
              },
              {
                "name": "cardId",
                "value": "card-abc123",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieves detailed information about a specific card. Automatically syncs the card status from the banking provider to ensure consistency.\n\n**Business Context**: Called when viewing card details in the frontend application. Returns full card information including limits, status, and associated account details that are displayed to the user.\n\n**IMPORTANT - Card Limits**: The integration MUST return all card limits that are currently defined for the card (i.e. cardLimitDaily, cardLimitMonthly, car"
        },
        {
          "info": {
            "name": "Delete card",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.sandbox.toq.io/wallet/api/customers/:customerId/cards/:cardId",
            "params": [
              {
                "name": "customerId",
                "value": "",
                "type": "path"
              },
              {
                "name": "cardId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Permanently deletes a card from the system.\n\n**Business Context**: Used for complete card removal from both the system and banking provider."
        },
        {
          "info": {
            "name": "Issue a new card",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.sandbox.toq.io/wallet/api/customers/:customerId/cards",
            "params": [
              {
                "name": "customerId",
                "value": "cust-123",
                "type": "path",
                "description": "Unique identifier of the customer (top-level entity)"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates and issues a new physical or virtual card for a customer. This endpoint handles both debit and credit cards, supports custom card designs, delivery addresses, and limit configurations. The card will be created in the banking provider system.\n\n**Business Context**: Used when issuing a card to a user or creating a company card. The card details returned are displayed in the frontend application. Supports multi-company scenarios where different merchants can issue cards."
        },
        {
          "info": {
            "name": "Suspend card",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.sandbox.toq.io/wallet/api/customers/:customerId/cards/:cardId/suspend",
            "params": [
              {
                "name": "customerId",
                "value": "cust-123",
                "type": "path",
                "description": "Unique identifier of the customer"
              },
              {
                "name": "cardId",
                "value": "card-abc123",
                "type": "path",
                "description": "Unique identifier of the card"
              }
            ]
          },
          "docs": "Suspends (freezes) a card temporarily. The card can be reactivated later.\n\n**Business Context**: Called when a cardholder temporarily freezes their card (e.g., lost wallet) or when a director/admin suspends an employee's card. Requires security code verification."
        },
        {
          "info": {
            "name": "Update card details and limits",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.sandbox.toq.io/wallet/api/customers/:customerId/cards/:cardId/update",
            "params": [
              {
                "name": "customerId",
                "value": "cust-123",
                "type": "path",
                "description": "Unique identifier of the customer"
              },
              {
                "name": "cardId",
                "value": "card-abc123",
                "type": "path",
                "description": "Unique identifier of the card"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates card spending limits. This endpoint supports dynamic limit types via AdditionalParams.\n\n**Business Context**: Called when adjusting spending limits displayed in the frontend. For customers with enabled limit management, this endpoint allows updating daily, monthly, transaction, and lifetime limits. Additional custom limits (e.g., ATM limits, purchase limits) can be included via additionalProperties.\n\n**Important**: \n- This endpoint extends AdditionalParams, allowing custom limit fields t"
        },
        {
          "info": {
            "name": "Update card alias",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.sandbox.toq.io/wallet/api/customers/:customerId/cards/:cardId/alias",
            "params": [
              {
                "name": "customerId",
                "value": "cust-123",
                "type": "path",
                "description": "Unique identifier of the customer"
              },
              {
                "name": "cardId",
                "value": "card-abc123",
                "type": "path",
                "description": "Unique identifier of the card"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the friendly name (alias) of a specific card. This endpoint allows modifying only the card's display name without affecting other card properties.\n\n**Business Context**: Called when a user wants to rename their card for easier identification in the frontend application. The updated alias is displayed across all card views and helps users distinguish between multiple cards.\n\n**Important**: \n- This endpoint will only be called if the integration has the capability `hasCardAlias` set to `tr"
        },
        {
          "info": {
            "name": "Update card read-only status",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.sandbox.toq.io/wallet/api/customers/:customerId/cards/:cardId/updateReadOnly",
            "params": [
              {
                "name": "customerId",
                "value": "cust-123",
                "type": "path",
                "description": "Unique identifier of the customer"
              },
              {
                "name": "cardId",
                "value": "card-abc123",
                "type": "path",
                "description": "Unique identifier of the card"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Sets a card to read-only mode, typically used for direct debit card accounts.\n\n**Business Context**: Used when configuring cards for specific payment methods like direct debit where the card should not allow active spending."
        }
      ]
    }
  ],
  "bundled": true
}