{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Card API Documentation","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"card-api-documentation","__idx":0},"children":["Card API Documentation"]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Recommended:"]}," You can use ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://github.com/infini-money/infini-skill"},"children":["infini-skill"]}," to integrate with Infini APIs faster. The skill provides ready-to-use integration capabilities for the card API before you implement the raw requests below."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Card endpoints are used to apply for, list, query, batch-query statuses, retrieve transactions, reveal, top up, redeem, delete, freeze, and unfreeze organization cards issued to your members."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All Card API prefix:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/cards"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"card-identifier","__idx":1},"children":["Card Identifier"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The only card identifier merchants use is the internal ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}]},":"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.id"]}]}," from ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /v2/cards/apply"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cards[].id"]}]}," from ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /v2/cards/list"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}]}," passed to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /v2/cards/status"]}]},", ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /v2/cards/transactions"]}]},", ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /v2/cards/reveal"]}]},", ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /v2/cards/top-up"]}]},", ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /v2/cards/redeem"]}]},", ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /v2/cards/delete"]}]},", ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /v2/cards/freeze"]}]},", and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /v2/cards/unfreeze"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The values in ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["card_ids"]}]}," passed to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /v2/cards/status/batch"]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"authentication-and-permissions","__idx":2},"children":["Authentication and Permissions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All endpoints use HMAC-SHA256 authentication with ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Date"]}]},", ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Digest"]}]}," when the request has a body, and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization"]}]}," with ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["keyId"]}]},". See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/en/4-authorization"},"children":["Chapter 4: Authorization and Security Mechanisms"]},"."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Permission"},"children":["Permission"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Endpoints"},"children":["Endpoints"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["card.create"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /v2/cards/apply"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /v2/cards/list"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /v2/cards/status"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /v2/cards/status/batch"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /v2/cards/transactions"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /v2/cards/top-up"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /v2/cards/redeem"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /v2/cards/delete"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /v2/cards/freeze"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /v2/cards/unfreeze"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["card.reveal"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /v2/cards/reveal"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["IP whitelist:"]}," API keys that include ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["card.create"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["card.reveal"]}," must be configured with a non-empty IP whitelist when created or updated in the merchant dashboard."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"response-envelope","__idx":3},"children":["Response Envelope"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All endpoints use the standard ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["code"]}," / ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["message"]}," / ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}," envelope. Business success is indicated by ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["code === 0"]},"; a non-zero ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["code"]}," indicates an error and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["message"]}," carries the details."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"apply-card","__idx":4},"children":["Apply Card"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["POST"]}," /v2/cards/apply"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Creates a card application and initial top-up flow for an organization member."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required permission:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["card.create"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-body","__idx":5},"children":["Request Body"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["product_id"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Card product ID. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["1"]}," = Infini Lite, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["2"]}," = Infini Pro, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["102"]}," = Infini AI"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["top_up_amount"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Initial top-up amount, decimal string"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["token_type"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Token type, for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["USDT"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["USDC"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["user_email"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Organization member business account email under this merchant"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["holder_name"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Card holder name"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["card_alias"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional card alias"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"product-ids","__idx":6},"children":["Product IDs"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"product_id"},"children":["product_id"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Product"},"children":["Product"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["1"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Infini Lite"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["2"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Infini Pro"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["102"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Infini AI"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-example","__idx":7},"children":["Request Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"product_id\": 1,\n  \"top_up_amount\": \"100.00\",\n  \"token_type\": \"USDT\",\n  \"user_email\": \"jane@example.com\",\n  \"holder_name\": \"Jane Doe\",\n  \"card_alias\": \"Travel card\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"response-example","__idx":8},"children":["Response Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"code\": 0,\n  \"message\": \"\",\n  \"data\": {\n    \"id\": \"a441831c-a5c7-4bed-8f61-793738afd5bc\",\n    \"status\": \"init\",\n    \"total_top_up_amount\": \"100.00\",\n    \"total_fee\": \"1.00\",\n    \"total_pay_amount\": \"101.00\",\n    \"message\": \"\"\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"list-cards","__idx":9},"children":["List Cards"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["GET"]}," /v2/cards/list"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returns a paginated list of organization cards for the merchant."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required permission:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["card.create"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"query-parameters","__idx":10},"children":["Query Parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["status"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Card status filter, comma-separated, for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["active,pending"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["card_alias"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Card alias filter"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["page"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Page number, starting at ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["1"]},"; default ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["1"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["page_size"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Items per page, max ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["100"]},"; default ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["20"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"response-example-1","__idx":11},"children":["Response Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"code\": 0,\n  \"message\": \"\",\n  \"data\": {\n    \"cards\": [\n      {\n        \"id\": \"a441831c-a5c7-4bed-8f61-793738afd5bc\",\n        \"mask\": \"411111******1111\",\n        \"holder_name\": \"Jane Doe\",\n        \"card_alias\": \"Travel card\",\n        \"status\": \"active\",\n        \"currency\": \"USD\",\n        \"available_balance\": \"50.25\",\n        \"user_id\": \"usr_01HXYZ\",\n        \"created_at\": 1714464000,\n        \"updated_at\": 1714550400\n      }\n    ],\n    \"total\": 1,\n    \"page\": 1,\n    \"page_size\": 20,\n    \"total_pages\": 1\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"get-card-status","__idx":12},"children":["Get Card Status"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["GET"]}," /v2/cards/status?id={id}"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returns lifecycle status and summary fields for one card. After ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /v2/cards/apply"]}]},", poll until ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}]}," becomes ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["active"]}]},"."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required permission:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["card.create"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"query-parameters-1","__idx":13},"children":["Query Parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["id"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Internal card ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," from apply or list"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"response-example-2","__idx":14},"children":["Response Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"code\": 0,\n  \"message\": \"\",\n  \"data\": {\n    \"id\": \"a441831c-a5c7-4bed-8f61-793738afd5bc\",\n    \"status\": \"pending\",\n    \"card_alias\": \"Travel card\",\n    \"mask\": \"\",\n    \"holder_name\": \"Jane Doe\",\n    \"currency\": \"USD\",\n    \"available_balance\": \"0\",\n    \"user_id\": \"usr_01HXYZ\",\n    \"created_at\": 1714464000,\n    \"updated_at\": 1714464100\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"batch-get-card-statuses","__idx":15},"children":["Batch Get Card Statuses"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["POST"]}," /v2/cards/status/batch"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returns lifecycle statuses for up to 100 cards. Results follow the request order."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required permission:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["card.create"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-body-1","__idx":16},"children":["Request Body"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["card_ids"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array of strings"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Internal card IDs from apply or list; from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["1"]}," to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["100"]}," items"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-example-1","__idx":17},"children":["Request Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"card_ids\": [\n    \"a441831c-a5c7-4bed-8f61-793738afd5bc\",\n    \"b552942d-b6d8-5cef-9062-804849bfe6cd\"\n  ]\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"response-example-3","__idx":18},"children":["Response Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"code\": 0,\n  \"message\": \"\",\n  \"data\": {\n    \"cards\": [\n      {\n        \"card_id\": \"a441831c-a5c7-4bed-8f61-793738afd5bc\",\n        \"status\": \"active\"\n      },\n      {\n        \"card_id\": \"b552942d-b6d8-5cef-9062-804849bfe6cd\",\n        \"status\": \"pending\"\n      }\n    ]\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"get-card-transactions","__idx":19},"children":["Get Card Transactions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["GET"]}," /v2/cards/transactions?id={id}&page={page}&page_size={page_size}"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returns a paginated transaction list for one organization card. The response uses the merchant-facing card ID and does not expose provider transaction IDs."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required permission:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["card.create"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"query-parameters-2","__idx":20},"children":["Query Parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["id"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Internal card ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," from apply or list"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["page"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Page number, starting at ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["1"]},"; default ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["1"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["page_size"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Items per page, max ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["100"]},"; default ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["20"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"response-example-4","__idx":21},"children":["Response Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"code\": 0,\n  \"message\": \"\",\n  \"data\": {\n    \"transactions\": [\n      {\n        \"card_id\": \"a441831c-a5c7-4bed-8f61-793738afd5bc\",\n        \"type\": \"Consume\",\n        \"amount\": \"12.34\",\n        \"fee\": \"0.12\",\n        \"status\": \"Completed\",\n        \"currency\": \"USD\",\n        \"merchant\": \"Example Store\",\n        \"transaction_time\": 1710000000,\n        \"transaction_currency\": \"EUR\",\n        \"transaction_amount\": \"11.20\",\n        \"created_at\": 1710000001,\n        \"updated_at\": 1710000002,\n        \"settled_at\": 1710000003\n      }\n    ],\n    \"total\": 1,\n    \"page\": 1,\n    \"page_size\": 20,\n    \"total_pages\": 1\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"reveal-card","__idx":22},"children":["Reveal Card"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["POST"]}," /v2/cards/reveal"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returns the full PAN, CVV, and expiry. This is sensitive data; do not log or persist these values in client applications."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required permission:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["card.reveal"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-body-2","__idx":23},"children":["Request Body"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["id"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Internal card ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," from apply or list"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-example-2","__idx":24},"children":["Request Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"id\": \"a441831c-a5c7-4bed-8f61-793738afd5bc\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"response-example-5","__idx":25},"children":["Response Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"code\": 0,\n  \"message\": \"\",\n  \"data\": {\n    \"card_number\": \"4111111111111111\",\n    \"cvv\": \"123\",\n    \"expiration_mmyy\": \"1228\",\n    \"card_currency\": \"USD\"\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"top-up-card","__idx":26},"children":["Top Up Card"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["POST"]}," /v2/cards/top-up"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Adds funds to an organization card."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required permission:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["card.create"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-body-3","__idx":27},"children":["Request Body"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["id"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Internal card ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," from apply or list"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["amount"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Top-up amount"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["token_type"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Token type, for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["USDT"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["USDC"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["note"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional top-up note"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"response-example-6","__idx":28},"children":["Response Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"code\": 0,\n  \"message\": \"\",\n  \"data\": {\n    \"tx_id\": \"tx_123\",\n    \"card_balance\": \"150.25\"\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"redeem-card","__idx":29},"children":["Redeem Card"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["POST"]}," /v2/cards/redeem"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Redeems funds from an organization card."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required permission:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["card.create"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-body-4","__idx":30},"children":["Request Body"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["id"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Internal card ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," from apply or list"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["amount"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Redeem amount"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["token_type"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Token type, for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["USDT"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["USDC"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["note"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional redeem note"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"response-example-7","__idx":31},"children":["Response Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"code\": 0,\n  \"message\": \"\",\n  \"data\": {\n    \"tx_id\": \"tx_123\",\n    \"card_balance\": \"80.25\"\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"delete-card","__idx":32},"children":["Delete Card"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["POST"]}," /v2/cards/delete"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Starts asynchronous deletion of an active organization card. A successful response means the card has entered ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pending_delete"]},"; remaining card funds are settled before the final status becomes ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["deleted"]},"."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required permission:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["card.create"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-body-5","__idx":33},"children":["Request Body"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["card_id"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Internal card ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," from apply or list"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"response-example-8","__idx":34},"children":["Response Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"code\": 0,\n  \"message\": \"\",\n  \"data\": {\n    \"success\": true,\n    \"message\": \"Card deletion initiated\"\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"freeze-card","__idx":35},"children":["Freeze Card"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["POST"]}," /v2/cards/freeze"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Freezes an organization card."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required permission:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["card.create"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-body-6","__idx":36},"children":["Request Body"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["id"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Internal card ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," from apply or list"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"response-example-9","__idx":37},"children":["Response Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"code\": 0,\n  \"message\": \"\",\n  \"data\": {\n    \"success\": true,\n    \"message\": \"Card frozen\"\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"unfreeze-card","__idx":38},"children":["Unfreeze Card"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["POST"]}," /v2/cards/unfreeze"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Unfreezes an organization card."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required permission:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["card.create"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-body-7","__idx":39},"children":["Request Body"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["id"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Internal card ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," from apply or list"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"response-example-10","__idx":40},"children":["Response Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"code\": 0,\n  \"message\": \"\",\n  \"data\": {\n    \"success\": true,\n    \"message\": \"Card unfrozen\"\n  }\n}\n","lang":"json"},"children":[]}]},"headings":[{"value":"Card API Documentation","id":"card-api-documentation","depth":2},{"value":"Card Identifier","id":"card-identifier","depth":3},{"value":"Authentication and Permissions","id":"authentication-and-permissions","depth":3},{"value":"Response Envelope","id":"response-envelope","depth":3},{"value":"Apply Card","id":"apply-card","depth":3},{"value":"Request Body","id":"request-body","depth":4},{"value":"Product IDs","id":"product-ids","depth":4},{"value":"Request Example","id":"request-example","depth":4},{"value":"Response Example","id":"response-example","depth":4},{"value":"List Cards","id":"list-cards","depth":3},{"value":"Query Parameters","id":"query-parameters","depth":4},{"value":"Response Example","id":"response-example-1","depth":4},{"value":"Get Card Status","id":"get-card-status","depth":3},{"value":"Query Parameters","id":"query-parameters-1","depth":4},{"value":"Response Example","id":"response-example-2","depth":4},{"value":"Batch Get Card Statuses","id":"batch-get-card-statuses","depth":3},{"value":"Request Body","id":"request-body-1","depth":4},{"value":"Request Example","id":"request-example-1","depth":4},{"value":"Response Example","id":"response-example-3","depth":4},{"value":"Get Card Transactions","id":"get-card-transactions","depth":3},{"value":"Query Parameters","id":"query-parameters-2","depth":4},{"value":"Response Example","id":"response-example-4","depth":4},{"value":"Reveal Card","id":"reveal-card","depth":3},{"value":"Request Body","id":"request-body-2","depth":4},{"value":"Request Example","id":"request-example-2","depth":4},{"value":"Response Example","id":"response-example-5","depth":4},{"value":"Top Up Card","id":"top-up-card","depth":3},{"value":"Request Body","id":"request-body-3","depth":4},{"value":"Response Example","id":"response-example-6","depth":4},{"value":"Redeem Card","id":"redeem-card","depth":3},{"value":"Request Body","id":"request-body-4","depth":4},{"value":"Response Example","id":"response-example-7","depth":4},{"value":"Delete Card","id":"delete-card","depth":3},{"value":"Request Body","id":"request-body-5","depth":4},{"value":"Response Example","id":"response-example-8","depth":4},{"value":"Freeze Card","id":"freeze-card","depth":3},{"value":"Request Body","id":"request-body-6","depth":4},{"value":"Response Example","id":"response-example-9","depth":4},{"value":"Unfreeze Card","id":"unfreeze-card","depth":3},{"value":"Request Body","id":"request-body-7","depth":4},{"value":"Response Example","id":"response-example-10","depth":4}],"frontmatter":{"seo":{"title":"Card API Documentation"}},"lastModified":"2026-07-29T08:19:42.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/en/card-api","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}