Retrieves card details if the card exists and belongs to a verified user.
Usage Notes:
Depending on the card’s current state, further actions may be required:
card_images_required: The cardholder must upload both front and back images before the card can be used for any transactions.
withdrawal_confirm_required: A withdrawal setup or confirmation step must be completed before withdrawals are allowed.
payment_confirm_required: Additional registration or verification is required before new payments can be made with this card.
compliance_check_required: Indicates whether KYC/KYB compliance should be checked before card payments.
is_limited: The user has reached their daily payment limit.
→ Note: When is_limited is true, no new payments can be made today using this card, but withdrawals are still permitted.
If any of the first three flags (card_images_required, withdrawal_confirm_required, or payment_confirm_required) are set to true, the card must be updated before it can be fully used.
→ Use the Update Card Endpoint to complete the necessary steps.
The Unix timestamp (in seconds) indicating when the response was generated.
Example:
1718006400
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Paywint API Documentation","colors":{"primary":"#16A34A","light":"#07C983","dark":"#15803D"},"logo":{"light":"https://mintcdn.com/paywint/EiJlm9ZH8Q15y0cZ/assets/logo/app-logo-dark.png?fit=max\u0026auto=format\u0026n=EiJlm9ZH8Q15y0cZ\u0026q=85\u0026s=f12d90d73ed14c836d511ba59f126f89","dark":"https://mintcdn.com/paywint/EiJlm9ZH8Q15y0cZ/assets/logo/app-logo-light.png?fit=max\u0026auto=format\u0026n=EiJlm9ZH8Q15y0cZ\u0026q=85\u0026s=dd0531c96945bbfd4f68f70bde733ca7"},"favicon":"https://mintcdn.com/paywint/orA5aITV2zVCFn-B/favicon.ico?fit=max\u0026auto=format\u0026n=orA5aITV2zVCFn-B\u0026q=85\u0026s=6eb5a2357ac8b399600e7997771b7068","api":{"openapi":{"source":"https://api.sandbox.paywint.com/openapi.json?v=1.0.0","directory":"api-reference"}},"navbar":{"links":[{"href":"mailto:support@paywint.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.paywint.com"}},"footer":{"socials":{"youtube":"https://www.youtube.com/@paywint","facebook":"https://www.facebook.com/paywintonline","instagram":"https://www.instagram.com/paywint","x":"https://x.com/paywint","linkedin":"https://www.linkedin.com/company/paywint","threads":"https://www.threads.net/@paywint"}},"seo":{"indexing":"all"},"fonts":{"family":"Inter","weight":400},"styling":{"eyebrows":"breadcrumbs","latex":false},"interaction":{"drilldown":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"paywint","hasAudioNarration":false,"actualSubdomain":"paywint","customDomains":["developer.paywint.com"],"gitSource":{"type":"github","owner":"paywint-developer","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae9292e38209ab1c632e1e9:success","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"API Reference","count":79},{"language":"default","tag":"Cross Border Payments","count":12},{"language":"default","tag":"Bank Accounts","count":8},{"language":"default","tag":"Payments","count":7},{"language":"default","tag":"Guidelines","count":7},{"language":"default","tag":"URL Standards","count":7},{"language":"default","tag":"Cards","count":6},{"language":"default","tag":"Payee Management","count":6},{"language":"default","tag":"KYC \u0026 KYB","count":5},{"language":"default","tag":"Payee Addresses","count":5}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/cards/get","slug":"/api-reference/cards/get","pageMetadata":{"title":"Get Card","openapi":"GET /api/platform/card/get-card/{card_id}","description":"Retrieves card details if the card exists and belongs to a verified user.\n\n**Usage Notes:**\n\nDepending on the card's current state, further actions may be required:\n\n- `card_images_required`: The cardholder must upload both front and back images before the card can be used for any transactions.\n- `withdrawal_confirm_required`: A withdrawal setup or confirmation step must be completed before withdrawals are allowed.\n- `payment_confirm_required`: Additional registration or verification is required before new payments can be made with this card.\n- `compliance_check_required`: Indicates whether KYC/KYB compliance should be checked before card payments.\n- `is_limited`: The user has reached their daily payment limit.\n → Note: When `is_limited` is `true`, no new payments can be made today using this card, but withdrawals are still permitted.\n\n\nIf any of the first three flags (`card_images_required`, `withdrawal_confirm_required`, or `payment_confirm_required`) are set to `true`, the card must be updated before it can be fully used.\u003cbr/>\n → Use the [Update Card Endpoint](/api-reference/cards/update-card) to complete the necessary steps.","href":"/api-reference/cards/get"},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n a: \"a\",\n code: \"code\",\n li: \"li\",\n p: \"p\",\n strong: \"strong\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Retrieves card details if the card exists and belongs to a verified user.\"\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Usage Notes:\"\n })\n }), \"\\n\", _jsx(_components.p, {\n children: \"Depending on the card’s current state, further actions may be required:\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"card_images_required\"\n }), \": The cardholder must upload both front and back images before the card can be used for any transactions.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"withdrawal_confirm_required\"\n }), \": A withdrawal setup or confirmation step must be completed before withdrawals are allowed.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"payment_confirm_required\"\n }), \": Additional registration or verification is required before new payments can be made with this card.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"compliance_check_required\"\n }), \": Indicates whether KYC/KYB compliance should be checked before card payments.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"is_limited\"\n }), \": The user has reached their daily payment limit.\\n→ Note: When \", _jsx(_components.code, {\n children: \"is_limited\"\n }), \" is \", _jsx(_components.code, {\n children: \"true\"\n }), \", no new payments can be made today using this card, but withdrawals are still permitted.\"]\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"If any of the first three flags (\", _jsx(_components.code, {\n children: \"card_images_required\"\n }), \", \", _jsx(_components.code, {\n children: \"withdrawal_confirm_required\"\n }), \", or \", _jsx(_components.code, {\n children: \"payment_confirm_required\"\n }), \") are set to \", _jsx(_components.code, {\n children: \"true\"\n }), \", the card must be updated before it can be fully used.\", _jsx(\"br\", {}), \"\\n→ Use the \", _jsx(_components.a, {\n href: \"/api-reference/cards/update-card\",\n children: \"Update Card Endpoint\"\n }), \" to complete the necessary steps.\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get Card","openapi":"GET /api/platform/card/get-card/{card_id}","description":"Retrieves card details if the card exists and belongs to a verified user.\n\n**Usage Notes:**\n\nDepending on the card's current state, further actions may be required:\n\n- `card_images_required`: The cardholder must upload both front and back images before the card can be used for any transactions.\n- `withdrawal_confirm_required`: A withdrawal setup or confirmation step must be completed before withdrawals are allowed.\n- `payment_confirm_required`: Additional registration or verification is required before new payments can be made with this card.\n- `compliance_check_required`: Indicates whether KYC/KYB compliance should be checked before card payments.\n- `is_limited`: The user has reached their daily payment limit.\n → Note: When `is_limited` is `true`, no new payments can be made today using this card, but withdrawals are still permitted.\n\n\nIf any of the first three flags (`card_images_required`, `withdrawal_confirm_required`, or `payment_confirm_required`) are set to `true`, the card must be updated before it can be fully used.\u003cbr/>\n → Use the [Update Card Endpoint](/api-reference/cards/update-card) to complete the necessary steps.","href":"/api-reference/cards/get"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Platform Card"],"summary":"Retrieve card details","description":"Retrieves card details if the card exists and belongs to a verified user.\n\n**Usage Notes:**\n\nDepending on the card's current state, further actions may be required:\n\n- `card_images_required`: The cardholder must upload both front and back images before the card can be used for any transactions.\n- `withdrawal_confirm_required`: A withdrawal setup or confirmation step must be completed before withdrawals are allowed.\n- `payment_confirm_required`: Additional registration or verification is required before new payments can be made with this card.\n- `compliance_check_required`: Indicates whether KYC/KYB compliance should be checked before card payments.\n- `is_limited`: The user has reached their daily payment limit.\n → Note: When `is_limited` is `true`, no new payments can be made today using this card, but withdrawals are still permitted.\n\n\nIf any of the first three flags (`card_images_required`, `withdrawal_confirm_required`, or `payment_confirm_required`) are set to `true`, the card must be updated before it can be fully used.\u003cbr/>\n → Use the [Update Card Endpoint](/api-reference/cards/update-card) to complete the necessary steps.","operationId":"get_card_api_platform_card_get_card__card_id__get","parameters":["36aeb8ce-ec13-4995-8f6c-109da14177f3","1a950435-eae0-43b5-9bb1-3e163e0d23ff","c1dd8a25-b5a4-4ae1-a203-dd1cd0af14bc"],"responses":{"200":"c9bd57b6-24ff-4c7b-bd5f-aace557d7648","422":"5609069d-7a8d-4c63-8afc-e97124274faf"},"method":"get","type":"path","servers":["44a613da-32d2-4c57-bda9-25c34c98d8e8","d63574fc-ac93-4daa-ba67-9fa825653088"],"security":[],"path":"/api/platform/card/get-card/{card_id}","baseUrlOptions":["https://api.paywint.com","https://api.sandbox.paywint.com"],"title":"Retrieve card details","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"36aeb8ce-ec13-4995-8f6c-109da14177f3":{"name":"card_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"Unique identifier (UUID) of the card to be retrieved.","title":"Card Id","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cuuid>"},"description":"Unique identifier (UUID) of the card to be retrieved.","example":"f47ac10b-****-****-****-0e02b2c3d479"},"1a950435-eae0-43b5-9bb1-3e163e0d23ff":{"name":"X-Platform-ID","in":"header","required":true,"schema":{"type":"string","format":"uuid","description":"Unique platform identifier (UUID). You receive this during onboarding. Must be sent with every API request.","title":"X-Platform-Id","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cuuid>"},"description":"Unique platform identifier (UUID). You receive this during onboarding. Must be sent with every API request."},"c1dd8a25-b5a4-4ae1-a203-dd1cd0af14bc":{"name":"X-Signature","in":"header","required":true,"schema":{"type":"string","description":"HMAC-SHA256 request signature for authentication. Use your platform secret key to compute it as: `METHOD + PATH + QUERY + BODY_HASH`.","title":"X-Signature","isRequired":true,"uniqueKey":"","typeLabel":"string"},"description":"HMAC-SHA256 request signature for authentication. Use your platform secret key to compute it as: `METHOD + PATH + QUERY + BODY_HASH`."}},"responses":{"c9bd57b6-24ff-4c7b-bd5f-aace557d7648":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean","title":"Success","description":"Indicates whether the request was processed successfully.","default":true,"example":true,"uniqueKey":"success","typeLabel":"boolean"},"message":{"type":"string","title":"Message","description":"A short, human-readable message describing the result of the request.","default":"Success","example":"Operation completed.","uniqueKey":"message","typeLabel":"string"},"data":{"oneOf":[{"type":"object","title":"PlatformCardRead","description":"The main response payload, if applicable","properties":{"user_id":{"oneOf":[{"type":"string","title":"User Id","description":"Unique identifier of the user who owns this card","format":"uuid","example":"134dd73b-e378-4a0b-bbe8-447c8b9e4b1f","uniqueKey":"data.oneOf.0.user_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","title":"User Id","description":"Unique identifier of the user who owns this card","example":"134dd73b-e378-4a0b-bbe8-447c8b9e4b1f","uniqueKey":"data.oneOf.0.user_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.user_id","typeLabel":"string\u003cuuid> | null"},"card_id":{"oneOf":[{"type":"string","title":"Card Id","description":"Unique identifier of the card","format":"uuid","example":"fe0f3346-2f9a-4c5e-b104-0b95c18417fc","uniqueKey":"data.oneOf.0.card_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","title":"Card Id","description":"Unique identifier of the card","example":"fe0f3346-2f9a-4c5e-b104-0b95c18417fc","uniqueKey":"data.oneOf.0.card_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.card_id","typeLabel":"string\u003cuuid> | null"},"card_number":{"oneOf":[{"type":"string","title":"Card Number","description":"Last 4 digits of the card number, masked for security","example":"4242","uniqueKey":"data.oneOf.0.card_number.oneOf.0","typeLabel":"string"},{"type":"null","title":"Card Number","description":"Last 4 digits of the card number, masked for security","example":"4242","uniqueKey":"data.oneOf.0.card_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.card_number","typeLabel":"string | null"},"card_exp":{"oneOf":[{"type":"string","title":"Card Exp","description":"Card expiration in MM/YYYY format","example":"12/2029","uniqueKey":"data.oneOf.0.card_exp.oneOf.0","typeLabel":"string"},{"type":"null","title":"Card Exp","description":"Card expiration in MM/YYYY format","example":"12/2029","uniqueKey":"data.oneOf.0.card_exp.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.card_exp","typeLabel":"string | null"},"card_nick_name":{"oneOf":[{"type":"string","title":"Card Nick Name","description":"Custom label assigned by the user to identify this card","example":"Primary Visa","uniqueKey":"data.oneOf.0.card_nick_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Card Nick Name","description":"Custom label assigned by the user to identify this card","example":"Primary Visa","uniqueKey":"data.oneOf.0.card_nick_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.card_nick_name","typeLabel":"string | null"},"card_type":{"oneOf":[{"type":"string","title":"CardType","description":"Card classification such as CREDIT or DEBIT","enum":["MASTERCARD","VISA","AMEX","DISCOVER","PW_MASTERCARD","PW_GIFT_MASTERCARD"],"example":"CREDIT","uniqueKey":"data.oneOf.0.card_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Card classification such as CREDIT or DEBIT","example":"CREDIT","uniqueKey":"data.oneOf.0.card_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.card_type","typeLabel":"enum\u003cstring> | null"},"first_name":{"oneOf":[{"type":"string","title":"First Name","description":"First name of the cardholder as entered during registration","example":"John","uniqueKey":"data.oneOf.0.first_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"First Name","description":"First name of the cardholder as entered during registration","example":"John","uniqueKey":"data.oneOf.0.first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"type":"string","title":"Last Name","description":"Last name of the cardholder as entered during registration","example":"Doe","uniqueKey":"data.oneOf.0.last_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Last Name","description":"Last name of the cardholder as entered during registration","example":"Doe","uniqueKey":"data.oneOf.0.last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.last_name","typeLabel":"string | null"},"address":{"oneOf":[{"type":"string","title":"Address","description":"Street address provided for cardholder verification","example":"123 Main St","uniqueKey":"data.oneOf.0.address.oneOf.0","typeLabel":"string"},{"type":"null","title":"Address","description":"Street address provided for cardholder verification","example":"123 Main St","uniqueKey":"data.oneOf.0.address.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.address","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","title":"City","description":"City associated with the cardholder's billing address","example":"New York","uniqueKey":"data.oneOf.0.city.oneOf.0","typeLabel":"string"},{"type":"null","title":"City","description":"City associated with the cardholder's billing address","example":"New York","uniqueKey":"data.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.city","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","title":"State","description":"State or region tied to the cardholder's billing address","example":"NY","uniqueKey":"data.oneOf.0.state.oneOf.0","typeLabel":"string"},{"type":"null","title":"State","description":"State or region tied to the cardholder's billing address","example":"NY","uniqueKey":"data.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.state","typeLabel":"string | null"},"zip":{"oneOf":[{"type":"string","title":"Zip","description":"ZIP or postal code from the cardholder's billing address","example":"10001","uniqueKey":"data.oneOf.0.zip.oneOf.0","typeLabel":"string"},{"type":"null","title":"Zip","description":"ZIP or postal code from the cardholder's billing address","example":"10001","uniqueKey":"data.oneOf.0.zip.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.zip","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","title":"Country","description":"Country code from the cardholder's billing address (e.g., US)","example":"US","uniqueKey":"data.oneOf.0.country.oneOf.0","typeLabel":"string"},{"type":"null","title":"Country","description":"Country code from the cardholder's billing address (e.g., US)","example":"US","uniqueKey":"data.oneOf.0.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.country","typeLabel":"string | null"},"is_blocked":{"oneOf":[{"type":"boolean","title":"Is Blocked","description":"Indicates whether the card is currently blocked from use","example":false,"uniqueKey":"data.oneOf.0.is_blocked.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Is Blocked","description":"Indicates whether the card is currently blocked from use","example":false,"uniqueKey":"data.oneOf.0.is_blocked.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.is_blocked","typeLabel":"boolean | null"},"card_image1":{"oneOf":[{"type":"string","title":"Card Image1","description":"URL of the front image of the physical card uploaded by the user.","example":"https://cdn.example.com/cards/front_134dd73b.png","uniqueKey":"data.oneOf.0.card_image1.oneOf.0","typeLabel":"string"},{"type":"null","title":"Card Image1","description":"URL of the front image of the physical card uploaded by the user.","example":"https://cdn.example.com/cards/front_134dd73b.png","uniqueKey":"data.oneOf.0.card_image1.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.card_image1","typeLabel":"string | null"},"card_image2":{"oneOf":[{"type":"string","title":"Card Image2","description":"URL of the back image of the physical card uploaded by the user.","example":"https://cdn.example.com/cards/back_134dd73b.png","uniqueKey":"data.oneOf.0.card_image2.oneOf.0","typeLabel":"string"},{"type":"null","title":"Card Image2","description":"URL of the back image of the physical card uploaded by the user.","example":"https://cdn.example.com/cards/back_134dd73b.png","uniqueKey":"data.oneOf.0.card_image2.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.card_image2","typeLabel":"string | null"},"card_images_required":{"type":"boolean","title":"Card Images Required","description":"Indicates that card images are missing or mismatched and need to be re-uploaded. See [Update Card](/api-reference/cards/update-card).","default":false,"example":false,"uniqueKey":"data.oneOf.0.card_images_required","typeLabel":"boolean"},"withdrawal_confirm_required":{"oneOf":[{"type":"boolean","title":"Withdrawal Confirm Required","description":"Indicates that the user must complete a withdrawal confirmation before using this card. See [Update Card](/api-reference/cards/update-card).","example":true,"uniqueKey":"data.oneOf.0.withdrawal_confirm_required.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Withdrawal Confirm Required","description":"Indicates that the user must complete a withdrawal confirmation before using this card. See [Update Card](/api-reference/cards/update-card).","example":true,"uniqueKey":"data.oneOf.0.withdrawal_confirm_required.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.withdrawal_confirm_required","typeLabel":"boolean | null"},"payment_confirm_required":{"oneOf":[{"type":"boolean","title":"Payment Confirm Required","description":"Set to true if the user must complete 3D Secure confirmation before making payments with this card. See [Update Card](/api-reference/cards/update-card).","example":false,"uniqueKey":"data.oneOf.0.payment_confirm_required.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Payment Confirm Required","description":"Set to true if the user must complete 3D Secure confirmation before making payments with this card. See [Update Card](/api-reference/cards/update-card).","example":false,"uniqueKey":"data.oneOf.0.payment_confirm_required.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.payment_confirm_required","typeLabel":"boolean | null"},"compliance_check_required":{"oneOf":[{"type":"boolean","title":"Compliance Check Required","description":"Indicates whether KYC/KYB compliance must be checked for card payments. This is false when either AVS or 3DS has passed.","example":true,"uniqueKey":"data.oneOf.0.compliance_check_required.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Compliance Check Required","description":"Indicates whether KYC/KYB compliance must be checked for card payments. This is false when either AVS or 3DS has passed.","example":true,"uniqueKey":"data.oneOf.0.compliance_check_required.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.compliance_check_required","typeLabel":"boolean | null"},"is_limited":{"oneOf":[{"type":"boolean","title":"Is Limited","description":"Indicates whether the user has reached their daily card usage limit","example":true,"uniqueKey":"data.oneOf.0.is_limited.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Is Limited","description":"Indicates whether the user has reached their daily card usage limit","example":true,"uniqueKey":"data.oneOf.0.is_limited.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.is_limited","typeLabel":"boolean | null"}},"uniqueKey":"data.oneOf.0","typeLabel":"PlatformCardRead · object"},{"type":"null","description":"The main response payload, if applicable","uniqueKey":"data.oneOf.1","typeLabel":"null"}],"uniqueKey":"data","typeLabel":"PlatformCardRead · object | null"},"queryGeneratedTime":{"oneOf":[{"type":"number","title":"Querygeneratedtime","description":"The Unix timestamp (in seconds) indicating when the response was generated.","default":1783679844.273462,"example":1718006400,"uniqueKey":"queryGeneratedTime.oneOf.0","typeLabel":"number"},{"type":"null","title":"Querygeneratedtime","description":"The Unix timestamp (in seconds) indicating when the response was generated.","default":1783679844.273462,"example":1718006400,"uniqueKey":"queryGeneratedTime.oneOf.1","typeLabel":"null"}],"uniqueKey":"queryGeneratedTime","typeLabel":"number | null"}},"type":"object","title":"CommonResponse[PlatformCardRead]","uniqueKey":"","typeLabel":"CommonResponse[PlatformCardRead] · object"},"examples":{"Example":{"title":"Example","value":{"success":true,"message":"Operation completed.","data":{"user_id":"134dd73b-e378-4a0b-bbe8-447c8b9e4b1f","card_id":"fe0f3346-2f9a-4c5e-b104-0b95c18417fc","card_number":"4242","card_exp":"12/2029","card_nick_name":"Primary Visa","card_type":"CREDIT","first_name":"John","last_name":"Doe","address":"123 Main St","city":"New York","state":"NY","zip":"10001","country":"US","is_blocked":false,"card_image1":"https://cdn.example.com/cards/front_134dd73b.png","card_image2":"https://cdn.example.com/cards/back_134dd73b.png","card_images_required":false,"withdrawal_confirm_required":true,"payment_confirm_required":false,"compliance_check_required":true,"is_limited":true},"queryGeneratedTime":1718006400}}},"exampleType":"generated"}},"exampleType":"generated"},"5609069d-7a8d-4c63-8afc-e97124274faf":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"oneOf":[{"type":"string","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"detail.items.[INDEX].loc.items.[INDEX]","typeLabel":"string | integer"},"type":"array","title":"Location","isRequired":true,"uniqueKey":"detail.items.[INDEX].loc","typeLabel":"(string | integer)[]"},"msg":{"type":"string","title":"Message","isRequired":true,"uniqueKey":"detail.items.[INDEX].msg","typeLabel":"string"},"type":{"type":"string","title":"Error Type","isRequired":true,"uniqueKey":"detail.items.[INDEX].type","typeLabel":"string"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError","uniqueKey":"detail.items.[INDEX]","typeLabel":"ValidationError · object"},"type":"array","title":"Detail","uniqueKey":"detail","typeLabel":"ValidationError · object[]"}},"type":"object","title":"HTTPValidationError","uniqueKey":"","typeLabel":"HTTPValidationError · object"},"examples":{"Example":{"title":"Example","value":{"detail":[{"loc":["\u003cstring>"],"msg":"\u003cstring>","type":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{},"servers":{"44a613da-32d2-4c57-bda9-25c34c98d8e8":{"url":"https://api.paywint.com"},"d63574fc-ac93-4daa-ba67-9fa825653088":{"url":"https://api.sandbox.paywint.com"}}},"originalFileLocation":"https://api.sandbox.paywint.com/openapi.json?v=1.0.0"},"subdomain":"paywint","siteName":"Paywint API Documentation","title":"Get Card - Paywint API Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-04-06T07:14:56.169Z","originalFileLocation":"api-reference/cards/get.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Retrieves card details if the card exists and belongs to a verified user. Usage Notes: Depending on the card\u0026#x27;s current state, further actions may be required: - card_images_required: The cardholder must upload both front and back images before the card can be used for any transactions. - withdrawal_confirm_required: A withdrawal setup or confirmation step must be completed before withdrawals are allowed. - payment_confirm_required: Additional registration or verification is required before new payments can be made with this card. - compliance_check_required: Indicates whether KYC/KYB compliance should be checked before card payments. - is_limited: The user has reached their daily payment limit. → Note: When is_limited is true, no new payments can be made today using this card, but withdrawals are still permitted. If any of the first three flags (card_images_required, withdrawal_confirm_required, or payment_confirm_required) are set to true, the card must be updated before it can be fully used. → Use the Update Card Endpoint to complete the necessary steps.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Paywint API Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/paywint/Rui-6qiiIEQFwPVS/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/paywint/Rui-6qiiIEQFwPVS/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/paywint/Rui-6qiiIEQFwPVS/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/paywint/Rui-6qiiIEQFwPVS/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/paywint/Rui-6qiiIEQFwPVS/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/paywint/Rui-6qiiIEQFwPVS/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/paywint/Rui-6qiiIEQFwPVS/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/paywint/Rui-6qiiIEQFwPVS/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/paywint/Rui-6qiiIEQFwPVS/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Card - Paywint API Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieves card details if the card exists and belongs to a verified user. Usage Notes: Depending on the card\u0026#x27;s current state, further actions may be required: - card_images_required: The cardholder must upload both front and back images before the card can be used for any transactions. - withdrawal_confirm_required: A withdrawal setup or confirmation step must be completed before withdrawals are allowed. - payment_confirm_required: Additional registration or verification is required before new payments can be made with this card. - compliance_check_required: Indicates whether KYC/KYB compliance should be checked before card payments. - is_limited: The user has reached their daily payment limit. → Note: When is_limited is true, no new payments can be made today using this card, but withdrawals are still permitted. If any of the first three flags (card_images_required, withdrawal_confirm_required, or payment_confirm_required) are set to true, the card must be updated before it can be fully used. → Use the Update Card Endpoint to complete the necessary steps.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Paywint API Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.paywint.com/api-reference/cards/get\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://paywint.mintlify.site/_mintlify/api/og/v2?division=Cards\u0026amp;title=Get+Card\u0026amp;description=Retrieves+card+details+if+the+card+exists+and+belongs+to+a+verified+user.%0A%0A**Usage+Notes%3A**%0A%0ADepending+on+the+card%27s+current+state%2C+further+actions+may+be+requi\u0026amp;theme=797b9154450531e0ce6f7e8b\u0026amp;signature=75c5dfb5e64c087f2feca71fe311f19a9091fa1a1681476d41e8fb8904cb04ef\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get Card - Paywint API Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieves card details if the card exists and belongs to a verified user. Usage Notes: Depending on the card\u0026#x27;s current state, further actions may be required: - card_images_required: The cardholder must upload both front and back images before the card can be used for any transactions. - withdrawal_confirm_required: A withdrawal setup or confirmation step must be completed before withdrawals are allowed. - payment_confirm_required: Additional registration or verification is required before new payments can be made with this card. - compliance_check_required: Indicates whether KYC/KYB compliance should be checked before card payments. - is_limited: The user has reached their daily payment limit. → Note: When is_limited is true, no new payments can be made today using this card, but withdrawals are still permitted. If any of the first three flags (card_images_required, withdrawal_confirm_required, or payment_confirm_required) are set to true, the card must be updated before it can be fully used. → Use the Update Card Endpoint to complete the necessary steps.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://paywint.mintlify.site/_mintlify/api/og/v2?division=Cards\u0026amp;title=Get+Card\u0026amp;description=Retrieves+card+details+if+the+card+exists+and+belongs+to+a+verified+user.%0A%0A**Usage+Notes%3A**%0A%0ADepending+on+the+card%27s+current+state%2C+further+actions+may+be+requi\u0026amp;theme=797b9154450531e0ce6f7e8b\u0026amp;signature=75c5dfb5e64c087f2feca71fe311f19a9091fa1a1681476d41e8fb8904cb04ef\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/paywint/Rui-6qiiIEQFwPVS/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Paywint API Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#16A34A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developer.paywint.com/api-reference/cards/get\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/cards/get.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developer.paywint.com/#organization\",\"name\":\"Paywint API Documentation\",\"url\":\"https://developer.paywint.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/paywint/EiJlm9ZH8Q15y0cZ/assets/logo/app-logo-dark.png?fit=max\u0026auto=format\u0026n=EiJlm9ZH8Q15y0cZ\u0026q=85\u0026s=f12d90d73ed14c836d511ba59f126f89\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developer.paywint.com#website\",\"name\":\"Paywint API Documentation\",\"url\":\"https://developer.paywint.com\",\"publisher\":{\"@id\":\"https://developer.paywint.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developer.paywint.com/api-reference/cards/get#webpage\",\"url\":\"https://developer.paywint.com/api-reference/cards/get\",\"name\":\"Get Card\",\"description\":\"Retrieves card details if the card exists and belongs to a verified user. Usage Notes: Depending on the card's current state, further actions may be required: - card_images_required: The cardholder must upload both front and back images before the card can be used for any transactions. - withdrawal_confirm_required: A withdrawal setup or confirmation step must be completed before withdrawals are allowed. - payment_confirm_required: Additional registration or verification is required before new payments can be made with this card. - compliance_check_required: Indicates whether KYC/KYB compliance should be checked before card payments. - is_limited: The user has reached their daily payment limit. → Note: When is_limited is true, no new payments can be made today using this card, but withdrawals are still permitted. If any of the first three flags (card_images_required, withdrawal_confirm_required, or payment_confirm_required) are set to true, the card must be updated before it can be fully used. → Use the Update Card Endpoint to complete the necessary steps.\",\"dateModified\":\"2026-04-06T07:14:56.169Z\",\"isPartOf\":{\"@id\":\"https://developer.paywint.com#website\"},\"breadcrumb\":{\"@id\":\"https://developer.paywint.com/api-reference/cards/get#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.paywint.com/api-reference/cards/get#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Cards\",\"item\":\"https://developer.paywint.com/api-reference/cards/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get Card\",\"item\":\"https://developer.paywint.com/api-reference/cards/get\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developer.paywint.com/api-reference/cards/get#apireference\",\"headline\":\"Get Card\",\"name\":\"Get Card\",\"description\":\"Retrieves card details if the card exists and belongs to a verified user. Usage Notes: Depending on the card's current state, further actions may be required: - card_images_required: The cardholder must upload both front and back images before the card can be used for any transactions. - withdrawal_confirm_required: A withdrawal setup or confirmation step must be completed before withdrawals are allowed. - payment_confirm_required: Additional registration or verification is required before new payments can be made with this card. - compliance_check_required: Indicates whether KYC/KYB compliance should be checked before card payments. - is_limited: The user has reached their daily payment limit. → Note: When is_limited is true, no new payments can be made today using this card, but withdrawals are still permitted. If any of the first three flags (card_images_required, withdrawal_confirm_required, or payment_confirm_required) are set to true, the card must be updated before it can be fully used. → Use the Update Card Endpoint to complete the necessary steps.\",\"url\":\"https://developer.paywint.com/api-reference/cards/get\",\"mainEntityOfPage\":{\"@id\":\"https://developer.paywint.com/api-reference/cards/get#webpage\"},\"dateModified\":\"2026-04-06T07:14:56.169Z\",\"publisher\":{\"@id\":\"https://developer.paywint.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developer.paywint.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Paywint API Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Paywint API Documentation","nav":{"global":null,"tabs":[{"tab":"Get Started","icon":"rocket","pages":[{"title":"Get Started","href":"/get-started/overview"}]},{"tab":"API Reference","icon":"square-terminal","groups":[{"group":"Users","expanded":false,"pages":[{"title":"Overview","icon":"book-open","href":"/api-reference/users/overview"},{"title":"Create User","openapi":"POST /api/platform/users/create","href":"/api-reference/users/create"},{"title":"List Users","openapi":"POST /api/platform/users/list","href":"/api-reference/users/list"},{"title":"Get User","openapi":"GET /api/platform/users/get/{user_id}","href":"/api-reference/users/get"}]},{"group":"KYC \u0026 KYB","expanded":false,"pages":[{"title":"Overview","icon":"book-open","href":"/api-reference/compliance/overview"},{"title":"Submit KYC","openapi":"GET /api/platform/persona/platform-user/inquiry/{user_id}","href":"/api-reference/compliance/kyc/create-enquiry-link"},{"title":"Get KYC","openapi":"GET /api/platform/users/kyc/{user_id}","href":"/api-reference/compliance/kyc/get"},{"title":"Submit KYB","openapi":"POST /api/platform/kyb/submit-kyb/{user_id}","href":"/api-reference/compliance/kyb/submit"},{"title":"Get KYB","openapi":"GET /api/platform/kyb/{user_id}","href":"/api-reference/compliance/kyb/get"}]},{"group":"Wallet","expanded":false,"pages":[{"title":"Overview","icon":"book-open","href":"/api-reference/wallet/overview"},{"title":"Get Wallet","openapi":"GET /api/platform/wallet/get/{user_id}","href":"/api-reference/wallet/get"},{"title":"Fund Wallet / ACH Pull","openapi":"POST /api/platform/wallet/fund-wallet/{user_id}","href":"/api-reference/wallet/fund"},{"title":"Withdraw Fund","openapi":"POST /api/platform/withdrawals/withdraw-fund/{user_id}","href":"/api-reference/wallet/withdraw"}]},{"group":"Payments","expanded":false,"pages":[{"title":"Overview","icon":"book-open","href":"/api-reference/payments/overview"},{"title":"Create Payment","openapi":"POST /api/platform/payment/create-payment","href":"/api-reference/payments/create"},{"title":"Mail Check","openapi":"POST /api/platform/payment/mail-check/{user_id}","href":"/api-reference/payments/mail-check"},{"title":"Get Payment Details","openapi":"GET /api/platform/payment/get-payment/{payment_id}","href":"/api-reference/payments/get"},{"title":"List Payments","openapi":"POST /api/platform/payment/list-payment","href":"/api-reference/payments/list"},{"title":"List User Payments","openapi":"POST /api/platform/payment/list-payment/{user_id}","href":"/api-reference/payments/list-sent"},{"title":"List User Received Payments","openapi":"POST /api/platform/payment/list-received-payment/{user_id}","href":"/api-reference/payments/list-received"}]},{"group":"Accept Payments","expanded":false,"pages":[{"title":"Overview","icon":"book-open","href":"/api-reference/payments/checkout/overview"},{"title":"Create Payment Link","openapi":"POST /api/platform/payment/create-payment-link/{user_id}","href":"/api-reference/payments/checkout/create-payment-link"},{"title":"Create Checkout SDK Token","openapi":"POST /api/checkout/token/platform","href":"/api-reference/payments/checkout/create-checkout-token"}]},{"group":"Cross Border Payments","expanded":false,"pages":[{"title":"Overview","icon":"book-open","href":"/api-reference/cross-boarder-payments/overview"},{"title":"Create a Cross-Border Payment","openapi":"POST /api/platform/cross-border/create-payment","href":"/api-reference/cross-boarder-payments/create-a-cross-border-payment"},{"title":"List Payout Banks","openapi":"GET /api/platform/cross-border/payout-banks","href":"/api-reference/cross-boarder-payments/list-payout-banks"},{"title":"Get Exchange Rates","openapi":"GET /api/platform/cross-border/rates","href":"/api-reference/cross-boarder-payments/get-exchange-rates"},{"title":"Get Payee Rules (Mandatory Fields)","openapi":"GET /api/platform/cross-border/payee-rules","href":"/api-reference/cross-boarder-payments/get-payee-rules"},{"title":"Add a Payee Address","openapi":"POST /api/platform/cross-border/payee/address/{user_id}","href":"/api-reference/cross-boarder-payments/add-payee-address"},{"title":"Get a Payee Address","openapi":"GET /api/platform/cross-border/payee/address/{user_id}/{address_id}","href":"/api-reference/cross-boarder-payments/get-a-payee-address"},{"title":"Edit a Payee Address","openapi":"PATCH /api/platform/cross-border/payee/address/{user_id}/{address_id}","href":"/api-reference/cross-boarder-payments/edit-a-payee-address"},{"title":"List Payee Addresses","openapi":"GET /api/platform/cross-border/payee/addresses/{user_id}","href":"/api-reference/cross-boarder-payments/list-payee-addresses"},{"title":"Add a Payee Bank","openapi":"POST /api/platform/cross-border/payee/bank/{user_id}","href":"/api-reference/cross-boarder-payments/add-payee-bank"},{"title":"List Payee Banks","openapi":"GET /api/platform/cross-border/payee/banks/{user_id}","href":"/api-reference/cross-boarder-payments/list-payee-banks"},{"title":"Delete a Payee Bank","openapi":"DELETE /api/platform/cross-border/payee/bank/{user_id}/{bank_uuid}","href":"/api-reference/cross-boarder-payments/delete-payee-bank"}]},{"group":"Bank Accounts","expanded":false,"pages":[{"title":"Overview","icon":"book-open","href":"/api-reference/bank-accounts/overview"},{"title":"Add Bank Account","openapi":"POST /api/platform/accounts/add-account","href":"/api-reference/bank-accounts/add"},{"title":"Get Bank Account","openapi":"GET /api/platform/accounts/get-account/{account_id}","href":"/api-reference/bank-accounts/get"},{"title":"Set Bank Account To Default","openapi":"POST /api/platform/accounts/set-default/{user_id}","href":"/api-reference/bank-accounts/set-default"},{"title":"List Bank Accounts","openapi":"GET /api/platform/accounts/list/{user_id}","href":"/api-reference/bank-accounts/list"},{"title":"Release Micro-Deposit","openapi":"POST /api/platform/accounts/release-micro-deposit/{user_id}","href":"/api-reference/bank-accounts/release-micro-deposit"},{"title":"Verify Micro-Deposit","openapi":"POST /api/platform/accounts/verify-micro-deposit/{user_id}","href":"/api-reference/bank-accounts/verify-micro-deposit"},{"title":"Delete Bank Account","openapi":"DELETE /api/platform/accounts/delete/{user_id}","href":"/api-reference/bank-accounts/delete"}]},{"group":"Paywint Bank Accounts","expanded":false,"pages":[{"title":"Overview","icon":"book-open","href":"/api-reference/paywint-bank-accounts/overview"},{"title":"Open Paywint Bank Account","openapi":"POST /api/platform/accounts/open-pw-bank-account/{user_id}","href":"/api-reference/paywint-bank-accounts/open"},{"title":"List Paywint Bank Accounts","openapi":"GET /api/platform/accounts/list-pw-banks/{user_id}","href":"/api-reference/paywint-bank-accounts/list"},{"title":"Paywint Bank Account Withdrawal","openapi":"POST /api/platform/withdrawals/transfer-from-pw-bank/{user_id}","href":"/api-reference/paywint-bank-accounts/withdrawal"},{"title":"List Paywint Bank Account Transactions","openapi":"POST /api/platform/accounts/list-pw-transactions/{user_id}","href":"/api-reference/paywint-bank-accounts/list-transactions"}]},{"group":"Cards","expanded":false,"pages":[{"title":"Overview","icon":"book-open","href":"/api-reference/cards/overview"},{"title":"Add Card","openapi":"POST /api/platform/card/add/secure-link/{user_id}","href":"/api-reference/cards/add"},{"title":"Update Card","openapi":"POST /api/platform/card/update/secure-link/{user_id}","description":"Returns a short-lived secure link to initiate the Update Card process for a user.\n\nThis endpoint:\n- Generates a secure link based on the provided `card_purpose` (PAYMENT or WITHDRAWAL)\n- The link is valid for a limited time and intended for card updation only\n\n**Usage Notes:**\n- The link expires after 30 minutes\n- Open the `secure_link` in a new browser window or iframe immediately after generation\n- Do not reuse the link or repurpose it for card editing","href":"/api-reference/cards/update"},{"title":"Get Card","openapi":"GET /api/platform/card/get-card/{card_id}","href":"/api-reference/cards/get"},{"title":"List Cards","openapi":"GET /api/platform/card/list/{user_id}","description":"Retrieve a list of all cards associated with the authenticated user.\n\n**Usage Notes:**\n\nEach returned card may include one or more status flags that indicate required user actions or usage limitations:\n\n- `card_images_required`: The cardholder must upload both front and back images before the card can be used for any transactions.\n- `withdrawal_confirm_required`: A withdrawal setup or confirmation step must be completed before withdrawals are allowed.\n- `payment_confirm_required`: Additional registration or verification is required before new payments can be made with this card.\n- `compliance_check_required`: Indicates whether KYC/KYB compliance should be checked before card payments.\n- `is_limited`: The user has reached their daily payment limit.\n → Note: No new payments can be made today using card, but withdrawals are still permitted.\n\n\nIf any of the first three flags (`card_images_required`, `withdrawal_confirm_required`, or `payment_confirm_required`) are `true`, the card must be updated before use.\u003cbr/>\n → Use the [Update Card Endpoint](/api-reference/cards/update-card) to complete the necessary steps.","href":"/api-reference/cards/list"},{"title":"Delete Card","openapi":"DELETE /api/platform/card/delete/{user_id}","href":"/api-reference/cards/delete"}]},{"group":"Check","expanded":false,"pages":[{"title":"Overview","icon":"book-open","href":"/api-reference/checks/overview"},{"title":"Add Check Address","openapi":"POST /api/platform/check/add-address/{user_id}","href":"/api-reference/checks/add-address"},{"title":"Update Check Address","openapi":"PATCH /api/platform/check/update-address/{user_id}","href":"/api-reference/checks/update-address"},{"title":"Update Check Config","openapi":"POST /api/platform/check/update-config/{user_id}","href":"/api-reference/checks/update-config"}]},{"group":"Payee Management","expanded":false,"pages":[{"title":"Overview","icon":"book-open","href":"/api-reference/payees/overview"},{"title":"Create Payee","openapi":"POST /api/platform/payee/create/{user_id}","href":"/api-reference/payees/create"},{"title":"Update Payee","openapi":"PUT /api/platform/payee/update/{user_id}","href":"/api-reference/payees/update"},{"title":"Get Payee","openapi":"POST /api/platform/payee/get/{user_id}","href":"/api-reference/payees/get"},{"title":"List Payees","openapi":"POST /api/platform/payee/list-payee/{user_id}","href":"/api-reference/payees/list"},{"title":"Delete Payee","openapi":"DELETE /api/platform/payee/delete/{user_id}","href":"/api-reference/payees/delete"}]},{"group":"Payee Bank Accounts","expanded":false,"pages":[{"title":"Overview","icon":"book-open","href":"/api-reference/payees/bank-accounts/overview"},{"title":"Add Payee Bank Account","openapi":"POST /api/platform/accounts/add-payee-account/{user_id}","href":"/api-reference/payees/bank-accounts/add"},{"title":"Get Payee Bank Account","openapi":"POST /api/platform/accounts/get-payee-account/{user_id}","href":"/api-reference/payees/bank-accounts/get"},{"title":"List Payee Bank Accounts","openapi":"POST /api/platform/accounts/list-payee-account/{user_id}","href":"/api-reference/payees/bank-accounts/list"},{"title":"Delete Payee Bank Account","openapi":"DELETE /api/platform/accounts/delete-payee-account/{user_id}","href":"/api-reference/payees/bank-accounts/delete"}]},{"group":"Payee Cards","expanded":false,"pages":[{"title":"Overview","icon":"book-open","href":"/api-reference/payees/cards/overview"},{"title":"Add Payee Card","openapi":"POST /api/platform/card/add-payee-card/{user_id}","href":"/api-reference/payees/cards/add"},{"title":"Get Payee Card","openapi":"POST /api/platform/card/get-payee-card/{user_id}","href":"/api-reference/payees/cards/get"},{"title":"List Payee Cards","openapi":"POST /api/platform/card/list-payee-card/{user_id}","href":"/api-reference/payees/cards/list"},{"title":"Delete Payee Card","openapi":"DELETE /api/platform/card/delete-payee-card/{user_id}","href":"/api-reference/payees/cards/delete"}]},{"group":"Payee Addresses","expanded":false,"pages":[{"title":"Overview","icon":"book-open","href":"/api-reference/payees/addresses/overview"},{"title":"Add Payee Address","openapi":"POST /api/platform/address/create-payee-address/{user_id}","href":"/api-reference/payees/addresses/add"},{"title":"List Payee Address","openapi":"POST /api/platform/address/list-payee-address/{user_id}","href":"/api-reference/payees/addresses/list"},{"title":"Update Payee Address","openapi":"PATCH /api/platform/address/update-payee-address/{user_id}","href":"/api-reference/payees/addresses/update"},{"title":"Delete Payee Address","openapi":"DELETE /api/platform/address/delete-payee-address/{user_id}","href":"/api-reference/payees/addresses/delete"}]}]},{"tab":"Webhooks","icon":"webhook","pages":[{"title":"Webhooks","href":"/webhooks/overview"}]},{"tab":"Guidelines","icon":"list-check","pages":[{"title":"Guidelines","href":"/guidelines/url-standards/overview"}]}]},"basePath":"","title":"Get Card - Paywint API Documentation","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C-hEh3I2.js","utils-CnF4QiUD.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C7PVNbel.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-8ytevL2A.js","snippetPresets-BT1alx3v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BLXC0i_W.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CyLIGI9_.js","shallow-DC0lGVIW.js","getApiPlaygroundDisplay-CgDQ85tN.js","CodeSnippet-6-I-Gpv9.js","CodeSnippets-BAk1kDdu.js","Page-C945cI-W.js","getPastedJson-B276RuWN.js","icon-BqP8etTm.js","MethodPill-DM6sbxG1.js","DuplicateIcon-PyJglOaE.js","createIcon-CMeOMAc_.js","DynamicMarkdown-BoyYAA8K.js","SectionHeading-DAYv3gvZ.js","axios-vUo_bRtp.js","Markdown-BhTTmazV.js","clsx-CR-RHrVC.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CBUH0-zX.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BmARFYNC.js"]}