The response has two modes, depending on whether your platform has a public key registered with Clink:
Registered public key (matched: true): Clink seals the card fields into a key/payload envelope that only your platform can decrypt with the matching private key.
No registered public key (matched: false): when plaintext mode is enabled server-side and gateway response redaction is live, Clink returns the DPAN and dynamic CVV in plaintext in the response. The card can be used directly, but these fields reach your backend in plaintext.
Register a public key with Clink to use the encrypted mode; this is recommended for production.The response sends no credential deadline: the validity is dynamicDataExpiration in card (plaintext mode) or in the decrypted payload (sealed mode).
Public key registration
Contact Clink to register your platform’s RSA public key in each environment; it is mapped to your platform client name. The registered key selects the response mode: with a key the credential is sealed to it; without one, Clink returns plaintext card fields only when plaintext mode is enabled server-side and gateway response redaction is live (the MCP-equivalent fallback). With the default gate off, the endpoint fails closed instead. Register the key before production use.
Without a registered public key, when plaintext mode is enabled server-side, the response returns the DPAN and dynamic CVV in plaintext to your backend. Keep these fields out of logs, model input, and ordinary storage, and do not keep them beyond the checkout. Register a public key with Clink (recommended for production) to switch to the sealed key/payload mode. This plaintext fallback matches MCP get_credential. Do not enable plaintext mode in environments where gateway response redaction is not yet active: it is config-gated server-side by portal-plaintext-enabled (default off), and with the gate off the endpoint fails closed with 71211012 (credential_public_key_not_configured) instead of returning plaintext card fields.
Decrypt the sealed response
When matched is true, decrypt key and payload with your platform private key. The decrypted payload contains orderId, paymentExecutionDetailId, clientReferenceId, status, the network credential (DPAN, dynamic CVV, and expiry), and cardholder and address fields. The envelope format and a decryption example are in Decryption.Keep decrypted card fields out of logs, model input, and ordinary records, and use the validity information in the decrypted payload (dynamicDataExpiration) to decide when to use the credential. Save client_reference_id; Report credential result uses it.
Idempotency
client_reference_id is the idempotency key. Retrying with the same client_reference_id returns the same credential: the same sealed envelope when matched is true, and in plaintext mode the same card from the server-side encrypted cache, with no second issuance. Reusing it with different parameters returns 409 with code71211011 (portal_conflict).
Authorizations
Authorization
string
header
required
Portal user token from POST /agent/cwallet/platform/portal/tokens. Reads require portal:read; writes require portal:write.
Body
application/json
instruction_id
string
required
ACTIVE instruction owned by the token's customer.
Example:
"inst_..."
mandate_id
string
required
Mandate under that instruction that covers the purchase.
Example:
"mand_..."
client_reference_id
string
required
Platform-side reference and idempotency key for this purchase. Store it; the result report uses the same value.
Example:
"platform-ref-001"
amount
string
required
Transaction amount, decimal string in major currency units.
Example:
"12.50"
currency_code
string
required
Three-letter currency code.
Example:
"USD"
merchant_url
string
required
Merchant checkout URL. Must use HTTPS.
Example:
"https://shop.example.com/checkout"
merchant_name
string
Merchant display name. Defaults to the host of merchant_url.
Example:
"Example Store"
merchant_country_code
string
default:US
Merchant country, ISO 3166-1 alpha-2.
Example:
"US"
merchant_order_id
string
Merchant-side order ID, when available.
Example:
"shop-order-1"
products
object[]
Line items for the purchase.
Show child attributes
shipping_address
object
Shipping address.
Show child attributes
Response
Success
code
integer<int32>
200 on success.
Example:
200
msg
string
Result message.
Example:
"Success"
data
Sealed (matched: true) · object
Returned when your platform has a registered public key. Contains only matched, key, and payload; the IDs are inside the decrypted payload.
Sealed (matched: true)
Plaintext (matched: false)
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Clink Documentation","colors":{"primary":"#FF9472"},"logo":{"light":"https://mintcdn.com/clink/SmNnnZK50PsVdBCU/logo/light_new.svg?fit=max\u0026auto=format\u0026n=SmNnnZK50PsVdBCU\u0026q=85\u0026s=9956e279765b6e968dcc19748a3ee896","dark":"https://mintcdn.com/clink/SmNnnZK50PsVdBCU/logo/dark_new.svg?fit=max\u0026auto=format\u0026n=SmNnnZK50PsVdBCU\u0026q=85\u0026s=e447d25bef8f25b8da7fbbe78e04ef92"},"favicon":"https://mintcdn.com/clink/peBNaRlFWIQS8vOQ/favicon.svg?fit=max\u0026auto=format\u0026n=peBNaRlFWIQS8vOQ\u0026q=85\u0026s=c6eb5684668bd21139f01cb68bd69932","api":{"playground":{"display":"interactive"},"examples":{"languages":["curl","java","python","javascript"]}},"appearance":{"default":"light","strict":true},"navbar":{"links":[{"href":"https://uat-dashboard.clinkbill.com","label":"Sandbox"},{"href":"mailto:contact@clinkbill.com","label":"Support"},{"href":"https://github.com/clinkbillcom/clink-integ-skills","label":"Integration-skill"},{"href":"https://docs.clinkbill.com/llms.txt","label":"llms.txt"},{"href":"https://docs.clinkbill.com/llms-full.txt","label":"llms-full.txt"}],"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.clinkbill.com"}},"footer":{"socials":{"x":"https://x.com/clink_bill","linkedin":"https://linkedin.com/company/clinkbill"}},"icons":{"library":"lucide"},"styling":{"latex":false},"navigation":{"languages":[{"language":"en","href":""},{"language":"cn","href":"cn"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"clink","hasAudioNarration":false,"actualSubdomain":"clink","customDomains":["docs.clinkbill.com"],"gitSource":{"type":"github","owner":"pppatrickkkk","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6afc86ae9c831e7823345628","clientVersion":"0.0.4177","searchFilterCounts":[{"language":"en","tag":"API Reference","count":53},{"language":"cn","tag":"API 文档","count":53},{"language":"en","tag":"Documentation","count":42},{"language":"cn","tag":"知识库","count":42},{"language":"default","tag":"API Reference","count":36},{"language":"en","tag":"Agent Portal","count":20},{"language":"cn","tag":"Agent Portal","count":20},{"language":"en","tag":"Guides","count":14},{"language":"cn","tag":"介绍","count":14},{"language":"en","tag":"Agent Solutions","count":12},{"language":"cn","tag":"Agent 解决方案","count":12},{"language":"default","tag":"Webhook Endpoint Management","count":10},{"language":"default","tag":"Webhooks","count":7},{"language":"en","tag":"Core Resource","count":6},{"language":"cn","tag":"资源说明","count":6},{"language":"en","tag":"Integration","count":5},{"language":"en","tag":"API Documentation","count":5},{"language":"en","tag":"Payment Methods","count":5},{"language":"en","tag":"Account","count":5},{"language":"default","tag":"Test Clock","count":5},{"language":"cn","tag":"接入","count":5},{"language":"cn","tag":"概述","count":5},{"language":"cn","tag":"Payment Methods","count":5},{"language":"cn","tag":"Account","count":5},{"language":"default","tag":"Subscription","count":3},{"language":"default","tag":"Checkout Session","count":3},{"language":"default","tag":"Agent Payment Session","count":2},{"language":"default","tag":"Price","count":2},{"language":"default","tag":"Product","count":2},{"language":"default","tag":"Order","count":1}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"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":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/agent-portal/get_credential","slug":"/api-reference/agent-portal/get_credential","pageMetadata":{"title":"Get credential","openapi":"POST /agent/platform/credential","description":"Requests a single-use payment credential for one purchase against an activated instruction and mandate. Requires `portal:write`.","href":"/api-reference/agent-portal/get_credential"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Requests a single-use payment credential for one purchase against an activated instruction and mandate. Requires \", _jsx(_components.code, {\n children: \"portal:write\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{Heading,Warning}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`The response has two modes, depending on whether your platform has a public key registered with Clink:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Registered public key`}),` (`,_jsx(_components.code,{children:`matched: true`}),`): Clink seals the card fields into a `,_jsx(_components.code,{children:`key`}),`/`,_jsx(_components.code,{children:`payload`}),` envelope that only your platform can decrypt with the matching private key.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`No registered public key`}),` (`,_jsx(_components.code,{children:`matched: false`}),`): when plaintext mode is enabled server-side and gateway response redaction is live, Clink returns the DPAN and dynamic CVV in plaintext in the response. The card can be used directly, but these fields reach your backend in plaintext.`]}),`\n`]}),`\n`,_jsx(_components.p,{children:`Register a public key with Clink to use the encrypted mode; this is recommended for production.`}),`\n`,_jsxs(_components.p,{children:[`The response sends no credential deadline: the validity is `,_jsx(_components.code,{children:`dynamicDataExpiration`}),` in `,_jsx(_components.code,{children:`card`}),` (plaintext mode) or in the decrypted payload (sealed mode).`]}),`\n`,_jsx(Heading,{level:`2`,id:`public-key-registration`,children:`Public key registration`}),`\n`,_jsx(_components.p,{children:`Contact Clink to register your platform’s RSA public key in each environment; it is mapped to your platform client name. The registered key selects the response mode: with a key the credential is sealed to it; without one, Clink returns plaintext card fields only when plaintext mode is enabled server-side and gateway response redaction is live (the MCP-equivalent fallback). With the default gate off, the endpoint fails closed instead. Register the key before production use.`}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`Without a registered public key, when plaintext mode is enabled server-side, the response returns the DPAN and dynamic CVV in plaintext to your backend. Keep these fields out of logs, model input, and ordinary storage, and do not keep them beyond the checkout. Register a public key with Clink (recommended for production) to switch to the sealed `,_jsx(_components.code,{children:`key`}),`/`,_jsx(_components.code,{children:`payload`}),` mode. This plaintext fallback matches MCP `,_jsx(_components.code,{children:`get_credential`}),`. Do not enable plaintext mode in environments where gateway response redaction is not yet active: it is config-gated server-side by `,_jsx(_components.code,{children:`portal-plaintext-enabled`}),` (default off), and with the gate off the endpoint fails closed with `,_jsx(_components.code,{children:`71211012`}),` (`,_jsx(_components.code,{children:`credential_public_key_not_configured`}),`) instead of returning plaintext card fields.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`decrypt-the-sealed-response`,children:`Decrypt the sealed response`}),`\n`,_jsxs(_components.p,{children:[`When `,_jsx(_components.code,{children:`matched`}),` is `,_jsx(_components.code,{children:`true`}),`, decrypt `,_jsx(_components.code,{children:`key`}),` and `,_jsx(_components.code,{children:`payload`}),` with your platform private key. The decrypted payload contains `,_jsx(_components.code,{children:`orderId`}),`, `,_jsx(_components.code,{children:`paymentExecutionDetailId`}),`, `,_jsx(_components.code,{children:`clientReferenceId`}),`, `,_jsx(_components.code,{children:`status`}),`, the network credential (DPAN, dynamic CVV, and expiry), and cardholder and address fields. The envelope format and a decryption example are in `,_jsx(_components.a,{href:`/guides/agent/browser_pay#optional-decryption`,children:`Decryption`}),`.`]}),`\n`,_jsxs(_components.p,{children:[`Keep decrypted card fields out of logs, model input, and ordinary records, and use the validity information in the decrypted payload (`,_jsx(_components.code,{children:`dynamicDataExpiration`}),`) to decide when to use the credential. Save `,_jsx(_components.code,{children:`client_reference_id`}),`; `,_jsx(_components.a,{href:`/api-reference/agent-portal/report_credential_result`,children:`Report credential result`}),` uses it.`]}),`\n`,_jsx(Heading,{level:`2`,id:`idempotency`,children:`Idempotency`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`client_reference_id`}),` is the idempotency key. Retrying with the same `,_jsx(_components.code,{children:`client_reference_id`}),` returns the same credential: the same sealed envelope when `,_jsx(_components.code,{children:`matched`}),` is `,_jsx(_components.code,{children:`true`}),`, and in plaintext mode the same card from the server-side encrypted cache, with no second issuance. Reusing it with different parameters returns `,_jsx(_components.code,{children:`409`}),` with `,_jsx(_components.code,{children:`code`}),` `,_jsx(_components.code,{children:`71211011`}),` (`,_jsx(_components.code,{children:`portal_conflict`}),`).`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get credential","openapi":"POST /agent/platform/credential","description":"Requests a single-use payment credential for one purchase against an activated instruction and mandate. Requires `portal:write`.","href":"/api-reference/agent-portal/get_credential"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Public key registration","slug":"public-key-registration","depth":2,"children":[]},{"title":"Decrypt the sealed response","slug":"decrypt-the-sealed-response","depth":2,"children":[]},{"title":"Idempotency","slug":"idempotency","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Get credential","description":"Requests a single-use payment credential for one purchase against an activated instruction and mandate. Requires `portal:write`.","operationId":"getCredential","requestBody":"84071f3a-a870-4cca-ba28-fa74342dc70e","responses":{"200":"5e902110-6e43-49e8-aa2a-39c601c3d981","400":"542ec0b3-161b-45d8-bb8f-8e524fc24674","401":"900fc65b-a391-49cb-92d9-7ab172f756e4","403":"1f874ea0-a816-4d5f-b7b4-5f23f4a6ccb8","409":"a6da0687-d21a-4766-94fe-c95e6d76fab6","429":"b441db7e-8785-4c27-8c9d-7ba662b1d6d6"},"method":"post","type":"path","servers":["5ea4f0ea-3214-4d21-a455-d285f3de637f"],"security":["d4c33e13-aa8b-402b-a4ee-08669f9a2053"],"path":"/agent/platform/credential","baseUrlOptions":["https://uat-api.clinkbill.com"],"title":"Get credential","codeSamples":[],"requestExampleLanguages":["bash","java","python","javascript"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instruction_id","mandate_id","client_reference_id","amount","currency_code","merchant_url"],"properties":{"instruction_id":{"type":"string","description":"`ACTIVE` instruction owned by the token's customer.","example":"inst_...","isRequired":true,"uniqueKey":"instruction_id","typeLabel":"string"},"mandate_id":{"type":"string","description":"Mandate under that instruction that covers the purchase.","example":"mand_...","isRequired":true,"uniqueKey":"mandate_id","typeLabel":"string"},"client_reference_id":{"type":"string","description":"Platform-side reference and idempotency key for this purchase. Store it; the result report uses the same value.","example":"platform-ref-001","isRequired":true,"uniqueKey":"client_reference_id","typeLabel":"string"},"amount":{"type":"string","description":"Transaction amount, decimal string in major currency units.","example":"12.50","isRequired":true,"uniqueKey":"amount","typeLabel":"string"},"currency_code":{"type":"string","description":"Three-letter currency code.","example":"USD","isRequired":true,"uniqueKey":"currency_code","typeLabel":"string"},"merchant_url":{"type":"string","description":"Merchant checkout URL. Must use HTTPS.","example":"https://shop.example.com/checkout","isRequired":true,"uniqueKey":"merchant_url","typeLabel":"string"},"merchant_name":{"type":"string","description":"Merchant display name. Defaults to the host of `merchant_url`.","example":"Example Store","uniqueKey":"merchant_name","typeLabel":"string"},"merchant_country_code":{"type":"string","description":"Merchant country, ISO 3166-1 alpha-2.","default":"US","example":"US","uniqueKey":"merchant_country_code","typeLabel":"string"},"merchant_order_id":{"type":"string","description":"Merchant-side order ID, when available.","example":"shop-order-1","uniqueKey":"merchant_order_id","typeLabel":"string"},"products":{"type":"array","description":"Line items for the purchase.","items":{"type":"object","properties":{"product_id":{"type":"string","description":"Product identifier.","example":"item-001","uniqueKey":"products.items.[INDEX].product_id","typeLabel":"string"},"product_name":{"type":"string","description":"Product name.","example":"Example item","uniqueKey":"products.items.[INDEX].product_name","typeLabel":"string"},"quantity":{"type":"integer","description":"Quantity.","example":1,"uniqueKey":"products.items.[INDEX].quantity","typeLabel":"integer"},"unit_price":{"type":"string","description":"Unit price, decimal string in major currency units.","example":"12.50","uniqueKey":"products.items.[INDEX].unit_price","typeLabel":"string"},"currency_code":{"type":"string","description":"Three-letter currency code.","example":"USD","uniqueKey":"products.items.[INDEX].currency_code","typeLabel":"string"},"product_url":{"type":"string","description":"Product page URL.","example":"https://shop.example.com/item-001","uniqueKey":"products.items.[INDEX].product_url","typeLabel":"string"}},"uniqueKey":"products.items.[INDEX]","typeLabel":"object"},"uniqueKey":"products","typeLabel":"object[]"},"shipping_address":{"type":"object","description":"Shipping address.","properties":{"name":{"type":"string","description":"Recipient name.","example":"Example User","uniqueKey":"shipping_address.name","typeLabel":"string"},"line1":{"type":"string","description":"Address line 1.","example":"1 Market Street","uniqueKey":"shipping_address.line1","typeLabel":"string"},"line2":{"type":"string","description":"Address line 2.","example":"Suite 100","uniqueKey":"shipping_address.line2","typeLabel":"string"},"line3":{"type":"string","description":"Address line 3.","uniqueKey":"shipping_address.line3","typeLabel":"string"},"city":{"type":"string","description":"City.","example":"San Francisco","uniqueKey":"shipping_address.city","typeLabel":"string"},"state":{"type":"string","description":"State or province.","example":"CA","uniqueKey":"shipping_address.state","typeLabel":"string"},"zip":{"type":"string","description":"Postal code.","example":"94105","uniqueKey":"shipping_address.zip","typeLabel":"string"},"country_code":{"type":"string","description":"Country code.","example":"US","uniqueKey":"shipping_address.country_code","typeLabel":"string"}},"uniqueKey":"shipping_address","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"instruction_id":"inst_...","mandate_id":"mand_...","client_reference_id":"platform-ref-001","amount":"12.50","currency_code":"USD","merchant_url":"https://shop.example.com/checkout","merchant_name":"Example Store","merchant_country_code":"US","merchant_order_id":"shop-order-1","products":[{"product_id":"item-001","product_name":"Example item","quantity":1,"unit_price":"12.50","currency_code":"USD","product_url":"https://shop.example.com/item-001"}],"shipping_address":{"name":"Example User","line1":"1 Market Street","city":"San Francisco","state":"CA","zip":"94105","country_code":"US"}},"examples":{"Example":{"title":"Example","value":{"instruction_id":"inst_...","mandate_id":"mand_...","client_reference_id":"platform-ref-001","amount":"12.50","currency_code":"USD","merchant_url":"https://shop.example.com/checkout","merchant_name":"Example Store","merchant_country_code":"US","merchant_order_id":"shop-order-1","products":[{"product_id":"item-001","product_name":"Example item","quantity":1,"unit_price":"12.50","currency_code":"USD","product_url":"https://shop.example.com/item-001"}],"shipping_address":{"name":"Example User","line1":"1 Market Street","city":"San Francisco","state":"CA","zip":"94105","country_code":"US"}}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"5e902110-6e43-49e8-aa2a-39c601c3d981":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","format":"int32","description":"`200` on success.","example":200,"uniqueKey":"code","typeLabel":"integer\u003cint32>"},"msg":{"type":"string","description":"Result message.","example":"Success","uniqueKey":"msg","typeLabel":"string"},"data":{"oneOf":[{"type":"object","title":"Sealed (matched: true)","description":"Returned when your platform has a registered public key. Contains only `matched`, `key`, and `payload`; the IDs are inside the decrypted payload.","required":["matched","key","payload"],"properties":{"matched":{"type":"boolean","description":"`true`: Clink sealed the credential with your registered public key.","example":true,"isRequired":true,"uniqueKey":"data.oneOf.0.matched","typeLabel":"boolean"},"key":{"type":"string","description":"RSA-OAEP-wrapped AES key, Base64.","example":"\u003cRSA-OAEP wrapped AES key, Base64>","isRequired":true,"uniqueKey":"data.oneOf.0.key","typeLabel":"string"},"payload":{"type":"string","description":"AES-256-GCM ciphertext of the credential payload, Base64. The decrypted payload contains `orderId`, `paymentExecutionDetailId`, `clientReferenceId`, `status`, the network credential (DPAN, dynamic CVV, and expiry), and cardholder and address fields.","example":"\u003cAES-256-GCM ciphertext, Base64>","isRequired":true,"uniqueKey":"data.oneOf.0.payload","typeLabel":"string"}},"uniqueKey":"data.oneOf.0","typeLabel":"Sealed (matched: true) · object"},{"type":"object","title":"Plaintext (matched: false)","description":"Returned when no public key is registered and plaintext mode is enabled server-side. Contains no `key` or `payload`.","properties":{"matched":{"type":"boolean","description":"`false`: no public key is registered and plaintext mode is enabled server-side, so the card fields are returned in plaintext.","example":false,"uniqueKey":"data.oneOf.1.matched","typeLabel":"boolean"},"order_id":{"type":"string","description":"Order created for this credential.","example":"order_...","uniqueKey":"data.oneOf.1.order_id","typeLabel":"string"},"payment_execution_detail_id":{"type":"string","description":"Payment execution detail created for this credential.","example":"ped_...","uniqueKey":"data.oneOf.1.payment_execution_detail_id","typeLabel":"string"},"client_reference_id":{"type":"string","description":"The `client_reference_id` you sent. Store it for result reporting.","example":"platform-ref-001","uniqueKey":"data.oneOf.1.client_reference_id","typeLabel":"string"},"card":{"type":"object","description":"Plaintext card fields. `number` and `securityCode` are always present; the other fields are omitted when not provided.","required":["number","securityCode"],"properties":{"number":{"type":"string","description":"DPAN (the credential card number); it is never the underlying PAN.","example":"\u003cDPAN>","isRequired":true,"uniqueKey":"data.oneOf.1.card.number","typeLabel":"string"},"securityCode":{"type":"string","description":"Dynamic security code (CVV) for the credential.","example":"\u003cdynamic CVV>","isRequired":true,"uniqueKey":"data.oneOf.1.card.securityCode","typeLabel":"string"},"expiryMonth":{"type":"string","description":"Expiry month as `MM`. All expiry fields may be absent.","example":"12","uniqueKey":"data.oneOf.1.card.expiryMonth","typeLabel":"string"},"expiryYear":{"type":"string","description":"Expiry year as four digits. A two-digit network value is expanded to `20YY`.","example":"2028","uniqueKey":"data.oneOf.1.card.expiryYear","typeLabel":"string"},"expiry":{"type":"string","description":"Raw expiry string from the network, either `MM/YYYY` or `MM/YY`; it is not normalized.","example":"12/2028","uniqueKey":"data.oneOf.1.card.expiry","typeLabel":"string"},"dynamicDataType":{"type":"string","description":"How the dynamic data must be used at checkout, for example `DAVV`.","example":"DAVV","uniqueKey":"data.oneOf.1.card.dynamicDataType","typeLabel":"string"},"dynamicDataExpiration":{"type":"integer","description":"Dynamic data expiry in Unix epoch seconds. This is the credential's validity; the response sends no separate deadline. Omitted when the network does not provide it.","example":1792380808,"uniqueKey":"data.oneOf.1.card.dynamicDataExpiration","typeLabel":"integer"},"eci":{"type":"string","description":"Electronic commerce indicator.","example":"05","uniqueKey":"data.oneOf.1.card.eci","typeLabel":"string"},"paymentAccountReference":{"type":"string","description":"Payment account reference.","example":"PAR-1","uniqueKey":"data.oneOf.1.card.paymentAccountReference","typeLabel":"string"}},"uniqueKey":"data.oneOf.1.card","typeLabel":"object"},"display":{"type":"object","description":"Card display metadata.","properties":{"brand":{"type":"string","description":"Card scheme.","example":"VISA","uniqueKey":"data.oneOf.1.display.brand","typeLabel":"string"},"last4":{"type":"string","description":"Last four digits of the credential card number.","example":"3797","uniqueKey":"data.oneOf.1.display.last4","typeLabel":"string"}},"uniqueKey":"data.oneOf.1.display","typeLabel":"object"}},"uniqueKey":"data.oneOf.1","typeLabel":"Plaintext (matched: false) · object"}],"uniqueKey":"data","typeLabel":"Sealed (matched: true) · object | Plaintext (matched: false) · object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"sealed":{"title":"sealed","summary":"Sealed (matched: true)","value":{"code":200,"msg":"Success","data":{"matched":true,"key":"\u003cRSA-OAEP wrapped AES key, Base64>","payload":"\u003cAES-256-GCM ciphertext, Base64>"}}},"plaintext":{"title":"plaintext","summary":"Plaintext (matched: false)","value":{"code":200,"msg":"Success","data":{"matched":false,"order_id":"order_...","payment_execution_detail_id":"ped_...","client_reference_id":"...","card":{"number":"\u003cDPAN>","securityCode":"\u003cdynamic CVV>","expiryMonth":"12","expiryYear":"2028","expiry":"12/2028","dynamicDataType":"DAVV","dynamicDataExpiration":1792380808,"eci":"05","paymentAccountReference":"PAR-1"},"display":{"brand":"VISA","last4":"3797"}}}}},"exampleType":"examples"}},"exampleType":"examples"},"542ec0b3-161b-45d8-bb8f-8e524fc24674":{"description":"Invalid request body.","content":{"application/json":{"schema":{"type":"object","description":"Business errors use the standard envelope without `data`.","properties":{"code":{"type":"integer","description":"Numeric business error code. Judge an error by the HTTP status together with `code`, not by a string error code.","uniqueKey":"code","typeLabel":"integer"},"msg":{"type":"string","description":"Human-readable description.","uniqueKey":"msg","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":123,"msg":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"900fc65b-a391-49cb-92d9-7ab172f756e4":{"description":"Missing, expired, or invalid portal token.","content":{"application/json":{"schema":{"type":"object","description":"Business errors use the standard envelope without `data`.","properties":{"code":{"type":"integer","description":"Numeric business error code. Judge an error by the HTTP status together with `code`, not by a string error code.","uniqueKey":"code","typeLabel":"integer"},"msg":{"type":"string","description":"Human-readable description.","uniqueKey":"msg","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":123,"msg":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"1f874ea0-a816-4d5f-b7b4-5f23f4a6ccb8":{"description":"Wrong token audience, missing `portal:write` scope, or a platform client token used instead of a portal token.","content":{"application/json":{"schema":{"type":"object","description":"Business errors use the standard envelope without `data`.","properties":{"code":{"type":"integer","description":"Numeric business error code. Judge an error by the HTTP status together with `code`, not by a string error code.","uniqueKey":"code","typeLabel":"integer"},"msg":{"type":"string","description":"Human-readable description.","uniqueKey":"msg","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":123,"msg":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"a6da0687-d21a-4766-94fe-c95e6d76fab6":{"description":"`client_reference_id` was reused with different parameters (`portal_conflict`, `code` `71211011`).","content":{"application/json":{"schema":{"type":"object","description":"Business errors use the standard envelope without `data`.","properties":{"code":{"type":"integer","description":"Numeric business error code. Judge an error by the HTTP status together with `code`, not by a string error code.","uniqueKey":"code","typeLabel":"integer"},"msg":{"type":"string","description":"Human-readable description.","uniqueKey":"msg","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":123,"msg":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"b441db7e-8785-4c27-8c9d-7ba662b1d6d6":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"type":"object","description":"Business errors use the standard envelope without `data`.","properties":{"code":{"type":"integer","description":"Numeric business error code. Judge an error by the HTTP status together with `code`, not by a string error code.","uniqueKey":"code","typeLabel":"integer"},"msg":{"type":"string","description":"Human-readable description.","uniqueKey":"msg","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":123,"msg":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"d4c33e13-aa8b-402b-a4ee-08669f9a2053":{"PortalToken":{"type":"http","scheme":"bearer","description":"Portal user token from `POST /agent/cwallet/platform/portal/tokens`. Reads require `portal:read`; writes require `portal:write`.","scopes":[],"schemeName":"PortalToken"}}},"servers":{"5ea4f0ea-3214-4d21-a455-d285f3de637f":{"url":"https://uat-api.clinkbill.com","description":"Sandbox"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Portal user token from `POST /agent/cwallet/platform/portal/tokens`. Reads require `portal:read`; writes require `portal:write`.","scopes":[],"schemeName":"PortalToken"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Portal user token from `POST /agent/cwallet/platform/portal/tokens`. Reads require `portal:read`; writes require `portal:write`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"PortalToken","name":"Authorization"}],"title":"PortalToken"}]},"originalFileLocation":"api-reference/agent-portal/openapi.json"},"subdomain":"clink","siteName":"Clink Documentation","title":"Get credential - Clink Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/agent-portal/get_credential","matchLevel":0},"cn":{"href":"/cn/api-reference/agent-portal/get_credential","matchLevel":1}}},"lastModified":"2026-11-17T16:54:14.012Z","originalFileLocation":"api-reference/agent-portal/get_credential.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"light\";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=\"light\"}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=\"Requests a single-use payment credential for one purchase against an activated instruction and mandate. Requires portal:write.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Clink 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/clink/ur0VwNJVZSsj7vK4/_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/clink/ur0VwNJVZSsj7vK4/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/clink/ur0VwNJVZSsj7vK4/_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/clink/ur0VwNJVZSsj7vK4/_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/clink/ur0VwNJVZSsj7vK4/_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/clink/ur0VwNJVZSsj7vK4/_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/clink/ur0VwNJVZSsj7vK4/_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/clink/ur0VwNJVZSsj7vK4/_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/clink/ur0VwNJVZSsj7vK4/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get credential - Clink Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Requests a single-use payment credential for one purchase against an activated instruction and mandate. Requires portal:write.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Clink Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.clinkbill.com/api-reference/agent-portal/get_credential\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://clink.mintlify.site/_mintlify/api/og/v2?division=Credentials\u0026amp;title=Get+credential\u0026amp;description=Requests+a+single-use+payment+credential+for+one+purchase+against+an+activated+instruction+and+mandate.+Requires+%60portal%3Awrite%60.\u0026amp;theme=be5a6376d6c12292dd7b4d25\u0026amp;signature=89dc4fdc740e95171b207b39e21af845845649fcf45452e75b27de59e523f550\">\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 credential - Clink Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Requests a single-use payment credential for one purchase against an activated instruction and mandate. Requires portal:write.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://clink.mintlify.site/_mintlify/api/og/v2?division=Credentials\u0026amp;title=Get+credential\u0026amp;description=Requests+a+single-use+payment+credential+for+one+purchase+against+an+activated+instruction+and+mandate.+Requires+%60portal%3Awrite%60.\u0026amp;theme=be5a6376d6c12292dd7b4d25\u0026amp;signature=89dc4fdc740e95171b207b39e21af845845649fcf45452e75b27de59e523f550\">\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/clink/ur0VwNJVZSsj7vK4/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Clink Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FF9472\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.clinkbill.com/api-reference/agent-portal/get_credential\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/agent-portal/get_credential.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.clinkbill.com/api-reference/agent-portal/get_credential\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"zh\" href=\"https://docs.clinkbill.com/cn/api-reference/agent-portal/get_credential\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docs.clinkbill.com/api-reference/agent-portal/get_credential\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.clinkbill.com/#organization\",\"name\":\"Clink Documentation\",\"url\":\"https://docs.clinkbill.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/clink/SmNnnZK50PsVdBCU/logo/light_new.svg?fit=max\u0026auto=format\u0026n=SmNnnZK50PsVdBCU\u0026q=85\u0026s=9956e279765b6e968dcc19748a3ee896\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.clinkbill.com#website\",\"name\":\"Clink Documentation\",\"url\":\"https://docs.clinkbill.com\",\"publisher\":{\"@id\":\"https://docs.clinkbill.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.clinkbill.com/api-reference/agent-portal/get_credential#webpage\",\"url\":\"https://docs.clinkbill.com/api-reference/agent-portal/get_credential\",\"name\":\"Get credential\",\"description\":\"Requests a single-use payment credential for one purchase against an activated instruction and mandate. Requires portal:write.\",\"dateModified\":\"2026-11-17T16:54:14.012Z\",\"isPartOf\":{\"@id\":\"https://docs.clinkbill.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.clinkbill.com/api-reference/agent-portal/get_credential#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.clinkbill.com/api-reference/agent-portal/get_credential#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Agent Portal\",\"item\":\"https://docs.clinkbill.com/api-reference/agent-portal/portal_token\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get credential\",\"item\":\"https://docs.clinkbill.com/api-reference/agent-portal/get_credential\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.clinkbill.com/api-reference/agent-portal/get_credential#apireference\",\"headline\":\"Get credential\",\"name\":\"Get credential\",\"description\":\"Requests a single-use payment credential for one purchase against an activated instruction and mandate. Requires portal:write.\",\"url\":\"https://docs.clinkbill.com/api-reference/agent-portal/get_credential\",\"mainEntityOfPage\":{\"@id\":\"https://docs.clinkbill.com/api-reference/agent-portal/get_credential#webpage\"},\"dateModified\":\"2026-11-17T16:54:14.012Z\",\"publisher\":{\"@id\":\"https://docs.clinkbill.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.clinkbill.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Clink Documentation\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Clink Documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/agent-portal/get_credential.md","siteName":"Clink Documentation","nav":{"global":null,"languages":[{"language":"en","tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","icon":"chevrons-left-right-ellipsis","href":"/api-reference/introduction"},{"title":"TypeScript SDK","icon":"npm","href":"/api-reference/SDK"},{"title":"JavaScript SDK","icon":"code","href":"/api-reference/javascript_sdk"},{"title":"Clink CLI","icon":"terminal","href":"/api-reference/clink_cli"},{"title":"Agent Vault SDK API reference","sidebarTitle":"Agent Vault SDK","icon":"vault","href":"/api-reference/agent_vault_sdk"}]},{"group":"Clink MCP","pages":[{"title":"Wallet MCP tools","icon":"wallet","href":"/api-reference/mcp/wallet"},{"title":"Browser Pay tools","icon":"app-window","href":"/api-reference/mcp/browser_pay"},{"title":"Operations and recovery","icon":"refresh-cw","href":"/api-reference/mcp/operations"},{"title":"Catalog and UCP Checkout","icon":"shopping-cart","href":"/api-reference/mcp/commerce"},{"title":"Agent Platform MCP Login","icon":"key-round","href":"/api-reference/mcp/agent_platform_login"}]},{"group":"Agent Portal","icon":"layout-dashboard","pages":[{"title":"Portal token","openapi":"POST /agent/cwallet/platform/portal/tokens","href":"/api-reference/agent-portal/portal_token"},{"group":"Account","pages":[{"title":"Get account","openapi":"GET /agent/platform/me","href":"/api-reference/agent-portal/get_account"},{"title":"Get risk rules","openapi":"GET /agent/platform/risk-rules","href":"/api-reference/agent-portal/get_risk_rules"},{"title":"Update risk rules","openapi":"PUT /agent/platform/risk-rules","href":"/api-reference/agent-portal/update_risk_rules"},{"title":"Get billing address","openapi":"GET /agent/platform/billing-address","href":"/api-reference/agent-portal/get_billing_address"},{"title":"Update billing address","openapi":"PUT /agent/platform/billing-address","href":"/api-reference/agent-portal/update_billing_address"}]},{"group":"Payment Methods","pages":[{"title":"List payment methods","openapi":"GET /agent/platform/payment-methods","href":"/api-reference/agent-portal/list_payment_methods"},{"title":"Bind a card","openapi":"POST /agent/platform/bind-sessions","href":"/api-reference/agent-portal/bind_card"},{"title":"Create a Vault session","openapi":"POST /agent/platform/vault-sessions","href":"/api-reference/agent-portal/create_vault_session"},{"title":"Create a card session","openapi":"POST /agent/platform/card-sessions","href":"/api-reference/agent-portal/create_card_session"},{"title":"Delete payment method","openapi":"DELETE /agent/platform/payment-methods/{paymentInstrumentId}","href":"/api-reference/agent-portal/delete_payment_method"}]},{"group":"Orders","pages":[{"title":"List orders","openapi":"GET /agent/platform/orders","href":"/api-reference/agent-portal/list_orders"},{"title":"Get order","openapi":"GET /agent/platform/orders/{orderId}","href":"/api-reference/agent-portal/get_order"}]},{"group":"Refunds","pages":[{"title":"List refunds","openapi":"GET /agent/platform/refunds","href":"/api-reference/agent-portal/list_refunds"},{"title":"Get refund","openapi":"GET /agent/platform/refunds/{refundOrderId}","href":"/api-reference/agent-portal/get_refund"}]},{"group":"Authorizations","pages":[{"title":"List authorizations","openapi":"GET /agent/platform/authorizations","href":"/api-reference/agent-portal/list_authorizations"},{"title":"Get authorization","openapi":"GET /agent/platform/authorizations/{instructionId}","href":"/api-reference/agent-portal/get_authorization"},{"title":"Create instruction","openapi":"POST /agent/platform/authorizations","description":"Creates a purchase instruction (spending authorization) for the token's customer and returns a short-lived activation link that the user opens to approve it with a Passkey. Requires `portal:write`.","href":"/api-reference/agent-portal/create_instruction"}]},{"group":"Credentials","pages":[{"title":"Get credential","openapi":"POST /agent/platform/credential","href":"/api-reference/agent-portal/get_credential"},{"title":"Report credential result","openapi":"POST /agent/platform/credential-results","description":"Reports the outcome observed on the merchant page after using a credential. Requires `portal:write`.","href":"/api-reference/agent-portal/report_credential_result"}]}]},{"group":"Checkout Session","pages":[{"title":"Create Checkout Session","openapi":"POST /checkout/session","href":"/api-reference/endpoint/create-checkout-session"},{"title":"Get Checkout Session","openapi":"GET /checkout/session/{id}","href":"/api-reference/endpoint/get-checkout-session"},{"title":"Expire Checkout Session","openapi":"POST /checkout/session/{id}/expire","href":"/api-reference/endpoint/expire-checkout-session"}]},{"group":"Payment","pages":[{"title":"Create Payment","openapi":"POST /payment","href":"/api-reference/endpoint/create-payment"},{"title":"Refresh Wallet QR Code","openapi":"POST /payment/{orderId}/qrcode/refresh","href":"/api-reference/endpoint/refresh-wallet-qrcode"}]},{"group":"Payment Instrument","pages":[{"title":"Create Payment Instrument","openapi":"POST /payment-instrument","href":"/api-reference/endpoint/create-payment-instrument"}]},{"group":"Order","pages":[{"title":"List Orders","openapi":"GET /order","href":"/api-reference/endpoint/list-orders"},{"title":"Get Order","openapi":"GET /order/{id}","href":"/api-reference/endpoint/get-order"}]},{"group":"Agent Payment Session","pages":[{"title":"Create Agent Payment Session","openapi":"POST /order/payment-session","href":"/api-reference/endpoint/create-agent-payment-session"},{"title":"Get Agent Payment Session","openapi":"GET /order/payment-session/{sessionId}","href":"/api-reference/endpoint/get-agent-payment-session"}]},{"group":"Refund","pages":[{"title":"Create Refund","openapi":"POST /refund","href":"/api-reference/endpoint/create-refund"},{"title":"Get Refund","openapi":"GET /refund/{id}","href":"/api-reference/endpoint/get-refund"}]},{"group":"Product","pages":[{"title":"Upload Product Image","openapi":"POST /product/image/upload","href":"/api-reference/endpoint/upload-product-image"},{"title":"Create Product","openapi":"POST /product","href":"/api-reference/endpoint/create-product"},{"title":"Get Product","openapi":"GET /product/{id}","href":"/api-reference/endpoint/get-product"},{"title":"Get Product List","openapi":"GET /product","href":"/api-reference/endpoint/get-product-list"}]},{"group":"Price","pages":[{"title":"Create Price","openapi":"POST /price","href":"/api-reference/endpoint/create-price"},{"title":"Get Price","openapi":"GET /price/{id}","href":"/api-reference/endpoint/get-price"},{"title":"Get Price List","openapi":"GET /price","href":"/api-reference/endpoint/get-price-list"},{"title":"Update Price","openapi":"PUT /price/{id}","href":"/api-reference/endpoint/update-price"}]},{"group":"Coupon","pages":[{"title":"Create Coupon","openapi":"POST /coupon","href":"/api-reference/endpoint/create-coupon"},{"title":"List Coupons","openapi":"GET /coupon","href":"/api-reference/endpoint/list-coupons"},{"title":"Get Coupon","openapi":"GET /coupon/{couponId}","href":"/api-reference/endpoint/get-coupon"},{"title":"Rename Coupon","openapi":"PUT /coupon/{couponId}/name","href":"/api-reference/endpoint/rename-coupon"}]},{"group":"Promotion Code","pages":[{"title":"Create Promotion Code","openapi":"POST /promotion-code/{id}","href":"/api-reference/endpoint/create-promotion-code"},{"title":"Get Promotion Code","openapi":"GET /promotion-code/{id}","href":"/api-reference/endpoint/get-promotion-code"},{"title":"List Promotion Codes by Coupon","openapi":"GET /promotion-code/coupon/{couponId}","href":"/api-reference/endpoint/list-promotion-codes-by-coupon"},{"title":"Activate Promotion Code","openapi":"PUT /promotion-code/{promotionCodeId}/active","href":"/api-reference/endpoint/activate-promotion-code"},{"title":"Deactivate Promotion Code","openapi":"PUT /promotion-code/{promotionCodeId}/deactivate","href":"/api-reference/endpoint/deactivate-promotion-code"}]},{"group":"Subscription","pages":[{"title":"Create Subscription","openapi":"POST /subscription","href":"/api-reference/endpoint/create-subscription"},{"title":"Get Subscription","openapi":"GET /subscription/{id}","href":"/api-reference/endpoint/get-subscription"},{"title":"Preview Subscription Update","openapi":"POST /subscription/{id}/update/preview","href":"/api-reference/endpoint/preview-subscription-update"},{"title":"Confirm Subscription Update","openapi":"POST /subscription/{id}/update/confirm","href":"/api-reference/endpoint/confirm-subscription-update"},{"title":"Cancel Subscription Update","openapi":"POST /subscription/{id}/update/cancel","href":"/api-reference/endpoint/cancel-subscription-update"},{"title":"Cancel Subscription","openapi":"POST /subscription/{id}/cancel","href":"/api-reference/endpoint/cancel-subscription"},{"title":"Get Invoice","openapi":"GET /subscription/invoice/{id}","href":"/api-reference/endpoint/get-invoice"}]},{"group":"Test Clock","pages":[{"title":"List Test Clocks","openapi":"GET /subscription/test-clocks/list","href":"/api-reference/endpoint/list-test-clocks"},{"title":"Create Test Clock","openapi":"POST /subscription/test-clocks","href":"/api-reference/endpoint/create-test-clock"},{"title":"Get Test Clock","openapi":"GET /subscription/test-clocks/{clockId}","href":"/api-reference/endpoint/get-test-clock"},{"title":"Advance Test Clock","openapi":"POST /subscription/test-clocks/{clockId}/advance","href":"/api-reference/endpoint/advance-test-clock"},{"title":"Complete Test Clock","openapi":"POST /subscription/test-clocks/{clockId}/complete","href":"/api-reference/endpoint/complete-test-clock"}]},{"group":"Customer Portal","pages":[{"title":"Customer Portal Session","openapi":"POST /billing/session","href":"/api-reference/endpoint/create-customer-portal"}]},{"group":"Webhook Endpoint Management","pages":[{"title":"List Webhook Events","openapi":"GET /webhook/events","href":"/api-reference/endpoint/list-webhook-events"},{"title":"List Webhook Endpoints","openapi":"GET /webhook/endpoints","href":"/api-reference/endpoint/list-webhook-endpoints"},{"title":"Create Webhook Endpoint","openapi":"POST /webhook/endpoints","href":"/api-reference/endpoint/create-webhook-endpoint"},{"title":"Ensure Webhook Endpoint","openapi":"PUT /webhook/endpoints/ensure","href":"/api-reference/endpoint/ensure-webhook-endpoint"},{"title":"Get Webhook Endpoint","openapi":"GET /webhook/endpoints/{id}","href":"/api-reference/endpoint/get-webhook-endpoint"},{"title":"Update Webhook Endpoint","openapi":"PATCH /webhook/endpoints/{id}","href":"/api-reference/endpoint/update-webhook-endpoint"},{"title":"Enable Webhook Endpoint","openapi":"POST /webhook/endpoints/{id}/enable","href":"/api-reference/endpoint/enable-webhook-endpoint"},{"title":"Disable Webhook Endpoint","openapi":"POST /webhook/endpoints/{id}/disable","href":"/api-reference/endpoint/disable-webhook-endpoint"},{"title":"Rotate Webhook Signing Secret","openapi":"POST /webhook/endpoints/{id}/rotate-secret","href":"/api-reference/endpoint/rotate-webhook-signing-secret"},{"title":"Delete Webhook Endpoint","openapi":"DELETE /webhook/endpoints/{id}","href":"/api-reference/endpoint/delete-webhook-endpoint"}]},{"group":"Webhooks","pages":[{"title":"order","openapi":"WEBHOOK order","href":"/api-reference/webhook/order"},{"title":"refund","openapi":"WEBHOOK refund","href":"/api-reference/webhook/refund"},{"title":"subscription","openapi":"WEBHOOK subscription","href":"/api-reference/webhook/subscription"},{"title":"invoice","openapi":"WEBHOOK invoice","href":"/api-reference/webhook/invoice"},{"title":"session","openapi":"WEBHOOK session","href":"/api-reference/webhook/session"},{"title":"customer.verify","openapi":"WEBHOOK customer.verify","href":"/api-reference/webhook/customer.verify"},{"title":"dispute","openapi":"WEBHOOK dispute","href":"/api-reference/webhook/dispute"}]}]}]},{"language":"cn","pages":[{"title":"cn","href":"/cn/api-reference/agent-portal/get_credential"}]}]},"basePath":"","title":"Get credential - Clink Documentation","deploymentId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","buildId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-jJHA3WSo.js","utils-DbZn3Mjn.js","cloneDeep-CnBnaSyy.js","_Uint8Array-CMQtTgBR.js","isObject-FP1Yky1u.js","utils-Bl2DvzOJ.js","addUniqueKeysToSchema-BwOLo9p1.js","snippetPresets-BBiPpKa-.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-C0px4Tml.js","isEqual-zAyttAAO.js","usePlaygroundInputsStore-Dell6dGw.js","shallow-0VKqkSqN.js","getApiPlaygroundDisplay-CP_ctPEB.js","CodeSnippet-5L35ic0s.js","CodeSnippets-DOXbNhJw.js","Page-DRLI_2Ue.js","getPastedJson-VhzT9m2P.js","icon-CD8_AtCO.js","MethodPill-DGgOMftG.js","DuplicateIcon-DZ6A_EtN.js","createIcon-DUl4oM5f.js","DynamicMarkdown-BGHukeRM.js","SectionHeading-ChrEUs8u.js","axios-vUo_bRtp.js","Markdown-Dj-na-_-.js","dist-C5gjFYHe.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-DEBW87tT.js"]}