Creates a standalone 3D Secure (3DS) authentication session for a card payment.
Requires the merchant.3ds.create permission.
Flow:
Create a 3DS session with encrypted card data, or with card.card_id to
authenticate a card stored via POST /v1/cards
If auth_status is ACTION_REQUIRED, the cardholder must complete the 3DS challenge
using the tds_session_id with the client-side SDK
If auth_status is AUTHENTICATED, the session is ready to be used in a transaction
Pass the session id as three_d_secure_session_id when creating a card transaction
Expiration: Sessions expire 1 hour after creation.
Single use: A session authenticates one amount and currency and can be spent on
one transaction. Recurring charges need a new session each time — a stored card does
not change this.
Supported card networks: Visa, Mastercard, and American Express. Cards from
other networks (e.g. Elo, Hipercard, Discover, Diners, JCB) cannot be authenticated
and are rejected with 400 VALIDATION_ERROR.
Card to authenticate. Provide eithercard_id (a card
stored via POST /v1/cards) or the inline pair
number + expiry — never both.
Option 1
Option 2
Show child attributes
merchant
object
Optional merchant overrides. Only website can be overridden.
All other merchant fields (name, category_code, country) are
always derived from the Company entity. The merchant name shown
to the cardholder during a challenge is the company's legal name
(full_name), shortened to the 40 characters the 3DS
specification allows.
Cardholder name. Accented and non-Latin characters are accepted; accents are folded for authentication (e.g. "João" is authenticated as "Joao"), while the name is stored exactly as sent. Names that cannot be folded to unaccented Latin letters may be rejected by the authentication provider. Names containing invalid characters are rejected. Not allowed together with card.card_id: a stored card supplies its own cardholder_name, so set it when storing the card. The other payer fields (payer_email, payer_document, billing_address) are still accepted with a stored card.
Example:
"João da Silva"
payer_document
string
Cardholder document (CPF, etc.)
Example:
"123.456.789-00"
billing_address
object
Show child attributes
Response
3DS session created successfully
id
string<uuid>
required
Internal 3DS session ID (use as three_d_secure_session_id when creating a transaction)
Example:
"550e8400-e29b-41d4-a716-446655440000"
tds_session_id
string
required
Provider session ID (use with the client-side SDK for challenge flows)
Example:
"tds_visa_e7c2yfa3867c"
card_id
string<uuid> | null
required
The stored card this session authenticated, or null when the card was
sent inline. When both this and the transaction's card_data.card_id are
set, they must match or the transaction is rejected.
Example:
"123e4567-e89b-12d3-a456-426614174000"
auth_status
enum<string>
required
Current authentication status:
ACTION_REQUIRED: Cardholder must complete 3DS challenge
AUTHENTICATED: Authentication successful (frictionless or completed challenge),
or only attempted: with authentication_flow: attempt the cardholder was not
authenticated and only proof of the attempt exists
FAILED: Authentication failed
Available options:
ACTION_REQUIRED,
AUTHENTICATED,
FAILED
Example:
"AUTHENTICATED"
consumption_status
enum<string>
required
Whether this session has been used for a transaction:
NOT_CONSUMED: Available for use
PROCESSING: Currently being used (atomic claim)
CONSUMED: Already used for a transaction
Available options:
NOT_CONSUMED,
PROCESSING,
CONSUMED
Example:
"NOT_CONSUMED"
amount
integer
required
Amount in minor units (cents)
Example:
10000
currency
string
required
ISO 4217 currency code
Example:
"BRL"
failure_reason
string | null
required
Reason for authentication failure (only present when auth_status is FAILED)
Example:
null
liability_shift
boolean | null
required
Whether liability has shifted to the issuer
Example:
true
authentication_flow
string | null
required
3DS authentication flow type (frictionless, challenge, attempt). attempt
comes with auth_status: AUTHENTICATED, but the cardholder was not
authenticated: only proof of the authentication attempt exists.
Example:
"frictionless"
acs_transaction_id
string | null
required
Transaction ID the issuer's Access Control Server (ACS) assigned to the
authentication. Recorded with the outcome: null while auth_status is
ACTION_REQUIRED, and when it was not reported.
Example:
"b0bb6068-8d68-40a1-9606-20fa01ba74de"
ds_transaction_id
string | null
required
Transaction ID the card network's Directory Server (DS) assigned to the
authentication, which the network uses to find it, for example in a
chargeback dispute. Recorded with the outcome: null while auth_status
is ACTION_REQUIRED, and when it was not reported.
Example:
"cfb8d11b-8129-414e-983a-3e95f0f4f6c6"
server_transaction_id
string | null
required
Transaction ID the 3DS Server assigned to the authentication. Recorded
with the outcome: null while auth_status is ACTION_REQUIRED, and when
it was not reported.
Example:
"dc46fbb1-a898-4760-b8a2-56dae36cb0e2"
protocol_version
string | null
required
EMV 3-D Secure protocol version of the authentication. Recorded with the
outcome: null while auth_status is ACTION_REQUIRED, and when it was
not reported.
Example:
"2.2.0"
expires_at
string<date-time>
required
Session expiration time
Example:
"2026-02-06T20:35:00.000Z"
created_at
string<date-time>
required
Example:
"2026-02-06T19:35:00.000Z"
updated_at
string<date-time>
required
Example:
"2026-02-06T19:35:00.000Z"
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Rinne API","description":"Complete payment infrastructure platform for managing merchants, processing transactions, and handling banking operations through a unified API.","colors":{"primary":"#5B68EB","light":"#7B89FF","dark":"#4A56D9"},"logo":{"light":"https://mintcdn.com/rinne/HqyHJ9XOsH5pEihc/logo/light.png?fit=max\u0026auto=format\u0026n=HqyHJ9XOsH5pEihc\u0026q=85\u0026s=be4ff200f82e7246a248176e8984208e","dark":"https://mintcdn.com/rinne/HqyHJ9XOsH5pEihc/logo/dark.png?fit=max\u0026auto=format\u0026n=HqyHJ9XOsH5pEihc\u0026q=85\u0026s=9b2f4edc9954aa480599989b1d02a14c"},"favicon":"https://mintcdn.com/rinne/4tTXHIJ8SxCdkDlA/favicon.ico?fit=max\u0026auto=format\u0026n=4tTXHIJ8SxCdkDlA\u0026q=85\u0026s=44d026fd81d41117a9776dd8721e24dd","navbar":{"links":[{"href":"mailto:[email protected]","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://sandbox.rinne.com.br"}},"footer":{"socials":{}},"seo":{"metatags":{"og:title":"Rinne API Documentation","og:description":"Complete payment infrastructure platform for managing merchants, processing transactions, and handling banking operations through a unified API.","og:site_name":"Rinne API","twitter:title":"Rinne API Documentation","twitter:description":"Complete payment infrastructure platform for managing merchants, processing transactions, and handling banking operations through a unified API.","twitter:card":"summary_large_image"}},"contextual":{"options":["copy","cursor","mcp","vscode","view","chatgpt","claude","perplexity"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"rinne","hasAudioNarration":false,"actualSubdomain":"rinne","customDomains":["docs.rinne.com.br"],"gitSource":{"type":"github","owner":"rinnebr","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af787aa57903cb872e282ab","clientVersion":"0.0.4131","searchFilterCounts":[{"language":"default","tag":"API Reference","count":183},{"language":"default","tag":"Merchants","count":72},{"language":"default","tag":"Organization Management","count":63},{"language":"default","tag":"Webhooks","count":26},{"language":"default","tag":"Documentation","count":25},{"language":"default","tag":"Events","count":25},{"language":"default","tag":"Cashouts","count":14},{"language":"default","tag":"Company Cashouts","count":14},{"language":"default","tag":"TapOnPhone","count":13},{"language":"default","tag":"Transactions","count":13}]},"assistantConfig":{"enableAskAiButton":true,"enableStarterQuestions":false,"enableAskAiSearchBar":false},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"styles/tap-on-phone-simulator.css","content":"@font-face{font-family:\"Sora\";src:url(\"/fonts/sora-variable.woff2\") format(\"woff2\"),\n url(\"/fonts/sora-variable.ttf\") format(\"truetype\");font-weight:100 800;font-style:normal;font-display:swap}@font-face{font-family:\"Space Grotesk\";src:url(\"/fonts/space-grotesk-variable.woff2\") format(\"woff2\"),\n url(\"/fonts/space-grotesk-variable.ttf\") format(\"truetype\");font-weight:300 700;font-style:normal;font-display:swap}.rtp{--rtp-bg: #f6f5fa;--rtp-panel: #ffffff;--rtp-panel-2: #f1f0f6;--rtp-line: #e3e1ec;--rtp-ink: #1b1a22;--rtp-muted: #6b6880;--rtp-accent: #5b68eb;--rtp-accent-ink: #ffffff;--rtp-accent-soft: rgba(91, 104, 235, 0.12);--rtp-ok: #16a75e;--rtp-warn: #b45309;--rtp-code-bg: #15141b;--rtp-code-ink: #e9e7f3;--rtp-code-muted: #8f8ca6;--rtp-code-k: #c792ea;--rtp-code-s: #c3e88d;--rtp-code-n: #f78c6c;--rtp-code-t: #82aaff;--rtp-halo: rgba(122, 76, 255, 0.22);--rtp-sticky-top: 104px;--rtp-radius: 18px;position:relative;color:var(--rtp-ink);font-family:ui-sans-serif, system-ui, -apple-system, \"Segoe UI\", Roboto, sans-serif;font-size:14px;line-height:1.45;container-type:inline-size;container-name:rtp;margin:1.5rem 0 2rem}html.dark .rtp,:root[data-theme=\"dark\"] .rtp{--rtp-bg: #15141b;--rtp-panel: #1e1d26;--rtp-panel-2: #26252f;--rtp-line: #2e2c3a;--rtp-ink: #eceaf4;--rtp-muted: #9b98ae;--rtp-accent: #7b89ff;--rtp-accent-ink: #0f0e14;--rtp-accent-soft: rgba(123, 137, 255, 0.16);--rtp-code-bg: #0f0e14;--rtp-halo: rgba(123, 137, 255, 0.28)}.rtp *,.rtp *::before,.rtp *::after{box-sizing:border-box}:where(.rtp) button,:where(.rtp) input,:where(.rtp) select{font:inherit;color:inherit}.rtp button{-webkit-tap-highlight-color:transparent}.rtp button:focus-visible,.rtp input:focus-visible,.rtp select:focus-visible,.rtp a:focus-visible{outline:2px solid var(--rtp-accent);outline-offset:2px}.rtp-sr{position:absolute;width:1px;height:1px;margin:-1px;padding:0;overflow:hidden;clip:rect(0 0 0 0);white-space:nowrap;border:0}.rtp-studio{display:grid;gap:16px;grid-template-columns:minmax(0, 1fr);grid-template-areas:\"stage\"\n \"inspector\"\n \"code\"}.rtp-studio>*{min-width:0}.rtp-studio>.rtp-stage-col{grid-area:stage;align-self:stretch;min-width:0}@container rtp (max-width: 639.98px){.rtp-studio>.rtp-stage-col{display:contents}}.rtp-studio>.rtp-inspector{grid-area:inspector}.rtp-studio>.rtp-code{grid-area:code}@container rtp (min-width: 640px){.rtp-studio{gap:20px;grid-template-columns:clamp(250px, 40cqw, 400px) minmax(0, 1fr);grid-template-areas:\"stage inspector\"\n \"code code\";align-items:start}.rtp-stage{position:sticky;top:var(--rtp-sticky-top)}.rtp-studio>.rtp-inspector{align-self:stretch;height:0;min-height:100%}.rtp-studio>.rtp-inspector .rtp-panel{flex:1;min-height:0;overflow-y:auto}.rtp-studio>.rtp-stage-col>.rtp-stage{min-height:100%}.rtp-grid.two{grid-template-columns:1fr 1fr}.rtp-grid.two>.rtp-field:has(>.rtp-seg){grid-column:1 / -1}.rtp-stage .rtp-phone-wrap{margin:auto 0}}@container rtp (min-width: 900px){.rtp-studio>.rtp-stage-col>.rtp-stage{min-height:auto}}.rtp-inspector-foot{margin-top:auto;border-top:1px solid var(--rtp-line);padding:12px 14px 14px;display:flex;flex-direction:column;gap:10px}.rtp-inspector-foot .rtp-caption,.rtp-inspector-foot .rtp-hint{text-align:left;padding:0}.rtp-inspector-foot .rtp-actions{justify-content:flex-start}@container rtp (min-width: 900px){.rtp-studio{grid-template-areas:\"stage inspector\"\n \"stage code\"}}.rtp-stage{background:var(--rtp-panel);border:1px solid var(--rtp-line);border-radius:var(--rtp-radius);padding:12px 12px 14px;display:flex;flex-direction:column;gap:12px}.rtp-phone-wrap::before{content:\"\";position:absolute;left:50%;top:50%;width:78%;height:78%;transform:translate(-50%, -50%);border-radius:50%;background:radial-gradient(closest-side, var(--rtp-halo), transparent 70%);filter:blur(32px);opacity:0.35;pointer-events:none;z-index:0}.rtp-phone-wrap .rtp-device{z-index:1}.rtp-preview .rtp-stage{background:transparent;border:0;border-radius:0;padding:0;gap:10px}.rtp-stage-head{display:flex;align-items:center;justify-content:space-between;gap:8px;min-width:0}.rtp-stage-title{font-size:12px;font-weight:700;letter-spacing:0.08em;text-transform:uppercase;color:var(--rtp-muted);white-space:nowrap}.rtp-phone-wrap{display:flex;justify-content:center;position:relative}.rtp-caption{text-align:center;font-size:12.5px;color:var(--rtp-muted);min-height:1.4em;padding:0 4px}.rtp-caption strong{color:var(--rtp-ink);font-weight:600}.rtp-actions{display:flex;flex-wrap:wrap;gap:8px;justify-content:center}.rtp-hint{font-size:12px;color:var(--rtp-muted);text-align:center}.rtp-chips{display:flex;gap:6px;overflow-x:auto;scrollbar-width:none;padding:2px 0;-webkit-overflow-scrolling:touch}.rtp-chips::-webkit-scrollbar{display:none}.rtp-chips.wrap{flex-wrap:wrap;overflow:visible}.rtp-scroller{position:relative;display:flex;align-items:center;gap:6px;min-width:0}.rtp-scroller>.rtp-chips{flex:1 1 auto;min-width:0}.rtp-scroller.has-right:not(.has-left) .rtp-chips{-webkit-mask-image:linear-gradient(to right, #000 calc(100% - 48px), transparent);mask-image:linear-gradient(to right, #000 calc(100% - 48px), transparent)}.rtp-scroller.has-left:not(.has-right) .rtp-chips{-webkit-mask-image:linear-gradient(to right, transparent, #000 48px);mask-image:linear-gradient(to right, transparent, #000 48px)}.rtp-scroller.has-left.has-right .rtp-chips{-webkit-mask-image:linear-gradient(to right, transparent, #000 48px, #000 calc(100% - 48px), transparent);mask-image:linear-gradient(to right, transparent, #000 48px, #000 calc(100% - 48px), transparent)}.rtp-scroll-btn{flex:none;width:30px;height:30px;padding:0;border-radius:50%;border:1px solid var(--rtp-line);background:var(--rtp-panel);color:var(--rtp-ink);box-shadow:0 2px 10px rgba(20, 16, 40, 0.14);display:flex;align-items:center;justify-content:center;cursor:pointer;z-index:2}.rtp-scroll-btn svg{width:14px;height:14px}.rtp-chip{flex:none;display:inline-flex;align-items:center;gap:7px;min-height:34px;padding:6px 12px;border:1px solid var(--rtp-line);border-radius:999px;background:var(--rtp-panel);color:var(--rtp-ink);font-size:12.5px;font-weight:600;white-space:nowrap;cursor:pointer;transition:background-color 0.15s, border-color 0.15s, color 0.15s}.rtp-chip:hover:not(:disabled){border-color:var(--rtp-accent)}.rtp-chip[aria-checked=\"true\"],.rtp-chip[aria-pressed=\"true\"],.rtp-chip.is-on{background:var(--rtp-accent);border-color:var(--rtp-accent);color:var(--rtp-accent-ink)}.rtp-chip:disabled{opacity:0.45;cursor:default}.rtp-chip .rtp-swatch{width:12px;height:12px;border-radius:50%;box-shadow:inset 0 0 0 1px rgba(0, 0, 0, 0.12);flex:none}.rtp-chip .rtp-swatch.empty{background:transparent;box-shadow:inset 0 0 0 1.5px currentColor;opacity:0.5}.rtp-chip .rtp-dotmark{width:6px;height:6px;border-radius:50%;background:currentColor;opacity:0.55}.rtp-btn-chrome{display:inline-flex;align-items:center;gap:7px;min-height:38px;padding:8px 14px;border-radius:12px;border:1px solid var(--rtp-line);background:var(--rtp-panel);color:var(--rtp-ink);font-size:13px;font-weight:600;cursor:pointer;white-space:nowrap;transition:background-color 0.15s, border-color 0.15s, transform 0.1s}.rtp-btn-chrome:hover:not(:disabled){border-color:var(--rtp-accent)}.rtp-btn-chrome:active:not(:disabled){transform:scale(0.98)}.rtp-btn-chrome:disabled{opacity:0.45;cursor:default}.rtp-btn-chrome.primary{background:var(--rtp-accent);border-color:var(--rtp-accent);color:var(--rtp-accent-ink)}.rtp-btn-chrome.dashed{border-style:dashed;border-color:var(--rtp-accent);color:var(--rtp-accent);background:transparent}.rtp-btn-chrome svg{width:15px;height:15px;flex:none}.rtp-icon-btn{width:34px;height:34px;padding:0;justify-content:center;border-radius:10px}.rtp-device{--sdk-SIDE_PADDING_DP: 24px;--sdk-HEADER_CORNER_DP: 36px;--sdk-HEADER_TOP_DP: 12px;--sdk-HEADER_BOTTOM_FULL_DP: 28px;--sdk-HEADER_BOTTOM_WASH_DP: 12px;--sdk-MERCHANT_SIZE_SP: 12px;--sdk-CLOSE_SIZE_DP: 38px;--sdk-CLOSE_GLYPH_DP: 16px;--sdk-CLOSE_BORDER_ALPHA: 0.45;--sdk-CURRENCY_SIZE_SP: 22px;--sdk-CURRENCY_END_DP: 6px;--sdk-CURRENCY_BASELINE_DP: 8px;--sdk-AMOUNT_SIZE_SP: 56px;--sdk-AMOUNT_TRACKING_SP: -1.5px;--sdk-AMOUNT_TOP_DP: 14px;--sdk-DESCRIPTOR_SIZE_SP: 13px;--sdk-DESCRIPTOR_TOP_DP: 6px;--sdk-DESCRIPTOR_ALPHA: 0.85;--sdk-ICON_SLOT_HEIGHT_DP: 150px;--sdk-TITLE_SIZE_SP: 22px;--sdk-TITLE_LINE_SP: 28px;--sdk-TITLE_TOP_DP: 4px;--sdk-SUBTITLE_SIZE_SP: 13px;--sdk-SUBTITLE_LINE_SP: 19px;--sdk-SUBTITLE_TOP_DP: 10px;--sdk-SUBTITLE_MAX_WIDTH_DP: 300px;--sdk-FOOTER_MIN_HEIGHT_DP: 124px;--sdk-FOOTER_BOTTOM_DP: 12px;--sdk-RING_SIZE_DP: 74px;--sdk-SPIN_MILLIS: 850ms;--sdk-BADGE_GLOW_SIZE_DP: 150px;--sdk-BADGE_SIZE_DP: 118px;--sdk-BADGE_GLYPH_DP: 52px;--sdk-BADGE_POP_MILLIS: 500ms;--sdk-BUTTON_RADIUS_DP: 18px;--sdk-BUTTON_HEIGHT_DP: 58px;--sdk-BUTTON_TEXT_SP: 13px;--sdk-BUTTON_TRACKING_SP: 2px;--sdk-SECONDARY_TRACKING_SP: 1.8px;--sdk-FOOTER_GAP_DP: 10px;--sdk-LABEL_SIZE_SP: 9px;--sdk-LABEL_TRACKING_SP: 1.8px;--sdk-LABEL_TOP_PADDING_DP: 12px;--sdk-SYMBOL_WIDTH_DP: 218px;--sdk-SYMBOL_HEIGHT_DP: 145px;--sdk-MARK_HEIGHT_DP: 25px;--sdk-MARK_SPACING_DP: 9px;--sdk-SURFACE: #ffffff;--sdk-INK: #15181e;--sdk-SLATE: #5b6470;--sdk-FAINT: #aeb4be;--sdk-HAIRLINE: #e2e5ec;--sdk-SUCCESS: #16a75e;--sdk-DANGER: #ff5c5c;--sdk-PAD_SURFACE: #ffffff;--sdk-PAD_BACKGROUND: #f4f5f8;--sdk-PAD_TINT: #eceef3;--sdk-PAD_INK: #15181e;--sdk-PAD_SLATE: #5b6470;--sdk-PAD_ERROR: #d92d20;--sdk-KEY_FONT_SIZE_SP: 24px;--sdk-ACTION_FONT_SIZE_SP: 12px;--rtp-status-h: 28px;--rtp-nav-h: 24px;--rtp-scale: 1;--rtp-primary: #7a4cff;--rtp-on-primary: #ffffff;--rtp-button: #7a4cff;--rtp-on-button: #ffffff;--rtp-icon: #15181e;--rtp-header-start: #7a4cff;--rtp-header-end: #7a4cff;--rtp-header-text: #ffffff;--rtp-header-radius: 36px;--rtp-header-pad-bottom: 28px;--rtp-accent-soft-sdk: #e7deff;--rtp-close-border: rgba(255, 255, 255, 0.45);--rtp-status-ink: #ffffff;--rtp-glow: rgba(122, 76, 255, 0.35);--rtp-glow-strong: rgba(122, 76, 255, 0.8);position:relative;width:382px;height:822px;zoom:var(--rtp-scale);border-radius:52px;background:#000;padding:11px;box-shadow:0 0 0 2px #2a2230, 0 30px 70px -24px rgba(40, 30, 70, 0.32);font-family:\"Space Grotesk\", ui-sans-serif, system-ui, sans-serif;color:var(--sdk-INK);user-select:none;flex:none}@supports not (zoom: 1){.rtp-device{transform:scale(var(--rtp-scale));transform-origin:top center}.rtp-phone-wrap{height:calc(822px * var(--rtp-scale));overflow:visible}}.rtp-glass{position:absolute;inset:11px;border-radius:42px;overflow:hidden;background:var(--sdk-SURFACE)}.rtp-hole{position:absolute;top:9px;left:50%;width:12px;height:12px;margin-left:-6px;border-radius:50%;background:#000;box-shadow:inset 0 0 0 2px #1c1f25, 0 0 0 1px rgba(0, 0, 0, 0.4);z-index:40}.rtp-screen{position:absolute;inset:0;width:360px;height:800px;display:flex;flex-direction:column;background:var(--sdk-SURFACE);font-size:13px;line-height:1.2}.rtp-status{height:var(--rtp-status-h);flex:none;display:flex;align-items:center;justify-content:space-between;padding:2px 22px 0;color:var(--rtp-status-ink);font-size:13px;font-weight:600;letter-spacing:0.02em;font-variant-numeric:tabular-nums}.rtp-status-icons{display:flex;align-items:center;gap:6px}.rtp-status-icons svg{display:block}.rtp-navbar{position:absolute;left:0;right:0;bottom:0;height:var(--rtp-nav-h);display:flex;align-items:flex-end;justify-content:center;padding-bottom:8px;pointer-events:none;z-index:30}.rtp-navbar span{width:108px;height:4px;border-radius:2px;background:var(--sdk-INK);opacity:0.85}.rtp-display{font-family:\"Sora\", ui-sans-serif, system-ui, sans-serif}.rtp-header{position:relative;flex:none;padding:0 var(--sdk-SIDE_PADDING_DP) var(--rtp-header-pad-bottom);border-radius:0 0 var(--rtp-header-radius) var(--rtp-header-radius);background:linear-gradient(var(--rtp-header-start), var(--rtp-header-end));color:var(--rtp-header-text);transition:border-radius 0.15s}.rtp-header .rtp-status{margin:0 calc(-1 * var(--sdk-SIDE_PADDING_DP))}.rtp-header-body{padding-top:var(--sdk-HEADER_TOP_DP)}.rtp-merchant{height:var(--sdk-CLOSE_SIZE_DP);position:relative;display:flex;align-items:center;justify-content:center;font-weight:600;font-size:var(--sdk-MERCHANT_SIZE_SP)}.rtp-close{position:absolute;left:0;top:0;width:var(--sdk-CLOSE_SIZE_DP);height:var(--sdk-CLOSE_SIZE_DP);border-radius:50%;border:1px solid var(--rtp-close-border);background:transparent;display:flex;align-items:center;justify-content:center;cursor:pointer;padding:0;color:inherit}.rtp-amount{display:flex;justify-content:center;align-items:flex-end;margin-top:var(--sdk-AMOUNT_TOP_DP)}.rtp-currency{font-weight:600;font-size:var(--sdk-CURRENCY_SIZE_SP);line-height:1;margin:0 var(--sdk-CURRENCY_END_DP) var(--sdk-CURRENCY_BASELINE_DP) 0}.rtp-figure{font-weight:700;font-size:var(--sdk-AMOUNT_SIZE_SP);line-height:1;letter-spacing:var(--sdk-AMOUNT_TRACKING_SP);font-variant-numeric:tabular-nums}.rtp-descriptor{font-size:var(--sdk-DESCRIPTOR_SIZE_SP);opacity:var(--sdk-DESCRIPTOR_ALPHA);margin-top:var(--sdk-DESCRIPTOR_TOP_DP);text-align:center}.rtp-body{flex:1;min-height:0;display:flex;flex-direction:column;align-items:center;justify-content:center;text-align:center;padding:0 var(--sdk-SIDE_PADDING_DP)}.rtp-icon-slot{height:var(--sdk-ICON_SLOT_HEIGHT_DP);width:100%;display:flex;align-items:center;justify-content:center}.rtp-title{font-weight:600;font-size:var(--sdk-TITLE_SIZE_SP);line-height:var(--sdk-TITLE_LINE_SP);margin-top:var(--sdk-TITLE_TOP_DP);color:var(--sdk-INK);text-wrap:balance}.rtp-subtitle{font-size:var(--sdk-SUBTITLE_SIZE_SP);line-height:var(--sdk-SUBTITLE_LINE_SP);color:var(--sdk-SLATE);margin-top:var(--sdk-SUBTITLE_TOP_DP);max-width:var(--sdk-SUBTITLE_MAX_WIDTH_DP);white-space:pre-line}.rtp-footer{flex:none;min-height:calc(var(--sdk-FOOTER_MIN_HEIGHT_DP) + var(--rtp-nav-h));padding:0 var(--sdk-SIDE_PADDING_DP) calc(var(--sdk-FOOTER_BOTTOM_DP) + var(--rtp-nav-h));display:flex;flex-direction:column;justify-content:flex-end;gap:var(--sdk-FOOTER_GAP_DP)}.rtp-art{width:var(--sdk-SYMBOL_WIDTH_DP);height:var(--sdk-SYMBOL_HEIGHT_DP);background:var(--rtp-icon);-webkit-mask:url(\"/images/tap-on-phone/nfc-tap.png\") center / contain no-repeat;mask:url(\"/images/tap-on-phone/nfc-tap.png\") center / contain no-repeat}.rtp-marks{display:flex;flex-direction:column;align-items:center}.rtp-marks-row{display:flex;gap:var(--sdk-MARK_SPACING_DP);align-items:center}.rtp-marks-row svg{height:var(--sdk-MARK_HEIGHT_DP);width:auto;display:block}.rtp-marks-label{font-size:var(--sdk-LABEL_SIZE_SP);letter-spacing:var(--sdk-LABEL_TRACKING_SP);color:var(--sdk-FAINT);margin-top:var(--sdk-LABEL_TOP_PADDING_DP);text-align:center}.rtp-ring{width:var(--sdk-RING_SIZE_DP);height:var(--sdk-RING_SIZE_DP);animation:rtp-spin var(--sdk-SPIN_MILLIS) linear infinite}.rtp-badge{width:var(--sdk-BADGE_GLOW_SIZE_DP);height:var(--sdk-BADGE_GLOW_SIZE_DP);display:flex;align-items:center;justify-content:center;position:relative;animation:rtp-pop var(--sdk-BADGE_POP_MILLIS) cubic-bezier(0.4, 0, 0.2, 1)}.rtp-badge-glow{position:absolute;inset:0;border-radius:50%}.rtp-badge-disc{width:var(--sdk-BADGE_SIZE_DP);height:var(--sdk-BADGE_SIZE_DP);border-radius:50%;display:flex;align-items:center;justify-content:center;position:relative}.rtp-badge-disc svg{width:var(--sdk-BADGE_GLYPH_DP);height:var(--sdk-BADGE_GLYPH_DP)}.rtp-btn{width:100%;height:var(--sdk-BUTTON_HEIGHT_DP);border:0;border-radius:var(--sdk-BUTTON_RADIUS_DP);font-family:inherit;font-weight:600;font-size:var(--sdk-BUTTON_TEXT_SP);letter-spacing:var(--sdk-BUTTON_TRACKING_SP);color:var(--rtp-on-button);background:var(--rtp-button);cursor:pointer;flex:none}.rtp-btn.secondary{background:transparent;border:1px solid var(--sdk-HAIRLINE);color:var(--sdk-SLATE);letter-spacing:var(--sdk-SECONDARY_TRACKING_SP)}.rtp-tapzone{position:absolute;inset:0;background:transparent;border:0;padding:0;cursor:pointer;z-index:20}.rtp-host{position:absolute;inset:0;display:flex;flex-direction:column;background:#f4f5f8;color:#15181e}.rtp-host .rtp-status{color:#15181e}.rtp-host-top{display:flex;align-items:center;gap:10px;padding:10px 24px 0}.rtp-host-badge{display:inline-flex;align-items:center;padding:5px 11px;border:1.5px dashed #b6bcc8;border-radius:999px;font-size:11px;font-weight:700;letter-spacing:0.14em;text-transform:uppercase;color:#5b6470}.rtp-host-sub{font-size:11px;color:#8a909c}.rtp-host-body{flex:1;min-height:0;padding:22px 24px 0;display:flex;flex-direction:column;gap:12px}.rtp-wire{height:14px;border-radius:7px;background:#e3e6ec}.rtp-wire.tall{width:100%;height:56px;border-radius:14px;background:transparent;border:1.5px dashed #cfd4dd}.rtp-host-total{margin-top:auto;padding:14px 24px calc(14px + var(--rtp-nav-h));border-top:1px solid #eaecf1;background:#fff}.rtp-host-total-row{display:flex;align-items:flex-end;justify-content:space-between}.rtp-host-total-row b{font-size:22px;font-weight:700;letter-spacing:-0.3px;font-variant-numeric:tabular-nums}.rtp-host-total-row small{display:block;font-size:11px;letter-spacing:0.12em;text-transform:uppercase;color:#8a909c}.rtp-host-cta{margin-top:12px;width:100%;height:56px;border:0;border-radius:16px;background:var(--rtp-primary);color:var(--rtp-on-primary);font-family:ui-monospace, SFMono-Regular, Menlo, monospace;font-size:14px;font-weight:600;cursor:pointer;display:flex;align-items:center;justify-content:center}.rtp-pad{position:absolute;inset:0;background:var(--sdk-PAD_BACKGROUND);display:flex;flex-direction:column;font-family:\"Sora\", ui-sans-serif, system-ui, sans-serif;z-index:50}.rtp-pad-status{height:24px;flex:none}.rtp-pad-nav{height:56px;flex:none;display:flex;align-items:center;padding:0 14px;font-weight:400;font-size:15px;letter-spacing:4px;white-space:nowrap;overflow:hidden;background:var(--rtp-primary);color:var(--rtp-on-primary)}.rtp-pad-amount{height:100px;flex:none;display:flex;flex-direction:column;align-items:center;justify-content:center;font-size:26px;color:var(--sdk-PAD_INK);font-variant-numeric:tabular-nums}.rtp-pad-details{font-size:13px;color:var(--sdk-PAD_SLATE);margin-top:2px}.rtp-dots{display:flex;gap:8px;justify-content:center;margin-top:8px;height:10px}.rtp-dot{width:10px;height:10px;border-radius:50%;background:transparent}.rtp-dot.on{background:var(--rtp-primary)}.rtp-pad-grid{flex:1;min-height:0;display:grid;gap:3px}.rtp-pad-grid.five{grid-template-columns:repeat(5, 1fr);grid-template-rows:repeat(6, 1fr)}.rtp-pad-grid.three{grid-template-columns:repeat(3, 1fr);grid-template-rows:repeat(5, 1fr)}.rtp-pad-cell{border:0;border-radius:0;background:var(--sdk-PAD_SURFACE);font-family:inherit;font-size:var(--sdk-KEY_FONT_SIZE_SP);font-weight:400;color:var(--sdk-PAD_INK);cursor:pointer;padding:0}.rtp-pad-cell.blank{cursor:default}.rtp-pad-action{border:0;background:var(--sdk-PAD_TINT);color:var(--sdk-PAD_SLATE);font-family:inherit;font-size:var(--sdk-ACTION_FONT_SIZE_SP);display:flex;flex-direction:column;align-items:center;justify-content:center;gap:6px;cursor:pointer;padding:0}.rtp-pad-action.tall{grid-row:span 2}.rtp-pad-action-icon{width:22px;height:22px;border-radius:50%;display:flex;align-items:center;justify-content:center}.rtp-pad-action-icon.cancel{background:#ff4b3a}.rtp-pad-action-icon.clear{background:#ffc72c}.rtp-pad-action-icon.confirm{background:#2eb872}.rtp-pad-bar{height:88px;flex:none;margin-top:3px;background:var(--sdk-PAD_TINT);display:flex;align-items:stretch}.rtp-pad-bar .rtp-pad-action{flex:1;background:transparent}.rtp-pad-divider{width:1px;background:var(--sdk-PAD_SURFACE);margin:24px 0}.rtp-card{position:absolute;left:50%;top:30%;width:156px;height:98px;margin-left:-78px;border-radius:12px;opacity:0;pointer-events:none;z-index:60;filter:drop-shadow(0 18px 24px rgba(20, 16, 40, 0.35));transform:translate(240px, -60px) rotate(14deg);display:none}.rtp-card.glide{display:block;animation:rtp-glide 0.9s cubic-bezier(0.2, 0.8, 0.2, 1) forwards}.rtp-card svg{width:100%;height:100%;display:block}.rtp-inspector{background:var(--rtp-panel);border:1px solid var(--rtp-line);border-radius:var(--rtp-radius);display:flex;flex-direction:column;min-width:0}.rtp-inspector-head{display:flex;align-items:center;justify-content:space-between;gap:10px;padding:12px 14px 10px;border-bottom:1px solid var(--rtp-line);min-width:0}.rtp-inspector-title{display:flex;align-items:center;gap:8px;font-size:14px;font-weight:700;min-width:0;white-space:nowrap}.rtp-badge-chip{display:inline-flex;align-items:center;gap:6px;padding:3px 9px;border-radius:999px;background:var(--rtp-panel-2);color:var(--rtp-muted);font-size:11px;font-weight:600;letter-spacing:0.04em;white-space:nowrap}.rtp-badge-chip .rtp-live{width:7px;height:7px;border-radius:50%;background:var(--rtp-ok);box-shadow:0 0 0 3px rgba(22, 167, 94, 0.18)}.rtp-inspector-tools{display:flex;gap:6px;flex:none}.rtp-tabs{display:flex;gap:2px;padding:8px 10px 0;overflow-x:auto;scrollbar-width:none;border-bottom:1px solid var(--rtp-line)}.rtp-tabs::-webkit-scrollbar{display:none}.rtp-tab{flex:none;border:0;background:transparent;padding:8px 12px 10px;font-size:13px;font-weight:600;color:var(--rtp-muted);cursor:pointer;border-bottom:2px solid transparent;margin-bottom:-1px;white-space:nowrap;transition:color 0.15s, border-color 0.15s}.rtp-tab[aria-selected=\"true\"]{color:var(--rtp-accent);border-bottom-color:var(--rtp-accent)}.rtp-panel{padding:14px;display:flex;flex-direction:column;gap:16px}.rtp-grid{display:grid;grid-template-columns:1fr;gap:14px 16px}@container rtp (min-width: 900px){.rtp-grid.two{grid-template-columns:1fr 1fr}}.rtp-grid.roomy{grid-template-columns:1fr;gap:18px}.rtp-field{display:flex;flex-direction:column;gap:6px;min-width:0}.rtp-label{display:flex;align-items:baseline;flex-wrap:wrap;gap:6px 8px;font-size:11px;font-weight:700;letter-spacing:0.06em;text-transform:uppercase;color:var(--rtp-muted)}.rtp-label code{font-family:ui-monospace, SFMono-Regular, Menlo, monospace;font-size:11px;font-weight:500;text-transform:none;letter-spacing:0;color:var(--rtp-ink);background:var(--rtp-panel-2);padding:1px 6px;border-radius:6px}.rtp-input{width:100%;min-width:0;border:1px solid var(--rtp-line);background:var(--rtp-bg);color:var(--rtp-ink);border-radius:10px;padding:9px 11px;font-size:13.5px;line-height:1.3}.rtp-input::placeholder{color:var(--rtp-muted);opacity:0.8}.rtp-input.mono{font-family:ui-monospace, SFMono-Regular, Menlo, monospace;text-transform:uppercase}.rtp-input-row{display:flex;align-items:center;gap:8px;min-width:0}.rtp-input-row .rtp-input{flex:1}.rtp-color-swatch{position:relative;width:36px;height:36px;flex:none;border-radius:50%;border:1px solid var(--rtp-line);overflow:hidden;box-shadow:inset 0 0 0 3px var(--rtp-panel);cursor:pointer}.rtp-color-swatch input[type=\"color\"]{position:absolute;inset:-10px;width:calc(100% + 20px);height:calc(100% + 20px);border:0;padding:0;cursor:pointer;background:transparent}.rtp-note{font-size:12px;line-height:1.45;color:var(--rtp-muted)}.rtp-note.warn{color:var(--rtp-warn)}.rtp-note.ok{color:var(--rtp-ok)}.rtp-seg{display:grid;grid-template-columns:1fr 1fr;gap:8px}.rtp-seg-opt{border:1px solid var(--rtp-line);background:var(--rtp-bg);border-radius:12px;padding:8px;cursor:pointer;display:flex;flex-direction:column;gap:7px;text-align:left;min-width:0;transition:border-color 0.15s, box-shadow 0.15s}.rtp-seg-opt[aria-pressed=\"true\"]{border-color:var(--rtp-accent);box-shadow:0 0 0 2px var(--rtp-accent-soft)}.rtp-seg-opt b{font-size:12.5px;font-weight:700}.rtp-seg-opt small{font-size:11.5px;color:var(--rtp-muted);line-height:1.35}.rtp-thumb{height:44px;border-radius:8px;background:#fff;border:1px solid var(--rtp-line);overflow:hidden;display:flex;flex-direction:column}.rtp-thumb i{display:block;height:26px;flex:none}.rtp-thumb i.band{border-radius:0 0 10px 10px}.rtp-thumb em{display:block;height:6px;width:40%;margin:6px auto 0;border-radius:3px;background:#e2e5ec}.rtp-switch{display:flex;align-items:center;gap:10px;cursor:pointer;font-size:13px;min-width:0}.rtp-switch input{position:absolute;opacity:0;width:1px;height:1px}.rtp-switch .rtp-track{width:36px;height:22px;border-radius:999px;background:var(--rtp-line);position:relative;flex:none;transition:background-color 0.15s}.rtp-switch .rtp-track::after{content:\"\";position:absolute;top:3px;left:3px;width:16px;height:16px;border-radius:50%;background:#fff;box-shadow:0 1px 2px rgba(0, 0, 0, 0.25);transition:transform 0.15s}.rtp-switch input:checked+.rtp-track{background:var(--rtp-accent)}.rtp-switch input:checked+.rtp-track::after{transform:translateX(14px)}.rtp-switch input:focus-visible+.rtp-track{outline:2px solid var(--rtp-accent);outline-offset:2px}.rtp-select{width:100%;min-width:0;border:1px solid var(--rtp-line);background:var(--rtp-bg);color:var(--rtp-ink);border-radius:10px;padding:9px 11px;font-size:13.5px;appearance:auto}.rtp-kv{display:flex;flex-wrap:wrap;gap:6px 14px;font-size:12px;color:var(--rtp-muted)}.rtp-kv b{color:var(--rtp-ink);font-weight:600}.rtp-tag{display:inline-block;padding:1px 7px;border-radius:999px;font-size:10.5px;font-weight:700;letter-spacing:0.04em;text-transform:uppercase;background:var(--rtp-panel-2);color:var(--rtp-muted)}.rtp-tag.ok{background:rgba(22, 167, 94, 0.14);color:var(--rtp-ok)}.rtp-tag.no{background:rgba(255, 92, 92, 0.14);color:#c4362f}.rtp-code{background:var(--rtp-code-bg);color:var(--rtp-code-ink);border:1px solid var(--rtp-line);border-radius:var(--rtp-radius);overflow:hidden;min-width:0}.rtp-code-bar{display:flex;align-items:center;gap:2px;padding:6px 8px 0;border-bottom:1px solid rgba(255, 255, 255, 0.08);overflow-x:auto;scrollbar-width:none}.rtp-code-bar::-webkit-scrollbar{display:none}.rtp-code-tab{flex:none;border:0;background:transparent;color:var(--rtp-code-muted);padding:8px 12px 10px;font-size:12.5px;font-weight:600;border-bottom:2px solid transparent;margin-bottom:-1px;cursor:pointer;white-space:nowrap}.rtp-code-tab[aria-selected=\"true\"]{color:#fff;border-bottom-color:var(--rtp-accent)}.rtp-code-tools{margin-left:auto;display:flex;gap:6px;padding-bottom:4px;flex:none}.rtp-code-copy{border:1px solid rgba(255, 255, 255, 0.14);background:rgba(255, 255, 255, 0.06);color:#fff;border-radius:8px;padding:5px 10px;font-size:12px;font-weight:600;cursor:pointer;display:inline-flex;align-items:center;gap:6px;white-space:nowrap}.rtp-code-copy:hover{background:rgba(255, 255, 255, 0.12)}.rtp-code-copy.done{border-color:rgba(22, 167, 94, 0.6);color:#7ee0b0}.rtp-code-copy svg{width:13px;height:13px;flex:none}.rtp-btn-chrome.done{color:var(--rtp-ok);border-color:var(--rtp-ok)}.rtp-code pre{margin:0;padding:14px 16px 16px;font-family:ui-monospace, SFMono-Regular, Menlo, Consolas, monospace;font-size:12.5px;line-height:1.6;overflow-x:auto;color:inherit;background:transparent;white-space:pre;tab-size:4}.rtp-code .k{color:var(--rtp-code-k)}.rtp-code .s{color:var(--rtp-code-s)}.rtp-code .n{color:var(--rtp-code-n)}.rtp-code .t{color:var(--rtp-code-t)}.rtp-code .c{color:var(--rtp-code-muted);font-style:italic}.rtp-delivered{margin:0 12px 12px;border:1px solid rgba(22, 167, 94, 0.35);background:rgba(22, 167, 94, 0.08);border-radius:12px;padding:10px 12px}.rtp-delivered-title{font-size:12px;font-weight:700;color:#7ee0b0;margin-bottom:4px}.rtp-delivered pre{padding:0;font-size:12px}.rtp-preview{display:grid;gap:16px;grid-template-columns:minmax(0, 1fr);align-items:center}@container rtp (min-width: 560px){.rtp-preview{grid-template-columns:minmax(200px, 36cqw) minmax(0, 1fr);gap:36px}}.rtp-preview-aside{display:flex;flex-direction:column;gap:16px;min-width:0}.rtp-preview-aside h3{margin:0;font-size:19px;font-weight:700;letter-spacing:-0.01em;color:var(--rtp-ink)}.rtp-preview-aside p{margin:0;font-size:14px;color:var(--rtp-muted);line-height:1.55}.rtp-link{display:inline-flex;align-items:center;gap:6px;color:var(--rtp-accent);font-weight:600;font-size:13px;text-decoration:none}.rtp-link:hover{text-decoration:underline}@keyframes rtp-spin{to{transform:rotate(360deg)}}@keyframes rtp-pop{from{transform:scale(0.6)}to{transform:scale(1)}}@keyframes rtp-glide{0%{opacity:0;transform:translate(240px, -60px) rotate(14deg)}20%{opacity:1}70%{opacity:1;transform:translate(0, 0) rotate(-4deg)}85%{opacity:1;transform:translate(0, 4px) rotate(-4deg)}100%{opacity:0;transform:translate(0, 4px) rotate(-4deg)}}@media (prefers-reduced-motion: reduce){.rtp-ring,.rtp-badge,.rtp-card.glide{animation:none}.rtp-card.glide{opacity:0}.rtp *,.rtp *::before,.rtp *::after{transition:none!important}}.rtp-pip{position:fixed;right:14px;bottom:calc(96px + env(safe-area-inset-bottom, 0px));z-index:40;width:calc(382px * 0.22);cursor:pointer;border-radius:14px;filter:drop-shadow(0 12px 22px rgba(20, 16, 40, 0.35));animation:rtp-pip-in 0.2s ease-out}.rtp-pip:focus-visible{outline:2px solid var(--rtp-accent);outline-offset:4px}.rtp-pip-phone{pointer-events:none}@keyframes rtp-pip-in{from{opacity:0;transform:translateY(8px)}to{opacity:1;transform:none}}@media (prefers-reduced-motion: reduce){.rtp-pip{animation:none}}"},{"filePath":"styles/company-onboarding.css","content":".rco{--rco-bg: #f6f5fa;--rco-panel: #ffffff;--rco-panel-2: #f1f0f6;--rco-line: #e3e1ec;--rco-ink: #1b1a22;--rco-muted: #6b6880;--rco-accent: #5b68eb;--rco-accent-ink: #ffffff;--rco-accent-soft: rgba(91, 104, 235, 0.12);--rco-ok: #12804a;--rco-ok-solid: #16a75e;--rco-ok-soft: rgba(22, 167, 94, 0.13);--rco-wait: #9a4a07;--rco-wait-solid: #d97706;--rco-wait-soft: rgba(217, 119, 6, 0.13);--rco-code-bg: #15141b;--rco-code-ink: #e9e7f3;--rco-code-muted: #8f8ca6;--rco-shadow: 0 1px 2px rgba(20, 16, 40, 0.04), 0 8px 24px rgba(20, 16, 40, 0.06);--rco-radius: 18px;color:var(--rco-ink);font-family:ui-sans-serif, system-ui, -apple-system, \"Segoe UI\", Roboto, sans-serif;font-size:14px;line-height:1.45;container-type:inline-size;container-name:rco;margin:1.5rem 0 2rem}html.dark .rco,:root[data-theme=\"dark\"] .rco{--rco-bg: #15141b;--rco-panel: #1e1d26;--rco-panel-2: #26252f;--rco-line: #2e2c3a;--rco-ink: #eceaf4;--rco-muted: #9b98ae;--rco-accent: #7b89ff;--rco-accent-ink: #0f0e14;--rco-accent-soft: rgba(123, 137, 255, 0.16);--rco-ok: #4ade80;--rco-ok-solid: #22c55e;--rco-ok-soft: rgba(74, 222, 128, 0.14);--rco-wait: #fbbf24;--rco-wait-solid: #f59e0b;--rco-wait-soft: rgba(251, 191, 36, 0.14);--rco-code-bg: #0f0e14;--rco-shadow: none}.rco *,.rco *::before,.rco *::after{box-sizing:border-box}:where(.rco) button,:where(.rco) input{font:inherit;color:inherit}:where(.rco) p,:where(.rco) ul,:where(.rco) ol{margin:0;padding:0}.rco button{-webkit-tap-highlight-color:transparent}.rco button:focus-visible,.rco pre:focus-visible{outline:2px solid var(--rco-accent);outline-offset:2px}.rco code{font-family:ui-monospace, SFMono-Regular, Menlo, monospace}.rco ul,.rco ol{list-style:none!important;margin:0!important;padding:0!important}.rco li{margin:0!important;padding-left:0!important}.rco li:not(.rco-step)::before,.rco li::marker{content:none!important;display:none!important}.rco .rco-request code,.rco .rco-outcome-head code,.rco .rco-req-meta code{background:none;border:0;padding:0;border-radius:0;color:inherit}.rco .rco-request code::before,.rco .rco-request code::after,.rco .rco-outcome-head code::before,.rco .rco-outcome-head code::after{content:none}.rco-studio{display:grid;grid-template-columns:minmax(0, 1fr);gap:16px;align-items:start}.rco-studio>*{min-width:0}@container rco (min-width: 860px){.rco-studio{grid-template-columns:minmax(0, 5fr) minmax(0, 6fr);gap:20px}}.rco-panel{background:var(--rco-panel);border:1px solid var(--rco-line);border-radius:var(--rco-radius);box-shadow:var(--rco-shadow);display:flex;flex-direction:column;min-width:0}.rco-panel-head{display:flex;align-items:center;justify-content:space-between;gap:10px;padding:12px 14px;border-bottom:1px solid var(--rco-line)}.rco-panel-title{display:flex;align-items:center;gap:8px;font-size:14px;font-weight:700;white-space:nowrap}.rco-badge{display:inline-flex;align-items:center;gap:6px;padding:3px 9px;border-radius:999px;background:var(--rco-panel-2);color:var(--rco-muted);font-size:11px;font-weight:600;letter-spacing:0.04em}.rco-live{width:7px;height:7px;border-radius:50%;background:var(--rco-ok-solid);box-shadow:0 0 0 3px var(--rco-ok-soft)}.rco-btn-ghost{display:inline-flex;align-items:center;gap:6px;min-height:32px;padding:5px 11px;border-radius:10px;border:1px solid var(--rco-line);background:var(--rco-panel);color:var(--rco-ink);font-size:12.5px;font-weight:600;cursor:pointer;transition:border-color 0.15s}.rco-btn-ghost:hover{border-color:var(--rco-accent)}.rco-btn-ghost svg{width:14px;height:14px}.rco-fields{display:grid;grid-template-columns:minmax(0, 1fr);gap:18px;padding:16px 14px 18px}@container rco (min-width: 560px) and (max-width: 859px){.rco-fields{grid-template-columns:minmax(0, 1fr) minmax(0, 1fr);gap:18px 20px}.rco-field-wide{grid-column:1 / -1}}.rco-field{display:flex;flex-direction:column;gap:8px;min-width:0}.rco-label{font-size:11px;font-weight:700;letter-spacing:0.06em;text-transform:uppercase;color:var(--rco-muted)}.rco-note{font-size:12px;line-height:1.45;color:var(--rco-muted)}.rco-note code{font-size:11px;color:var(--rco-ink);background:var(--rco-panel-2);padding:1px 6px;border-radius:6px}.rco-note-box{display:flex;align-items:center;min-height:36px;padding:0 12px;border-radius:10px;border:1px dashed var(--rco-line)}.rco-chips{display:flex;flex-wrap:wrap;gap:6px}.rco-chip{display:inline-flex;align-items:center;gap:7px;min-height:36px;padding:6px 14px;border:1px solid var(--rco-line);border-radius:999px;background:var(--rco-panel);font-size:13px;font-weight:600;white-space:nowrap;cursor:pointer;transition:background-color 0.15s, border-color 0.15s, color 0.15s}.rco-chip:hover{border-color:var(--rco-accent)}.rco-chip[aria-checked=\"true\"]{background:var(--rco-accent);border-color:var(--rco-accent);color:var(--rco-accent-ink)}.rco-chip-dot{width:7px;height:7px;border-radius:50%;background:currentColor;opacity:0.35}.rco-chip[aria-checked=\"true\"] .rco-chip-dot{opacity:1}.rco-cards{display:grid;grid-template-columns:minmax(0, 1fr) minmax(0, 1fr);gap:8px}@container rco (min-width: 560px) and (max-width: 859px){.rco-cards{grid-template-columns:repeat(4, minmax(0, 1fr))}}.rco-card{display:flex;flex-direction:column;align-items:flex-start;justify-content:space-between;gap:10px;min-height:74px;padding:10px 12px;border:1px solid var(--rco-line);border-radius:12px;background:var(--rco-bg);text-align:left;cursor:pointer;transition:border-color 0.15s, box-shadow 0.15s, background-color 0.15s}.rco-card:hover{border-color:var(--rco-accent)}.rco-card[aria-checked=\"true\"]{border-color:var(--rco-accent);background:var(--rco-panel);box-shadow:0 0 0 3px var(--rco-accent-soft)}.rco-card-title{font-size:13px;font-weight:650;line-height:1.3}.rco-card-hint{font-size:11px;font-weight:600;padding:1px 7px;border-radius:6px;background:var(--rco-panel-2);color:var(--rco-muted)}.rco-card[aria-checked=\"true\"] .rco-card-hint{background:var(--rco-accent-soft);color:var(--rco-accent)}.rco-switches{display:grid;grid-template-columns:minmax(0, 1fr);gap:10px}@container rco (min-width: 560px) and (max-width: 859px){.rco-switches{grid-template-columns:minmax(0, 1fr) minmax(0, 1fr)}}.rco-switch{position:relative;display:flex;align-items:flex-start;gap:10px;padding:10px 12px;border:1px solid var(--rco-line);border-radius:12px;background:var(--rco-bg);font-size:13px;line-height:1.4;cursor:pointer}.rco-switch.is-off{opacity:0.5;cursor:default}.rco-switch input{position:absolute;opacity:0;width:1px;height:1px}.rco-track{position:relative;flex:none;width:34px;height:20px;margin-top:1px;border-radius:999px;background:var(--rco-line);transition:background-color 0.15s}.rco-track::after{content:\"\";position:absolute;top:2px;left:2px;width:16px;height:16px;border-radius:50%;background:#fff;box-shadow:0 1px 2px rgba(0, 0, 0, 0.25);transition:transform 0.15s}.rco-switch input:checked+.rco-track{background:var(--rco-accent)}.rco-switch input:checked+.rco-track::after{transform:translateX(14px)}.rco-switch input:focus-visible+.rco-track{outline:2px solid var(--rco-accent);outline-offset:2px}.rco-panel-foot{margin-top:auto;padding:12px 14px;border-top:1px solid var(--rco-line);font-size:12px;color:var(--rco-muted)}.rco-tabs{display:flex;gap:2px;padding:8px 10px 0;border-bottom:1px solid var(--rco-line)}.rco-tab{border:0;background:transparent;padding:8px 12px 10px;font-size:13px;font-weight:600;color:var(--rco-muted);cursor:pointer;border-bottom:2px solid transparent;margin-bottom:-1px;transition:color 0.15s, border-color 0.15s}.rco-tab[aria-selected=\"true\"]{color:var(--rco-accent);border-bottom-color:var(--rco-accent)}.rco-request{display:flex;align-items:center;gap:10px;margin:14px 14px 0;padding:9px 12px;border-radius:12px;background:var(--rco-bg);border:1px solid var(--rco-line);min-width:0}.rco-request code,.rco-outcome-head code{font-size:12.5px;overflow-wrap:anywhere;min-width:0}.rco-method{flex:none;padding:2px 8px;border-radius:6px;font-family:ui-monospace, SFMono-Regular, Menlo, monospace;font-size:11px;font-weight:700;letter-spacing:0.04em;background:var(--rco-ok-soft);color:var(--rco-ok)}.rco-method-post{background:var(--rco-accent-soft);color:var(--rco-accent)}.rco-stage-body{display:flex;flex-direction:column;gap:16px;padding:14px}.rco-summary{display:flex;align-items:center;justify-content:space-between;gap:12px;margin-bottom:10px}.rco-summary-count{font-size:15px;font-weight:700}.rco-meter{display:flex;gap:4px}.rco-meter i{display:block;width:22px;height:6px;border-radius:999px;background:var(--rco-wait-solid);opacity:0.85;transition:background-color 0.2s}.rco-meter i.is-done{background:var(--rco-ok-solid)}.rco-reqs{list-style:none;display:flex;flex-direction:column;gap:8px}.rco-req{display:flex;gap:12px;margin:0;padding:12px;border:1px solid var(--rco-line);border-radius:14px;background:var(--rco-panel);transition:background-color 0.2s, border-color 0.2s}.rco-req.is-done{background:var(--rco-bg)}.rco-req-icon{flex:none;display:flex;align-items:center;justify-content:center;width:30px;height:30px;border-radius:50%;background:var(--rco-wait-soft);color:var(--rco-wait)}.rco-req.is-done .rco-req-icon{background:var(--rco-ok-solid);color:#fff}.rco-req-icon svg{width:16px;height:16px}.rco-req-body{flex:1;min-width:0;display:flex;flex-direction:column;gap:5px}.rco-req-top{display:flex;align-items:center;justify-content:space-between;gap:8px}.rco-req-title{font-size:14px;font-weight:650}.rco-req-type{align-self:flex-start;font-size:11px;padding:1px 6px;border-radius:6px;background:var(--rco-panel-2);color:var(--rco-ink);overflow-wrap:anywhere}.rco-req-how{font-size:12.5px;color:var(--rco-muted)}.rco-req-meta{display:flex;align-items:center;flex-wrap:wrap;gap:6px 8px;font-size:12px;color:var(--rco-muted)}.rco-req-meta code{font-size:11.5px}.rco-tag{flex:none;display:inline-block;padding:2px 8px;border-radius:999px;font-size:10.5px;font-weight:700;letter-spacing:0.04em;text-transform:uppercase;background:var(--rco-panel-2);color:var(--rco-muted)}.rco-tag.ok{background:var(--rco-ok-soft);color:var(--rco-ok)}.rco-tag.wait{background:var(--rco-wait-soft);color:var(--rco-wait)}.rco-empty{display:flex;gap:12px;padding:14px;border:1px dashed var(--rco-line);border-radius:14px;color:var(--rco-muted);font-size:13px}.rco-empty strong{display:block;color:var(--rco-ink);font-size:14px;margin-bottom:2px}.rco-empty-icon{flex:none;display:flex;align-items:center;justify-content:center;width:30px;height:30px;border-radius:50%;background:var(--rco-ok-solid);color:#fff}.rco-empty-icon svg{width:16px;height:16px}.rco-outcome{display:flex;flex-direction:column;gap:10px;padding:14px;border-radius:14px;background:linear-gradient(135deg, var(--rco-accent-soft), transparent 70%), var(--rco-bg);border:1px solid var(--rco-line)}.rco-outcome-head{display:flex;align-items:center;flex-wrap:wrap;gap:8px}.rco-arrow{color:var(--rco-muted)}.rco-outcome-text{font-size:13px;color:var(--rco-ink)}.rco-track-steps{list-style:none;display:grid;grid-template-columns:repeat(3, minmax(0, 1fr));gap:8px;margin-top:2px}.rco-step{position:relative;display:flex;flex-direction:column;gap:6px;margin:0;font-size:11.5px;color:var(--rco-muted)}.rco-step::before{content:\"\";position:absolute;top:4px;left:14px;right:-4px;height:2px;border-radius:2px;background:var(--rco-line)}.rco-step:last-child::before{display:none}.rco-step.is-done::before,.rco-step.is-skipped::before{background:var(--rco-accent)}.rco-step-dot{position:relative;width:10px;height:10px;border-radius:50%;background:var(--rco-panel);border:2px solid var(--rco-line)}.rco-step.is-done .rco-step-dot,.rco-step.is-skipped .rco-step-dot{background:var(--rco-accent);border-color:var(--rco-accent)}.rco-step.is-now .rco-step-dot{border-color:var(--rco-accent);box-shadow:0 0 0 4px var(--rco-accent-soft)}.rco-step.is-now .rco-step-label{color:var(--rco-ink);font-weight:650}.rco-step.is-skipped .rco-step-label{font-style:italic}.rco-code{margin:14px;border-radius:14px;background:var(--rco-code-bg);color:var(--rco-code-ink);overflow:hidden;min-width:0}.rco-code-bar{display:flex;align-items:center;gap:10px;padding:9px 14px;border-bottom:1px solid rgba(255, 255, 255, 0.08);font-size:11.5px;color:var(--rco-code-muted)}.rco-code-status{color:#4ade80;font-weight:700}.rco .rco-code pre{display:block!important;margin:0;padding:14px;max-height:520px;overflow:auto;background:transparent;font-family:ui-monospace, SFMono-Regular, Menlo, monospace;font-size:12px;line-height:1.6;white-space:pre}.rco .rco-code pre span{display:inline!important}.rco-tk-key{color:#82aaff}.rco-tk-str{color:#c3e88d}.rco-tk-num{color:#f78c6c}.rco-tk-lit{color:#c792ea}@media (prefers-reduced-motion: reduce){.rco *{transition:none!important}}"}],"page":{"pagePath":"api-reference/3d-secure/create-a-3d-secure-session-linked-to-a-merchant","slug":"/api-reference/3d-secure/create-a-3d-secure-session-linked-to-a-merchant","pageMetadata":{"title":"Create a 3D Secure session linked to a merchant","description":"Creates a standalone 3D Secure (3DS) authentication session for a card payment.\nRequires the merchant.3ds.create permission.\n\n**Flow:**\n1. Create a 3DS session with encrypted card data, or with `card.card_id` to\n authenticate a card stored via `POST /v1/cards`\n2. If `auth_status` is `ACTION_REQUIRED`, the cardholder must complete the 3DS challenge\n using the `tds_session_id` with the client-side SDK\n3. If `auth_status` is `AUTHENTICATED`, the session is ready to be used in a transaction\n4. Pass the session `id` as `three_d_secure_session_id` when creating a card transaction\n\n**Expiration:** Sessions expire 1 hour after creation.\n\n**Single use:** A session authenticates one amount and currency and can be spent on\none transaction. Recurring charges need a new session each time — a stored card does\nnot change this.\n\n**Supported card networks:** Visa, Mastercard, and American Express. Cards from\nother networks (e.g. Elo, Hipercard, Discover, Diners, JCB) cannot be authenticated\nand are rejected with `400 VALIDATION_ERROR`.\n","deprecated":null,"version":null,"openapi":"/api-spec.yaml post /v1/merchants/{merchantId}/3ds-sessions","href":"/api-reference/3d-secure/create-a-3d-secure-session-linked-to-a-merchant","autogeneratedByOpenApi":true},"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 code: \"code\",\n li: \"li\",\n ol: \"ol\",\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Creates a standalone 3D Secure (3DS) authentication session for a card payment.\\nRequires the merchant.3ds.create permission.\"\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Flow:\"\n })\n }), \"\\n\", _jsxs(_components.ol, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [\"Create a 3DS session with encrypted card data, or with \", _jsx(_components.code, {\n children: \"card.card_id\"\n }), \" to\\nauthenticate a card stored via \", _jsx(_components.code, {\n children: \"POST /v1/cards\"\n })]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"If \", _jsx(_components.code, {\n children: \"auth_status\"\n }), \" is \", _jsx(_components.code, {\n children: \"ACTION_REQUIRED\"\n }), \", the cardholder must complete the 3DS challenge\\nusing the \", _jsx(_components.code, {\n children: \"tds_session_id\"\n }), \" with the client-side SDK\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"If \", _jsx(_components.code, {\n children: \"auth_status\"\n }), \" is \", _jsx(_components.code, {\n children: \"AUTHENTICATED\"\n }), \", the session is ready to be used in a transaction\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"Pass the session \", _jsx(_components.code, {\n children: \"id\"\n }), \" as \", _jsx(_components.code, {\n children: \"three_d_secure_session_id\"\n }), \" when creating a card transaction\"]\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Expiration:\"\n }), \" Sessions expire 1 hour after creation.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Single use:\"\n }), \" A session authenticates one amount and currency and can be spent on\\none transaction. Recurring charges need a new session each time — a stored card does\\nnot change this.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Supported card networks:\"\n }), \" Visa, Mastercard, and American Express. Cards from\\nother networks (e.g. Elo, Hipercard, Discover, Diners, JCB) cannot be authenticated\\nand are rejected with \", _jsx(_components.code, {\n children: \"400 VALIDATION_ERROR\"\n }), \".\"]\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":"Create a 3D Secure session linked to a merchant","description":"Creates a standalone 3D Secure (3DS) authentication session for a card payment.\nRequires the merchant.3ds.create permission.\n\n**Flow:**\n1. Create a 3DS session with encrypted card data, or with `card.card_id` to\n authenticate a card stored via `POST /v1/cards`\n2. If `auth_status` is `ACTION_REQUIRED`, the cardholder must complete the 3DS challenge\n using the `tds_session_id` with the client-side SDK\n3. If `auth_status` is `AUTHENTICATED`, the session is ready to be used in a transaction\n4. Pass the session `id` as `three_d_secure_session_id` when creating a card transaction\n\n**Expiration:** Sessions expire 1 hour after creation.\n\n**Single use:** A session authenticates one amount and currency and can be spent on\none transaction. Recurring charges need a new session each time — a stored card does\nnot change this.\n\n**Supported card networks:** Visa, Mastercard, and American Express. Cards from\nother networks (e.g. Elo, Hipercard, Discover, Diners, JCB) cannot be authenticated\nand are rejected with `400 VALIDATION_ERROR`.\n","deprecated":null,"version":null,"openapi":"/api-spec.yaml post /v1/merchants/{merchantId}/3ds-sessions","href":"/api-reference/3d-secure/create-a-3d-secure-session-linked-to-a-merchant","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"servers":["5b956852-368d-4e2e-a365-90e79a969f2a","7f8bb82b-f244-4d14-b40f-60eccfcdd93f","6cf43220-833f-44f7-aa25-bf82a3a7ea36","4e069e5c-b50e-484e-81ec-59bbe7126239"],"summary":"Create a 3D Secure session linked to a merchant","description":"Creates a standalone 3D Secure (3DS) authentication session for a card payment.\nRequires the merchant.3ds.create permission.\n\n**Flow:**\n1. Create a 3DS session with encrypted card data, or with `card.card_id` to\n authenticate a card stored via `POST /v1/cards`\n2. If `auth_status` is `ACTION_REQUIRED`, the cardholder must complete the 3DS challenge\n using the `tds_session_id` with the client-side SDK\n3. If `auth_status` is `AUTHENTICATED`, the session is ready to be used in a transaction\n4. Pass the session `id` as `three_d_secure_session_id` when creating a card transaction\n\n**Expiration:** Sessions expire 1 hour after creation.\n\n**Single use:** A session authenticates one amount and currency and can be spent on\none transaction. Recurring charges need a new session each time — a stored card does\nnot change this.\n\n**Supported card networks:** Visa, Mastercard, and American Express. Cards from\nother networks (e.g. Elo, Hipercard, Discover, Diners, JCB) cannot be authenticated\nand are rejected with `400 VALIDATION_ERROR`.\n","tags":["3D Secure"],"security":["32dd619f-389d-4d8d-acaa-86540a7e0e45"],"parameters":["60e3935d-d49b-484b-8f93-7fbd4568dcff"],"requestBody":"e3d0a08a-0f57-4bf5-8428-7a68dd2d61e1","responses":{"201":"8f75aa49-60dd-4a13-be76-e554dd6eee17","400":"d0d1262b-27f8-49c1-95dd-026dc6ff0cdf","401":"7f5eef98-a27b-4396-927a-04dc430b5088","403":"a054a213-a1c6-4b8f-8a85-a74cc180f1db","404":"503e7e35-15c1-4629-8d55-b143612c623e","502":"3d762f68-79a2-4edf-9ddd-bee7dcddf165"},"method":"post","type":"path","path":"/v1/merchants/{merchantId}/3ds-sessions","baseUrlOptions":["https://api-sandbox.rinne.com.br/core","https://pci.api-sandbox.rinne.com.br/core","https://api.rinne.com.br/core","https://pci.api.rinne.com.br/core"],"title":"Create a 3D Secure session linked to a merchant","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"60e3935d-d49b-484b-8f93-7fbd4568dcff":{"name":"merchantId","in":"path","required":true,"description":"Merchant/Company ID","schema":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","isRequired":true,"description":"Merchant/Company ID","uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["amount","currency","card"],"properties":{"amount":{"type":"integer","minimum":1,"description":"Transaction amount in minor units (cents)","example":10000,"isRequired":true,"uniqueKey":"amount","typeLabel":"integer"},"currency":{"type":"string","minLength":3,"maxLength":3,"description":"ISO 4217 currency code","example":"BRL","isRequired":true,"uniqueKey":"currency","typeLabel":"string"},"card":{"oneOf":[{"type":"object","description":"Card to authenticate. Provide **either** `card_id` (a card\nstored via `POST /v1/cards`) **or** the inline pair\n`number` + `expiry` — never both.\n","required":["card_id"],"properties":{"card_id":{"type":"string","format":"uuid","description":"Reference to a previously stored card (see\n`POST /v1/cards`). The stored card number, expiry and\ncardholder name are used automatically; do not send\n`number`, `expiry` or `payer_name` alongside it.\n\nA request carrying only `card_id` contains no card\nnumber, so it does not need the PCI API host.\n\nThe card must belong to the same company the session\nis created for: a card stored by an organization for\nitself is not reachable from\n`/v1/merchants/{merchantId}/3ds-sessions`. Store the\ncard at the level you will authenticate it at.\n","example":"123e4567-e89b-12d3-a456-426614174000","isRequired":true,"uniqueKey":"card.oneOf.0.card_id","typeLabel":"string\u003cuuid>"},"number":{"type":"string","pattern":"^ev:","description":"Encrypted card number (`ev:` prefix); plaintext\nvalues are rejected with `400 VALIDATION_ERROR`.\nSend raw card data via the PCI API host, which\nencrypts it in transit, or encrypt client-side\nwith rinne-js (see *Raw Card Data*).\n","example":"ev:encrypted:...","uniqueKey":"card.oneOf.0.number","typeLabel":"string"},"expiry":{"type":"object","required":["month","year"],"properties":{"month":{"type":"string","pattern":"^(0[1-9]|1[0-2])$","description":"Card expiry month (MM format, 01-12)","example":"12","isRequired":true,"uniqueKey":"card.oneOf.0.expiry.month","typeLabel":"string"},"year":{"type":"string","pattern":"^\\d{4}$","description":"Card expiry year (YYYY format required)","example":"2027","isRequired":true,"uniqueKey":"card.oneOf.0.expiry.year","typeLabel":"string"}},"uniqueKey":"card.oneOf.0.expiry","typeLabel":"object"}},"isRequired":true,"uniqueKey":"card.oneOf.0","typeLabel":"object"},{"type":"object","description":"Card to authenticate. Provide **either** `card_id` (a card\nstored via `POST /v1/cards`) **or** the inline pair\n`number` + `expiry` — never both.\n","required":["number","expiry"],"properties":{"number":{"type":"string","pattern":"^ev:","description":"Encrypted card number (`ev:` prefix); plaintext\nvalues are rejected with `400 VALIDATION_ERROR`.\nSend raw card data via the PCI API host, which\nencrypts it in transit, or encrypt client-side\nwith rinne-js (see *Raw Card Data*).\n","example":"ev:encrypted:...","isRequired":true,"uniqueKey":"card.oneOf.1.number","typeLabel":"string"},"expiry":{"type":"object","required":["month","year"],"properties":{"month":{"type":"string","pattern":"^(0[1-9]|1[0-2])$","description":"Card expiry month (MM format, 01-12)","example":"12","isRequired":true,"uniqueKey":"card.oneOf.1.expiry.month","typeLabel":"string"},"year":{"type":"string","pattern":"^\\d{4}$","description":"Card expiry year (YYYY format required)","example":"2027","isRequired":true,"uniqueKey":"card.oneOf.1.expiry.year","typeLabel":"string"}},"isRequired":true,"uniqueKey":"card.oneOf.1.expiry","typeLabel":"object"},"card_id":{"type":"string","format":"uuid","description":"Reference to a previously stored card (see\n`POST /v1/cards`). The stored card number, expiry and\ncardholder name are used automatically; do not send\n`number`, `expiry` or `payer_name` alongside it.\n\nA request carrying only `card_id` contains no card\nnumber, so it does not need the PCI API host.\n\nThe card must belong to the same company the session\nis created for: a card stored by an organization for\nitself is not reachable from\n`/v1/merchants/{merchantId}/3ds-sessions`. Store the\ncard at the level you will authenticate it at.\n","example":"123e4567-e89b-12d3-a456-426614174000","uniqueKey":"card.oneOf.1.card_id","typeLabel":"string\u003cuuid>"}},"isRequired":true,"uniqueKey":"card.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"card","typeLabel":"object"},"merchant":{"type":"object","description":"Optional merchant overrides. Only `website` can be overridden.\nAll other merchant fields (name, category_code, country) are\nalways derived from the Company entity. The merchant name shown\nto the cardholder during a challenge is the company's legal name\n(`full_name`), shortened to the 40 characters the 3DS\nspecification allows.\n","properties":{"website":{"type":"string","format":"uri","maxLength":2048,"description":"3DS Requestor URL / customer-care website that might be shown to\ncardholders during technical errors in the 3DS authentication flow.\nThis is NOT the page initiating the session.\nMust be an `http` or `https` URL on a public domain name, at most 2048 characters: no IP\naddress, `localhost`, single-label or internal host (`.local`, `.internal`, `.svc`, `.lan`, ...),\nno credentials and no port other than the scheme's default (443 for `https`, 80 for `http`).\nIf omitted, falls back to the merchant's `website_url`,\nthen the parent organization's `website_url`.\n","example":"https://support.mystore.com","uniqueKey":"merchant.website","typeLabel":"string\u003curi>"}},"uniqueKey":"merchant","typeLabel":"object"},"payer_email":{"type":"string","format":"email","description":"Cardholder email for richer 3DS authentication","example":"[email protected]","uniqueKey":"payer_email","typeLabel":"string\u003cemail>"},"payer_name":{"type":"string","description":"Cardholder name. Accented and non-Latin characters are accepted; accents are folded for authentication (e.g. \"João\" is authenticated as \"Joao\"), while the name is stored exactly as sent. Names that cannot be folded to unaccented Latin letters may be rejected by the authentication provider. Names containing invalid characters are rejected. Not allowed together with `card.card_id`: a stored card supplies its own `cardholder_name`, so set it when storing the card. The other payer fields (`payer_email`, `payer_document`, `billing_address`) are still accepted with a stored card.\n","example":"João da Silva","uniqueKey":"payer_name","typeLabel":"string"},"payer_document":{"type":"string","description":"Cardholder document (CPF, etc.)","example":"123.456.789-00","uniqueKey":"payer_document","typeLabel":"string"},"billing_address":{"type":"object","required":["line","city","postal_code","country"],"properties":{"line":{"type":"string","description":"Street address line","example":"123 Main St","isRequired":true,"uniqueKey":"billing_address.line","typeLabel":"string"},"city":{"type":"string","example":"Sao Paulo","isRequired":true,"uniqueKey":"billing_address.city","typeLabel":"string"},"postal_code":{"type":"string","example":"01001-000","isRequired":true,"uniqueKey":"billing_address.postal_code","typeLabel":"string"},"country":{"type":"string","pattern":"^([A-Za-z]{2}|[0-9]{1,3})$","description":"ISO 3166-1 country code, either alpha-2 (`BR`) or numeric (`076`). Uppercased on the way in, with numeric codes zero-padded to three digits. Alpha-3 (`BRA`) is not accepted.","example":"BR","isRequired":true,"uniqueKey":"billing_address.country","typeLabel":"string"},"state":{"type":"string","example":"SP","uniqueKey":"billing_address.state","typeLabel":"string"}},"uniqueKey":"billing_address","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"amount":10000,"currency":"BRL","card":{"card_id":"123e4567-e89b-12d3-a456-426614174000","number":"ev:encrypted:..."},"merchant":{"website":"https://support.mystore.com"},"payer_email":"[email protected]","payer_name":"João da Silva","payer_document":"123.456.789-00"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"8f75aa49-60dd-4a13-be76-e554dd6eee17":{"description":"3DS session created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Internal 3DS session ID (use as three_d_secure_session_id when creating a transaction)","example":"550e8400-e29b-41d4-a716-446655440000","isRequired":true,"uniqueKey":"id","typeLabel":"string\u003cuuid>"},"tds_session_id":{"type":"string","description":"Provider session ID (use with the client-side SDK for challenge flows)","example":"tds_visa_e7c2yfa3867c","isRequired":true,"uniqueKey":"tds_session_id","typeLabel":"string"},"card_id":{"oneOf":[{"type":"string","format":"uuid","description":"The stored card this session authenticated, or `null` when the card was\nsent inline. When both this and the transaction's `card_data.card_id` are\nset, they must match or the transaction is rejected.\n","example":"123e4567-e89b-12d3-a456-426614174000","isRequired":true,"uniqueKey":"card_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"The stored card this session authenticated, or `null` when the card was\nsent inline. When both this and the transaction's `card_data.card_id` are\nset, they must match or the transaction is rejected.\n","example":"123e4567-e89b-12d3-a456-426614174000","isRequired":true,"uniqueKey":"card_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"card_id","typeLabel":"string\u003cuuid> | null"},"auth_status":{"type":"string","enum":["ACTION_REQUIRED","AUTHENTICATED","FAILED"],"description":"Current authentication status:\n- `ACTION_REQUIRED`: Cardholder must complete 3DS challenge\n- `AUTHENTICATED`: Authentication successful (frictionless or completed challenge),\n or only attempted: with `authentication_flow: attempt` the cardholder was not\n authenticated and only proof of the attempt exists\n- `FAILED`: Authentication failed\n","example":"AUTHENTICATED","isRequired":true,"uniqueKey":"auth_status","typeLabel":"enum\u003cstring>"},"consumption_status":{"type":"string","enum":["NOT_CONSUMED","PROCESSING","CONSUMED"],"description":"Whether this session has been used for a transaction:\n- `NOT_CONSUMED`: Available for use\n- `PROCESSING`: Currently being used (atomic claim)\n- `CONSUMED`: Already used for a transaction\n","example":"NOT_CONSUMED","isRequired":true,"uniqueKey":"consumption_status","typeLabel":"enum\u003cstring>"},"amount":{"type":"integer","description":"Amount in minor units (cents)","example":10000,"isRequired":true,"uniqueKey":"amount","typeLabel":"integer"},"currency":{"type":"string","description":"ISO 4217 currency code","example":"BRL","isRequired":true,"uniqueKey":"currency","typeLabel":"string"},"failure_reason":{"oneOf":[{"type":"string","description":"Reason for authentication failure (only present when auth_status is FAILED)","example":null,"isRequired":true,"uniqueKey":"failure_reason.oneOf.0","typeLabel":"string"},{"type":"null","description":"Reason for authentication failure (only present when auth_status is FAILED)","example":null,"isRequired":true,"uniqueKey":"failure_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"failure_reason","typeLabel":"string | null"},"liability_shift":{"oneOf":[{"type":"boolean","description":"Whether liability has shifted to the issuer","example":true,"isRequired":true,"uniqueKey":"liability_shift.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether liability has shifted to the issuer","example":true,"isRequired":true,"uniqueKey":"liability_shift.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"liability_shift","typeLabel":"boolean | null"},"authentication_flow":{"oneOf":[{"type":"string","description":"3DS authentication flow type (frictionless, challenge, attempt). `attempt`\ncomes with `auth_status: AUTHENTICATED`, but the cardholder was not\nauthenticated: only proof of the authentication attempt exists.\n","example":"frictionless","isRequired":true,"uniqueKey":"authentication_flow.oneOf.0","typeLabel":"string"},{"type":"null","description":"3DS authentication flow type (frictionless, challenge, attempt). `attempt`\ncomes with `auth_status: AUTHENTICATED`, but the cardholder was not\nauthenticated: only proof of the authentication attempt exists.\n","example":"frictionless","isRequired":true,"uniqueKey":"authentication_flow.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"authentication_flow","typeLabel":"string | null"},"acs_transaction_id":{"oneOf":[{"type":"string","description":"Transaction ID the issuer's Access Control Server (ACS) assigned to the\nauthentication. Recorded with the outcome: `null` while `auth_status` is\n`ACTION_REQUIRED`, and when it was not reported.\n","example":"b0bb6068-8d68-40a1-9606-20fa01ba74de","isRequired":true,"uniqueKey":"acs_transaction_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Transaction ID the issuer's Access Control Server (ACS) assigned to the\nauthentication. Recorded with the outcome: `null` while `auth_status` is\n`ACTION_REQUIRED`, and when it was not reported.\n","example":"b0bb6068-8d68-40a1-9606-20fa01ba74de","isRequired":true,"uniqueKey":"acs_transaction_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"acs_transaction_id","typeLabel":"string | null"},"ds_transaction_id":{"oneOf":[{"type":"string","description":"Transaction ID the card network's Directory Server (DS) assigned to the\nauthentication, which the network uses to find it, for example in a\nchargeback dispute. Recorded with the outcome: `null` while `auth_status`\nis `ACTION_REQUIRED`, and when it was not reported.\n","example":"cfb8d11b-8129-414e-983a-3e95f0f4f6c6","isRequired":true,"uniqueKey":"ds_transaction_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Transaction ID the card network's Directory Server (DS) assigned to the\nauthentication, which the network uses to find it, for example in a\nchargeback dispute. Recorded with the outcome: `null` while `auth_status`\nis `ACTION_REQUIRED`, and when it was not reported.\n","example":"cfb8d11b-8129-414e-983a-3e95f0f4f6c6","isRequired":true,"uniqueKey":"ds_transaction_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"ds_transaction_id","typeLabel":"string | null"},"server_transaction_id":{"oneOf":[{"type":"string","description":"Transaction ID the 3DS Server assigned to the authentication. Recorded\nwith the outcome: `null` while `auth_status` is `ACTION_REQUIRED`, and when\nit was not reported.\n","example":"dc46fbb1-a898-4760-b8a2-56dae36cb0e2","isRequired":true,"uniqueKey":"server_transaction_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Transaction ID the 3DS Server assigned to the authentication. Recorded\nwith the outcome: `null` while `auth_status` is `ACTION_REQUIRED`, and when\nit was not reported.\n","example":"dc46fbb1-a898-4760-b8a2-56dae36cb0e2","isRequired":true,"uniqueKey":"server_transaction_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"server_transaction_id","typeLabel":"string | null"},"protocol_version":{"oneOf":[{"type":"string","description":"EMV 3-D Secure protocol version of the authentication. Recorded with the\noutcome: `null` while `auth_status` is `ACTION_REQUIRED`, and when it was\nnot reported.\n","example":"2.2.0","isRequired":true,"uniqueKey":"protocol_version.oneOf.0","typeLabel":"string"},{"type":"null","description":"EMV 3-D Secure protocol version of the authentication. Recorded with the\noutcome: `null` while `auth_status` is `ACTION_REQUIRED`, and when it was\nnot reported.\n","example":"2.2.0","isRequired":true,"uniqueKey":"protocol_version.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"protocol_version","typeLabel":"string | null"},"expires_at":{"type":"string","format":"date-time","description":"Session expiration time","example":"2026-02-06T20:35:00.000Z","isRequired":true,"uniqueKey":"expires_at","typeLabel":"string\u003cdate-time>"},"created_at":{"type":"string","format":"date-time","example":"2026-02-06T19:35:00.000Z","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","example":"2026-02-06T19:35:00.000Z","isRequired":true,"uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"}},"required":["id","tds_session_id","card_id","auth_status","consumption_status","amount","currency","failure_reason","liability_shift","authentication_flow","acs_transaction_id","ds_transaction_id","server_transaction_id","protocol_version","expires_at","created_at","updated_at"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"550e8400-e29b-41d4-a716-446655440000","tds_session_id":"tds_visa_e7c2yfa3867c","card_id":"123e4567-e89b-12d3-a456-426614174000","auth_status":"AUTHENTICATED","consumption_status":"NOT_CONSUMED","amount":10000,"currency":"BRL","failure_reason":null,"liability_shift":true,"authentication_flow":"frictionless","acs_transaction_id":"b0bb6068-8d68-40a1-9606-20fa01ba74de","ds_transaction_id":"cfb8d11b-8129-414e-983a-3e95f0f4f6c6","server_transaction_id":"dc46fbb1-a898-4760-b8a2-56dae36cb0e2","protocol_version":"2.2.0","expires_at":"2026-02-06T20:35:00.000Z","created_at":"2026-02-06T19:35:00.000Z","updated_at":"2026-02-06T19:35:00.000Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"d0d1262b-27f8-49c1-95dd-026dc6ff0cdf":{"description":"Validation error — invalid card data, missing/invalid fields, or an unsupported card network (only Visa, Mastercard, and American Express are supported for 3DS).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","example":"VALIDATION_ERROR","uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"Validation error","uniqueKey":"error.message","typeLabel":"string"},"status":{"type":"integer","example":400,"uniqueKey":"error.status","typeLabel":"integer"},"details":{"type":"object","properties":{"issues":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","example":"email","uniqueKey":"error.details.issues.items.[INDEX].field","typeLabel":"string"},"type":{"type":"string","example":"REQUIRED","uniqueKey":"error.details.issues.items.[INDEX].type","typeLabel":"string"},"message":{"type":"string","example":"Field 'email' is required","uniqueKey":"error.details.issues.items.[INDEX].message","typeLabel":"string"},"value":{"oneOf":[{"type":"string","example":"invalid_value","uniqueKey":"error.details.issues.items.[INDEX].value.oneOf.0","typeLabel":"string"},{"type":"number","example":"invalid_value","uniqueKey":"error.details.issues.items.[INDEX].value.oneOf.1","typeLabel":"number"},{"type":"boolean","example":"invalid_value","uniqueKey":"error.details.issues.items.[INDEX].value.oneOf.2","typeLabel":"boolean"}],"uniqueKey":"error.details.issues.items.[INDEX].value","typeLabel":"string | number | boolean"},"constraints":{"type":"object","example":{"min":18,"max":120},"uniqueKey":"error.details.issues.items.[INDEX].constraints","typeLabel":"object"}},"uniqueKey":"error.details.issues.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details.issues","typeLabel":"object[]"}},"uniqueKey":"error.details","typeLabel":"object"},"path":{"type":"string","example":"/companies","uniqueKey":"error.path","typeLabel":"string"},"timestamp":{"type":"string","format":"date-time","example":"2023-12-01T10:00:00.000Z","uniqueKey":"error.timestamp","typeLabel":"string\u003cdate-time>"},"requestId":{"type":"string","example":"req_123456789","uniqueKey":"error.requestId","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"VALIDATION_ERROR","message":"Validation error","status":400,"details":{"issues":[{"field":"email","type":"REQUIRED","message":"Field 'email' is required","value":"invalid_value","constraints":{"min":18,"max":120}}]},"path":"/companies","timestamp":"2023-12-01T10:00:00.000Z","requestId":"req_123456789"}}}},"exampleType":"generated"}},"exampleType":"generated"},"7f5eef98-a27b-4396-927a-04dc430b5088":{"description":"Unauthorized - Invalid or missing API key","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","example":"AUTHENTICATION_ERROR","uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"Authentication required to access this resource","uniqueKey":"error.message","typeLabel":"string"},"status":{"type":"integer","example":401,"uniqueKey":"error.status","typeLabel":"integer"},"details":{"type":"object","properties":{"reason":{"type":"string","example":"Invalid API key","uniqueKey":"error.details.reason","typeLabel":"string"}},"uniqueKey":"error.details","typeLabel":"object"},"path":{"type":"string","example":"/companies/me","uniqueKey":"error.path","typeLabel":"string"},"timestamp":{"type":"string","format":"date-time","example":"2023-12-01T10:00:00.000Z","uniqueKey":"error.timestamp","typeLabel":"string\u003cdate-time>"},"requestId":{"type":"string","example":"req_123456789","uniqueKey":"error.requestId","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"AUTHENTICATION_ERROR","message":"Authentication required to access this resource","status":401,"details":{"reason":"Invalid API key"},"path":"/companies/me","timestamp":"2023-12-01T10:00:00.000Z","requestId":"req_123456789"}}}},"exampleType":"generated"}},"exampleType":"generated"},"a054a213-a1c6-4b8f-8a85-a74cc180f1db":{"description":"Insufficient permissions to access this resource","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","example":"AUTHORIZATION_ERROR","uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"You need 'admin' permissions to access this resource","uniqueKey":"error.message","typeLabel":"string"},"status":{"type":"integer","example":403,"uniqueKey":"error.status","typeLabel":"integer"},"path":{"type":"string","example":"/companies","uniqueKey":"error.path","typeLabel":"string"},"timestamp":{"type":"string","format":"date-time","example":"2023-12-01T10:00:00.000Z","uniqueKey":"error.timestamp","typeLabel":"string\u003cdate-time>"},"requestId":{"type":"string","example":"req_123456789","uniqueKey":"error.requestId","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"AUTHORIZATION_ERROR","message":"You need 'admin' permissions to access this resource","status":403,"path":"/companies","timestamp":"2023-12-01T10:00:00.000Z","requestId":"req_123456789"}}}},"exampleType":"generated"}},"exampleType":"generated"},"503e7e35-15c1-4629-8d55-b143612c623e":{"description":"Merchant not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","example":"RESOURCE_NOT_FOUND","uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"Company with ID '123' not found","uniqueKey":"error.message","typeLabel":"string"},"status":{"type":"integer","example":404,"uniqueKey":"error.status","typeLabel":"integer"},"path":{"type":"string","example":"/companies/me","uniqueKey":"error.path","typeLabel":"string"},"timestamp":{"type":"string","format":"date-time","example":"2023-12-01T10:00:00.000Z","uniqueKey":"error.timestamp","typeLabel":"string\u003cdate-time>"},"requestId":{"type":"string","example":"req_123456789","uniqueKey":"error.requestId","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"RESOURCE_NOT_FOUND","message":"Company with ID '123' not found","status":404,"path":"/companies/me","timestamp":"2023-12-01T10:00:00.000Z","requestId":"req_123456789"}}}},"exampleType":"generated"}},"exampleType":"generated"},"3d762f68-79a2-4edf-9ddd-bee7dcddf165":{"description":"3DS provider error (provider unreachable, unexpected response, etc.)","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","example":"INTEGRATION_ERROR","uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"Integration error with provider CELCOIN","uniqueKey":"error.message","typeLabel":"string"},"status":{"type":"integer","example":502,"uniqueKey":"error.status","typeLabel":"integer"},"path":{"type":"string","example":"/merchants/{merchantId}/balance","uniqueKey":"error.path","typeLabel":"string"},"timestamp":{"type":"string","format":"date-time","uniqueKey":"error.timestamp","typeLabel":"string\u003cdate-time>"},"requestId":{"type":"string","uniqueKey":"error.requestId","typeLabel":"string"},"details":{"type":"object","additionalProperties":true,"uniqueKey":"error.details","typeLabel":"object"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"INTEGRATION_ERROR","message":"Integration error with provider CELCOIN","status":502,"path":"/merchants/{merchantId}/balance","timestamp":"2023-11-07T05:31:56Z","requestId":"\u003cstring>","details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"32dd619f-389d-4d8d-acaa-86540a7e0e45":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","description":"Company API key for authentication","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"5b956852-368d-4e2e-a365-90e79a969f2a":{"url":"https://api-sandbox.rinne.com.br/core","description":"Sandbox"},"7f8bb82b-f244-4d14-b40f-60eccfcdd93f":{"url":"https://pci.api-sandbox.rinne.com.br/core","description":"Sandbox (PCI — encrypts raw card number/cvv in transit)"},"6cf43220-833f-44f7-aa25-bf82a3a7ea36":{"url":"https://api.rinne.com.br/core","description":"Production"},"4e069e5c-b50e-484e-81ec-59bbe7126239":{"url":"https://pci.api.rinne.com.br/core","description":"Production (PCI — encrypts raw card number/cvv in transit)"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","description":"Company API key for authentication","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"x-api-key","type":"string","description":"Company API key for authentication","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"x-api-key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"api-spec.yaml"},"subdomain":"rinne","siteName":"Rinne API","title":"Rinne API Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-13T15:27:36.419Z","originalFileLocation":"api-reference/3d-secure/create-a-3d-secure-session-linked-to-a-merchant.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=\"Creates a standalone 3D Secure (3DS) authentication session for a card payment. Requires the merchant.3ds.create permission. Flow: 1. Create a 3DS session with encrypted card data, or with card.card_id to authenticate a card stored via POST /v1/cards 2. If auth_status is ACTION_REQUIRED, the cardholder must complete the 3DS challenge using the tds_session_id with the client-side SDK 3. If auth_status is AUTHENTICATED, the session is ready to be used in a transaction 4. Pass the session id as three_d_secure_session_id when creating a card transaction Expiration: Sessions expire 1 hour after creation. Single use: A session authenticates one amount and currency and can be spent on one transaction. Recurring charges need a new session each time — a stored card does not change this. Supported card networks: Visa, Mastercard, and American Express. Cards from other networks (e.g. Elo, Hipercard, Discover, Diners, JCB) cannot be authenticated and are rejected with 400 VALIDATION_ERROR.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Rinne API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/rinne/MXvyIJiliJyAMNh5/_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/rinne/MXvyIJiliJyAMNh5/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/rinne/MXvyIJiliJyAMNh5/_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/rinne/MXvyIJiliJyAMNh5/_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/rinne/MXvyIJiliJyAMNh5/_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/rinne/MXvyIJiliJyAMNh5/_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/rinne/MXvyIJiliJyAMNh5/_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/rinne/MXvyIJiliJyAMNh5/_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/rinne/MXvyIJiliJyAMNh5/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Rinne API Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Complete payment infrastructure platform for managing merchants, processing transactions, and handling banking operations through a unified API.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Rinne API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.rinne.com.br/api-reference/3d-secure/create-a-3d-secure-session-linked-to-a-merchant\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://rinne.mintlify.site/_mintlify/api/og/v2?division=Transactions\u0026amp;title=Create+a+3D+Secure+session+linked+to+a+merchant\u0026amp;description=Creates+a+standalone+3D+Secure+%283DS%29+authentication+session+for+a+card+payment.%0ARequires+the+merchant.3ds.create+permission.%0A%0A**Flow%3A**%0A1.+Create+a+3DS+session+\u0026amp;theme=77f535d0b19c2686d36339db\u0026amp;signature=269b797c48353a1fd93129586bf21be7e9b136fdecd8e3cf742295cbf9ff438f\">\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=\"Rinne API Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Complete payment infrastructure platform for managing merchants, processing transactions, and handling banking operations through a unified API.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://rinne.mintlify.site/_mintlify/api/og/v2?division=Transactions\u0026amp;title=Create+a+3D+Secure+session+linked+to+a+merchant\u0026amp;description=Creates+a+standalone+3D+Secure+%283DS%29+authentication+session+for+a+card+payment.%0ARequires+the+merchant.3ds.create+permission.%0A%0A**Flow%3A**%0A1.+Create+a+3DS+session+\u0026amp;theme=77f535d0b19c2686d36339db\u0026amp;signature=269b797c48353a1fd93129586bf21be7e9b136fdecd8e3cf742295cbf9ff438f\">\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/rinne/MXvyIJiliJyAMNh5/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Rinne API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#5B68EB\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.rinne.com.br/api-reference/3d-secure/create-a-3d-secure-session-linked-to-a-merchant\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/3d-secure/create-a-3d-secure-session-linked-to-a-merchant.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.rinne.com.br/#organization\",\"name\":\"Rinne API\",\"url\":\"https://docs.rinne.com.br\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/rinne/HqyHJ9XOsH5pEihc/logo/light.png?fit=max\u0026auto=format\u0026n=HqyHJ9XOsH5pEihc\u0026q=85\u0026s=be4ff200f82e7246a248176e8984208e\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.rinne.com.br#website\",\"name\":\"Rinne API\",\"url\":\"https://docs.rinne.com.br\",\"publisher\":{\"@id\":\"https://docs.rinne.com.br/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.rinne.com.br/api-reference/3d-secure/create-a-3d-secure-session-linked-to-a-merchant#webpage\",\"url\":\"https://docs.rinne.com.br/api-reference/3d-secure/create-a-3d-secure-session-linked-to-a-merchant\",\"name\":\"Create a 3D Secure session linked to a merchant\",\"description\":\"Creates a standalone 3D Secure (3DS) authentication session for a card payment. Requires the merchant.3ds.create permission. Flow: 1. Create a 3DS session with encrypted card data, or with card.card_id to authenticate a card stored via POST /v1/cards 2. If auth_status is ACTION_REQUIRED, the cardholder must complete the 3DS challenge using the tds_session_id with the client-side SDK 3. If auth_status is AUTHENTICATED, the session is ready to be used in a transaction 4. Pass the session id as three_d_secure_session_id when creating a card transaction Expiration: Sessions expire 1 hour after creation. Single use: A session authenticates one amount and currency and can be spent on one transaction. Recurring charges need a new session each time — a stored card does not change this. Supported card networks: Visa, Mastercard, and American Express. Cards from other networks (e.g. Elo, Hipercard, Discover, Diners, JCB) cannot be authenticated and are rejected with 400 VALIDATION_ERROR.\",\"dateModified\":\"2026-11-13T15:27:36.419Z\",\"isPartOf\":{\"@id\":\"https://docs.rinne.com.br#website\"},\"breadcrumb\":{\"@id\":\"https://docs.rinne.com.br/api-reference/3d-secure/create-a-3d-secure-session-linked-to-a-merchant#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.rinne.com.br/api-reference/3d-secure/create-a-3d-secure-session-linked-to-a-merchant#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Merchants\",\"item\":\"https://docs.rinne.com.br/api-reference/management/list-merchants\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Transactions\",\"item\":\"https://docs.rinne.com.br/api-reference/transactions/create-a-new-transaction-for-a-specific-merchant\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create a 3D Secure session linked to a merchant\",\"item\":\"https://docs.rinne.com.br/api-reference/3d-secure/create-a-3d-secure-session-linked-to-a-merchant\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.rinne.com.br/api-reference/3d-secure/create-a-3d-secure-session-linked-to-a-merchant#apireference\",\"headline\":\"Create a 3D Secure session linked to a merchant\",\"name\":\"Create a 3D Secure session linked to a merchant\",\"description\":\"Creates a standalone 3D Secure (3DS) authentication session for a card payment. Requires the merchant.3ds.create permission. Flow: 1. Create a 3DS session with encrypted card data, or with card.card_id to authenticate a card stored via POST /v1/cards 2. If auth_status is ACTION_REQUIRED, the cardholder must complete the 3DS challenge using the tds_session_id with the client-side SDK 3. If auth_status is AUTHENTICATED, the session is ready to be used in a transaction 4. Pass the session id as three_d_secure_session_id when creating a card transaction Expiration: Sessions expire 1 hour after creation. Single use: A session authenticates one amount and currency and can be spent on one transaction. Recurring charges need a new session each time — a stored card does not change this. Supported card networks: Visa, Mastercard, and American Express. Cards from other networks (e.g. Elo, Hipercard, Discover, Diners, JCB) cannot be authenticated and are rejected with 400 VALIDATION_ERROR.\",\"url\":\"https://docs.rinne.com.br/api-reference/3d-secure/create-a-3d-secure-session-linked-to-a-merchant\",\"mainEntityOfPage\":{\"@id\":\"https://docs.rinne.com.br/api-reference/3d-secure/create-a-3d-secure-session-linked-to-a-merchant#webpage\"},\"dateModified\":\"2026-11-13T15:27:36.419Z\",\"publisher\":{\"@id\":\"https://docs.rinne.com.br/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.rinne.com.br#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Rinne API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Rinne API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/3d-secure/create-a-3d-secure-session-linked-to-a-merchant.md","siteName":"Rinne API","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"Onboarding","icon":"id-card","pages":[{"title":"Onboarding","href":"/onboarding"}]},{"tab":"rinne-js","icon":"js","pages":[{"title":"rinne-js","href":"/rinne-js"}]},{"tab":"TapOnPhone","icon":"mobile-screen","pages":[{"title":"TapOnPhone","href":"/tap-on-phone"}]},{"tab":"API Reference","groups":[{"group":"Introduction","pages":[{"title":"API Reference","href":"/api-reference/introduction"}]},{"group":"Merchants","pages":[{"group":"Management","pages":[{"title":"List merchants","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/merchants","href":"/api-reference/management/list-merchants"},{"title":"Create new merchant","deprecated":null,"version":null,"openapi":"/api-spec.yaml post /v1/merchants","href":"/api-reference/management/create-new-merchant"},{"title":"Get merchant by ID","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/merchants/{merchantId}","href":"/api-reference/management/get-merchant-by-id"},{"title":"Update merchant","deprecated":null,"version":null,"openapi":"/api-spec.yaml patch /v1/merchants/{merchantId}","href":"/api-reference/management/update-merchant"},{"title":"Get public settings for a merchant","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/merchants/{merchantId}/public-settings","href":"/api-reference/management/get-public-settings-for-a-merchant"},{"title":"Get merchant overview","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/merchants/overview","href":"/api-reference/management/get-merchant-overview"}]},{"group":"Transactions","pages":[{"title":"Create a new transaction for a specific merchant","description":"Requires the merchant.transaction.create permission.\n\nCreates a new transaction for a merchant that belongs to the authenticated organization\n","deprecated":null,"version":null,"openapi":"/api-spec.yaml post /v1/merchants/{merchantId}/transactions","href":"/api-reference/transactions/create-a-new-transaction-for-a-specific-merchant"},{"title":"Create a 3D Secure session linked to a merchant","deprecated":null,"version":null,"openapi":"/api-spec.yaml post /v1/merchants/{merchantId}/3ds-sessions","href":"/api-reference/3d-secure/create-a-3d-secure-session-linked-to-a-merchant"},{"title":"Get a 3D Secure session of a merchant","description":"Returns a 3D Secure session with its current `auth_status`. Use it server-side to\nconfirm the outcome of a challenge the cardholder completed in the client-side SDK,\nfor example after saving a card with no charge.\nRequires the merchant.3ds.view permission.\n\n**When to call:** once, after the SDK's `onSuccess`, `onFailure` or `onError`\ncallback fires — not in a loop. To learn the outcome without calling this endpoint,\nsubscribe to the `three-d-secure-session.status-changed` webhook, and call it once if\nthe event has not arrived by a cutoff of your own, such as the session's `expires_at`:\na session the cardholder leaves before the challenge starts may never send it. While\nthe session is `ACTION_REQUIRED`, the status is re-read from the 3DS provider before\nresponding, so a challenge completed since creation is reflected here. `AUTHENTICATED`\nand `FAILED` are final. `ACTION_REQUIRED` at your cutoff means the cardholder has not\ncompleted the challenge so far; if the provider reports an outcome later, the webhook\nis sent then.\n\n**Verifying a saved card:** create the session with `card.card_id`, then check that\nthe `card_id` returned here is the card you saved. A session created with inline\ncard data returns `card_id: null`.\n\n**`AUTHENTICATED` is not always an authenticated cardholder:** with\n`authentication_flow: attempt`, the cardholder was not authenticated and only proof\nof the authentication attempt exists.\n","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/merchants/{merchantId}/3ds-sessions/{sessionId}","href":"/api-reference/3d-secure/get-a-3d-secure-session-of-a-merchant"},{"title":"Authenticate a merchant's transaction with 3D Secure","deprecated":null,"version":null,"openapi":"/api-spec.yaml post /v1/merchants/{merchantId}/transactions/{transactionId}/authenticate","href":"/api-reference/3d-secure/authenticate-a-merchants-transaction-with-3d-secure"},{"title":"Get transactions for all merchants","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/merchants/transactions","href":"/api-reference/transactions/get-transactions-for-all-merchants"},{"title":"Get a specific transaction by ID across all merchants","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/merchants/transactions/{transactionId}","href":"/api-reference/transactions/get-a-specific-transaction-by-id-across-all-merchants"},{"title":"Get a specific transaction for a merchant","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/merchants/{merchantId}/transactions/{transactionId}","href":"/api-reference/transactions/get-a-specific-transaction-for-a-merchant"},{"title":"Get transaction receipts for a specific merchant","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/merchants/{merchantId}/transactions/{transactionId}/receipt","href":"/api-reference/transactions/get-transaction-receipts-for-a-specific-merchant"},{"title":"Refund a transaction for a specific merchant","deprecated":null,"version":null,"openapi":"/api-spec.yaml post /v1/merchants/{merchantId}/transactions/{transactionId}/refunds","href":"/api-reference/transactions/refund-a-transaction-for-a-specific-merchant"},{"title":"Cancel existing pending refund for a merchant transaction by ID","deprecated":null,"version":null,"openapi":"/api-spec.yaml patch /v1/merchants/{merchantId}/transactions/{transactionId}/refunds/cancel","href":"/api-reference/transactions/cancel-existing-pending-refund-for-a-merchant-transaction-by-id"},{"title":"Cancel a merchant's BOLEPIX transaction","deprecated":null,"version":null,"openapi":"/api-spec.yaml post /v1/merchants/{merchantId}/transactions/{transactionId}/cancel","href":"/api-reference/transactions/cancel-a-merchants-bolepix-transaction"},{"title":"Get merchant transactions overview","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/merchants/transactions/overview","href":"/api-reference/transactions/get-merchant-transactions-overview"},{"title":"Pay PIX or BOLEPIX transaction via QR code (Sandbox Only)","deprecated":null,"version":null,"openapi":"/api-spec.yaml post /v1/merchants/{merchantId}/transactions/{transactionId}/pay","href":"/api-reference/transactions/pay-pix-or-bolepix-transaction-via-qr-code-sandbox-only"}]},{"group":"Cards","pages":[{"title":"Store a card for a merchant","deprecated":null,"version":null,"openapi":"/api-spec.yaml post /v1/merchants/{merchantId}/cards","href":"/api-reference/cards/store-a-card-for-a-merchant"},{"title":"List a merchant's stored cards","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/merchants/{merchantId}/cards","href":"/api-reference/cards/list-a-merchants-stored-cards"},{"title":"Get a merchant's stored card","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/merchants/{merchantId}/cards/{cardId}","href":"/api-reference/cards/get-a-merchants-stored-card"},{"title":"Delete a merchant's stored card","deprecated":null,"version":null,"openapi":"/api-spec.yaml delete /v1/merchants/{merchantId}/cards/{cardId}","href":"/api-reference/cards/delete-a-merchants-stored-card"}]},{"group":"KYC","pages":[{"title":"List KYC checks for a specific merchant","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/merchants/{merchantId}/kyc-checks","href":"/api-reference/kyc/list-kyc-checks-for-a-specific-merchant"}]},{"group":"Affiliations","pages":[{"title":"Get affiliations for all merchants","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/merchants/affiliations","href":"/api-reference/affiliations/get-affiliations-for-all-merchants"},{"title":"List affiliations for a specific merchant","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/merchants/{merchantId}/affiliations","href":"/api-reference/affiliations/list-affiliations-for-a-specific-merchant"},{"title":"Create a new affiliation for a specific merchant","deprecated":null,"version":null,"openapi":"/api-spec.yaml post /v1/merchants/{merchantId}/affiliations","href":"/api-reference/affiliations/create-a-new-affiliation-for-a-specific-merchant"},{"title":"Get a specific affiliation for a merchant","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/merchants/{merchantId}/affiliations/{id}","href":"/api-reference/affiliations/get-a-specific-affiliation-for-a-merchant"},{"title":"Update anticipation configuration for a merchant's affiliation","deprecated":null,"version":null,"openapi":"/api-spec.yaml patch /v1/merchants/{merchantId}/affiliations/{id}","href":"/api-reference/affiliations/update-anticipation-configuration-for-a-merchants-affiliation"},{"title":"Cancel a merchant's affiliation that is waiting for documents","deprecated":null,"version":null,"openapi":"/api-spec.yaml post /v1/merchants/{merchantId}/affiliations/{id}/cancel","href":"/api-reference/affiliations/cancel-a-merchants-affiliation-that-is-waiting-for-documents"},{"title":"Reissue a merchant's onboarding link","deprecated":null,"version":null,"openapi":"/api-spec.yaml post /v1/merchants/{merchantId}/affiliations/{id}/onboarding-link","href":"/api-reference/affiliations/reissue-a-merchants-onboarding-link"},{"title":"Get onboarding document with download URL for a merchant's affiliation","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/merchants/{merchantId}/affiliations/{affiliationId}/onboarding-documents/{documentId}","href":"/api-reference/affiliations/get-onboarding-document-with-download-url-for-a-merchants-affiliation"},{"title":"Request settlement bank account update for a merchant's affiliation","deprecated":null,"version":null,"openapi":"/api-spec.yaml post /v1/merchants/{merchantId}/affiliations/{affiliationId}/settlement-bank-account","href":"/api-reference/affiliations/request-settlement-bank-account-update-for-a-merchants-affiliation"}]},{"group":"Onboarding Requirements","pages":[{"title":"List onboarding requirements","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/merchants/{merchantId}/onboarding-requirements","href":"/api-reference/onboarding-requirements/list-onboarding-requirements"},{"title":"Answer an onboarding requirement","deprecated":null,"version":null,"openapi":"/api-spec.yaml post /v1/merchants/{merchantId}/onboarding-requirements/{id}/answer","href":"/api-reference/onboarding-requirements/answer-an-onboarding-requirement"}]},{"group":"Onboarding Documents","pages":[{"title":"Open an onboarding document upload","deprecated":null,"version":null,"openapi":"/api-spec.yaml post /v1/merchants/{merchantId}/onboarding-documents","href":"/api-reference/onboarding-documents/open-an-onboarding-document-upload"},{"title":"Complete an onboarding document upload","deprecated":null,"version":null,"openapi":"/api-spec.yaml post /v1/merchants/{merchantId}/onboarding-documents/{id}/complete","href":"/api-reference/onboarding-documents/complete-an-onboarding-document-upload"},{"title":"List onboarding documents","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/merchants/{merchantId}/onboarding-documents","href":"/api-reference/onboarding-documents/list-onboarding-documents"},{"title":"Get an onboarding document","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/merchants/{merchantId}/onboarding-documents/{id}","href":"/api-reference/onboarding-documents/get-an-onboarding-document"}]},{"group":"Biometric Verifications","pages":[{"title":"Start a biometric verification","deprecated":null,"version":null,"openapi":"/api-spec.yaml post /v1/merchants/{merchantId}/biometric-verifications","href":"/api-reference/biometric-verifications/start-a-biometric-verification"},{"title":"List biometric verifications","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/merchants/{merchantId}/biometric-verifications","href":"/api-reference/biometric-verifications/list-biometric-verifications"},{"title":"Get a biometric verification","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/merchants/{merchantId}/biometric-verifications/{id}","href":"/api-reference/biometric-verifications/get-a-biometric-verification"}]},{"group":"Banking","pages":[{"title":"Get banking balance for a specific merchant","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/merchants/{merchantId}/balance","href":"/api-reference/banking/get-banking-balance-for-a-specific-merchant"},{"title":"Add balance to merchant bank account (Sandbox Only)","deprecated":null,"version":null,"openapi":"/api-spec.yaml post /v1/merchants/{merchantId}/balance","href":"/api-reference/banking/add-balance-to-merchant-bank-account-sandbox-only"},{"title":"Get banking statement for a specific merchant","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/merchants/{merchantId}/statement","href":"/api-reference/banking/get-banking-statement-for-a-specific-merchant"},{"title":"List all PIX keys for a specific merchant","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/merchants/{merchantId}/pix/keys","href":"/api-reference/pix-keys/list-all-pix-keys-for-a-specific-merchant"},{"title":"Create a new PIX key for a specific merchant","deprecated":null,"version":null,"openapi":"/api-spec.yaml post /v1/merchants/{merchantId}/pix/keys","href":"/api-reference/pix-keys/create-a-new-pix-key-for-a-specific-merchant"},{"title":"Delete a PIX key for a specific merchant","deprecated":null,"version":null,"openapi":"/api-spec.yaml delete /v1/merchants/{merchantId}/pix/keys","href":"/api-reference/pix-keys/delete-a-pix-key-for-a-specific-merchant"},{"title":"Create a new internal transfer request","deprecated":null,"version":null,"openapi":"/api-spec.yaml post /v1/banking/internal-transfers","href":"/api-reference/banking/create-a-new-internal-transfer-request"},{"title":"List internal transfers for authenticated company","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/banking/internal-transfers","href":"/api-reference/banking/list-internal-transfers-for-authenticated-company"},{"title":"Get a specific internal transfer by ID","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/banking/internal-transfers/{id}","href":"/api-reference/banking/get-a-specific-internal-transfer-by-id"},{"title":"List judicial blockages for a specific merchant","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/merchants/{merchantId}/banking/judicial-blockages","href":"/api-reference/banking/list-judicial-blockages-for-a-specific-merchant"}]},{"group":"Cashouts","pages":[{"group":"External PIX Keys","pages":[{"title":"List all PIX keys for a merchant","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/merchants/{merchantId}/pix-keys","href":"/api-reference/bank-accounts/list-all-pix-keys-for-a-merchant"},{"title":"Create a PIX key for a merchant","deprecated":null,"version":null,"openapi":"/api-spec.yaml post /v1/merchants/{merchantId}/pix-keys","href":"/api-reference/bank-accounts/create-a-pix-key-for-a-merchant"},{"title":"Get a PIX key for a merchant","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/merchants/{merchantId}/pix-keys/{id}","href":"/api-reference/bank-accounts/get-a-pix-key-for-a-merchant"},{"title":"Update a PIX key for a merchant","deprecated":null,"version":null,"openapi":"/api-spec.yaml patch /v1/merchants/{merchantId}/pix-keys/{id}","href":"/api-reference/bank-accounts/update-a-pix-key-for-a-merchant"},{"title":"Delete a PIX key for a merchant","deprecated":null,"version":null,"openapi":"/api-spec.yaml delete /v1/merchants/{merchantId}/pix-keys/{id}","href":"/api-reference/bank-accounts/delete-a-pix-key-for-a-merchant"}]},{"group":"External Bank Accounts","pages":[{"title":"List all bank accounts for a merchant","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/merchants/{merchantId}/bank-accounts","href":"/api-reference/bank-accounts/list-all-bank-accounts-for-a-merchant"},{"title":"Registers a new external bank account for a merchant","deprecated":null,"version":null,"openapi":"/api-spec.yaml post /v1/merchants/{merchantId}/bank-accounts","href":"/api-reference/bank-accounts/registers-a-new-external-bank-account-for-a-merchant"},{"title":"Get specific bank account details for a merchant","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/merchants/{merchantId}/bank-accounts/{id}","href":"/api-reference/bank-accounts/get-specific-bank-account-details-for-a-merchant"},{"title":"Update bank account information for a merchant","deprecated":null,"version":null,"openapi":"/api-spec.yaml patch /v1/merchants/{merchantId}/bank-accounts/{id}","href":"/api-reference/bank-accounts/update-bank-account-information-for-a-merchant"},{"title":"Soft delete bank account for a merchant","deprecated":null,"version":null,"openapi":"/api-spec.yaml delete /v1/merchants/{merchantId}/bank-accounts/{id}","href":"/api-reference/bank-accounts/soft-delete-bank-account-for-a-merchant"}]},{"title":"Create a cashout request for a specific merchant","deprecated":null,"version":null,"openapi":"/api-spec.yaml post /v1/merchants/{merchantId}/cashouts","href":"/api-reference/banking/create-a-cashout-request-for-a-specific-merchant"},{"title":"List cashouts for a specific merchant","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/merchants/{merchantId}/cashouts","href":"/api-reference/banking/list-cashouts-for-a-specific-merchant"},{"title":"Get a specific cashout for a merchant","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/merchants/{merchantId}/cashouts/{id}","href":"/api-reference/banking/get-a-specific-cashout-for-a-merchant"},{"title":"Get merchant cashout receipt","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/merchants/{merchantId}/cashouts/{id}/receipt","href":"/api-reference/banking/get-merchant-cashout-receipt"}]},{"group":"Ledger","pages":[{"title":"Get ledger entries for all merchants","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/merchants/ledger-entries","href":"/api-reference/ledger/get-ledger-entries-for-all-merchants"},{"title":"Get a single ledger entry by ID for organization","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/merchants/ledger-entries/{ledgerEntryId}","href":"/api-reference/ledger/get-a-single-ledger-entry-by-id-for-organization"},{"title":"Get ledger entries for a specific merchant","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/merchants/{merchantId}/ledger-entries","href":"/api-reference/ledger/get-ledger-entries-for-a-specific-merchant"}]},{"group":"Receivables","pages":[{"title":"List contract effects on your merchants' receivables","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/merchants/receivables/contract-effects","href":"/api-reference/receivables/list-contract-effects-on-your-merchants-receivables"}]},{"group":"Disputes","pages":[{"title":"Get disputes for all merchants","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/merchants/disputes","href":"/api-reference/disputes/get-disputes-for-all-merchants"},{"title":"Get a single dispute by ID for organization","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/merchants/disputes/{id}","href":"/api-reference/disputes/get-a-single-dispute-by-id-for-organization"}]}]},{"group":"Pricing","pages":[{"group":"Pricing","pages":[{"title":"List fee policies","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/pricing/fee-policies","href":"/api-reference/pricing/list-fee-policies"},{"title":"Create a new fee policy","deprecated":null,"version":null,"openapi":"/api-spec.yaml post /v1/pricing/fee-policies","href":"/api-reference/pricing/create-a-new-fee-policy"},{"title":"Update a fee policy","deprecated":null,"version":null,"openapi":"/api-spec.yaml patch /v1/pricing/fee-policies/{id}","href":"/api-reference/pricing/update-a-fee-policy"},{"title":"Replace a fee policy","deprecated":null,"version":null,"openapi":"/api-spec.yaml put /v1/pricing/fee-policies/{id}","href":"/api-reference/pricing/replace-a-fee-policy"},{"title":"List cost policies","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/pricing/cost-policies","href":"/api-reference/pricing/list-cost-policies"}]}]},{"group":"Tap-on-Phone","pages":[{"title":"Mint a Tap-on-Phone access token","deprecated":null,"version":null,"openapi":"/api-spec.yaml post /v1/terminal/token","href":"/api-reference/tap-on-phone/mint-a-tap-on-phone-access-token"}]},{"group":"Webhooks","pages":[{"group":"Management","pages":[{"title":"Get webhook dashboard URL","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/webhooks/dashboard","href":"/api-reference/webhooks/get-webhook-dashboard-url"}]},{"group":"Events","pages":[{"title":"Affiliation created","version":null,"deprecated":null,"openapi":"/api-spec.yaml webhook affiliation.created","href":"/api-reference/events/affiliation-created"},{"title":"Affiliation status changed","version":null,"deprecated":null,"openapi":"/api-spec.yaml webhook affiliation.status-changed","href":"/api-reference/events/affiliation-status-changed"},{"title":"Affiliation requirements changed","version":null,"deprecated":null,"openapi":"/api-spec.yaml webhook affiliation.requirements-changed","href":"/api-reference/events/affiliation-requirements-changed"},{"title":"Affiliation bank account operational status changed","version":null,"deprecated":null,"openapi":"/api-spec.yaml webhook affiliation-bank-account.operational-status-changed","href":"/api-reference/events/affiliation-bank-account-operational-status-changed"},{"title":"Biometric verification status changed","version":null,"deprecated":null,"openapi":"/api-spec.yaml webhook biometric-verification.status-changed","href":"/api-reference/events/biometric-verification-status-changed"},{"title":"Cashout created","version":null,"deprecated":null,"openapi":"/api-spec.yaml webhook cashout.created","href":"/api-reference/events/cashout-created"},{"title":"Cashout status changed","version":null,"deprecated":null,"openapi":"/api-spec.yaml webhook cashout.status-changed","href":"/api-reference/events/cashout-status-changed"},{"title":"Company created","version":null,"deprecated":null,"openapi":"/api-spec.yaml webhook company.created","href":"/api-reference/events/company-created"},{"title":"Company status changed","version":null,"deprecated":null,"openapi":"/api-spec.yaml webhook company.status-changed","href":"/api-reference/events/company-status-changed"},{"title":"Dispute created","version":null,"deprecated":null,"openapi":"/api-spec.yaml webhook dispute.created","href":"/api-reference/events/dispute-created"},{"title":"Dispute funds held","version":null,"deprecated":null,"openapi":"/api-spec.yaml webhook dispute.funds-held","href":"/api-reference/events/dispute-funds-held"},{"title":"Dispute funds released","version":null,"deprecated":null,"openapi":"/api-spec.yaml webhook dispute.funds-released","href":"/api-reference/events/dispute-funds-released"},{"title":"Dispute funds returned","version":null,"deprecated":null,"openapi":"/api-spec.yaml webhook dispute.funds-returned","href":"/api-reference/events/dispute-funds-returned"},{"title":"Dispute status changed","version":null,"deprecated":null,"openapi":"/api-spec.yaml webhook dispute.status-changed","href":"/api-reference/events/dispute-status-changed"},{"title":"Internal transfer created","version":null,"deprecated":null,"openapi":"/api-spec.yaml webhook internal-transfer.created","href":"/api-reference/events/internal-transfer-created"},{"title":"Internal transfer status changed","version":null,"deprecated":null,"openapi":"/api-spec.yaml webhook internal-transfer.status-changed","href":"/api-reference/events/internal-transfer-status-changed"},{"title":"Judicial blockage created","version":null,"deprecated":null,"openapi":"/api-spec.yaml webhook judicial-blockage.created","href":"/api-reference/events/judicial-blockage-created"},{"title":"Kyc completed","version":null,"deprecated":null,"openapi":"/api-spec.yaml webhook kyc.completed","href":"/api-reference/events/kyc-completed"},{"title":"Ledger entry settled","version":null,"deprecated":null,"openapi":"/api-spec.yaml webhook ledger-entry.settled","href":"/api-reference/events/ledger-entry-settled"},{"title":"Pix key created","version":null,"deprecated":null,"openapi":"/api-spec.yaml webhook pix-key.created","href":"/api-reference/events/pix-key-created"},{"title":"Pix key status changed","version":null,"deprecated":null,"openapi":"/api-spec.yaml webhook pix-key.status-changed","href":"/api-reference/events/pix-key-status-changed"},{"title":"Onboarding document status changed","version":null,"deprecated":null,"openapi":"/api-spec.yaml webhook onboarding-document.status-changed","href":"/api-reference/events/onboarding-document-status-changed"},{"title":"3ds session status changed","version":null,"deprecated":null,"openapi":"/api-spec.yaml webhook three-d-secure-session.status-changed","href":"/api-reference/events/3ds-session-status-changed"},{"title":"Transaction created","version":null,"deprecated":null,"openapi":"/api-spec.yaml webhook transaction.created","href":"/api-reference/events/transaction-created"},{"title":"Transaction status changed","version":null,"deprecated":null,"openapi":"/api-spec.yaml webhook transaction.status-changed","href":"/api-reference/events/transaction-status-changed"}]}]},{"group":"Organization Management","pages":[{"group":"Companies","pages":[{"title":"Get authenticated company information","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/companies/me","href":"/api-reference/companies/get-authenticated-company-information"},{"title":"Update authenticated company","deprecated":null,"version":null,"openapi":"/api-spec.yaml patch /v1/companies/me","href":"/api-reference/companies/update-authenticated-company"},{"title":"List all MCCs","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/companies/mccs","href":"/api-reference/companies/list-all-mccs"}]},{"group":"Company Affiliations","pages":[{"title":"List affiliations","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/affiliations","href":"/api-reference/company-affiliations/list-affiliations"},{"title":"Create new affiliation","deprecated":null,"version":null,"openapi":"/api-spec.yaml post /v1/affiliations","href":"/api-reference/company-affiliations/create-new-affiliation"},{"title":"Get a specific affiliation","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/affiliations/{id}","href":"/api-reference/company-affiliations/get-a-specific-affiliation"},{"title":"Update affiliation anticipation configuration","deprecated":null,"version":null,"openapi":"/api-spec.yaml patch /v1/affiliations/{id}","href":"/api-reference/company-affiliations/update-affiliation-anticipation-configuration"},{"title":"Cancel an affiliation that is waiting for documents","deprecated":null,"version":null,"openapi":"/api-spec.yaml post /v1/affiliations/{id}/cancel","href":"/api-reference/company-affiliations/cancel-an-affiliation-that-is-waiting-for-documents"},{"title":"Reissue the onboarding link","deprecated":null,"version":null,"openapi":"/api-spec.yaml post /v1/affiliations/{id}/onboarding-link","href":"/api-reference/company-affiliations/reissue-the-onboarding-link"},{"title":"Get onboarding document with download URL","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/affiliations/{affiliationId}/onboarding-documents/{documentId}","href":"/api-reference/company-affiliations/get-onboarding-document-with-download-url"},{"title":"Request settlement bank account update","deprecated":null,"version":null,"openapi":"/api-spec.yaml post /v1/affiliations/{affiliationId}/settlement-bank-account","href":"/api-reference/company-affiliations/request-settlement-bank-account-update"}]},{"group":"Onboarding Requirements","pages":[{"title":"List onboarding requirements","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/onboarding-requirements","href":"/api-reference/company-onboarding-requirements/list-onboarding-requirements"},{"title":"Answer an onboarding requirement","deprecated":null,"version":null,"openapi":"/api-spec.yaml post /v1/onboarding-requirements/{id}/answer","href":"/api-reference/company-onboarding-requirements/answer-an-onboarding-requirement"}]},{"group":"Onboarding Documents","pages":[{"title":"Open an onboarding document upload","deprecated":null,"version":null,"openapi":"/api-spec.yaml post /v1/onboarding-documents","href":"/api-reference/company-onboarding-documents/open-an-onboarding-document-upload"},{"title":"Complete an onboarding document upload","deprecated":null,"version":null,"openapi":"/api-spec.yaml post /v1/onboarding-documents/{id}/complete","href":"/api-reference/company-onboarding-documents/complete-an-onboarding-document-upload"},{"title":"List onboarding documents","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/onboarding-documents","href":"/api-reference/company-onboarding-documents/list-onboarding-documents"},{"title":"Get an onboarding document","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/onboarding-documents/{id}","href":"/api-reference/company-onboarding-documents/get-an-onboarding-document"}]},{"group":"Company Biometric Verifications","pages":[{"title":"Start a biometric verification","deprecated":null,"version":null,"openapi":"/api-spec.yaml post /v1/biometric-verifications","href":"/api-reference/company-biometric-verifications/start-a-biometric-verification"},{"title":"List biometric verifications","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/biometric-verifications","href":"/api-reference/company-biometric-verifications/list-biometric-verifications"},{"title":"Get a biometric verification","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/biometric-verifications/{id}","href":"/api-reference/company-biometric-verifications/get-a-biometric-verification"}]},{"group":"Company Transactions","pages":[{"title":"Get transactions","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/transactions","href":"/api-reference/company-transactions/get-transactions"},{"title":"Create a new transaction","deprecated":null,"version":null,"openapi":"/api-spec.yaml post /v1/transactions","href":"/api-reference/company-transactions/create-a-new-transaction"},{"title":"Create a 3D Secure session","deprecated":null,"version":null,"openapi":"/api-spec.yaml post /v1/3ds-sessions","href":"/api-reference/3d-secure/create-a-3d-secure-session"},{"title":"Get a 3D Secure session","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/3ds-sessions/{id}","href":"/api-reference/3d-secure/get-a-3d-secure-session"},{"title":"Authenticate a transaction with 3D Secure","deprecated":null,"version":null,"openapi":"/api-spec.yaml post /v1/transactions/{transactionId}/authenticate","href":"/api-reference/3d-secure/authenticate-a-transaction-with-3d-secure"},{"title":"Get transaction by ID","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/transactions/{id}","href":"/api-reference/company-transactions/get-transaction-by-id"},{"title":"Get transaction receipts","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/transactions/{id}/receipt","href":"/api-reference/company-transactions/get-transaction-receipts"},{"title":"Refund a transaction","deprecated":null,"version":null,"openapi":"/api-spec.yaml post /v1/transactions/{id}/refunds","href":"/api-reference/company-transactions/refund-a-transaction"},{"title":"Cancel existing pending refund for a transaction by ID","deprecated":null,"version":null,"openapi":"/api-spec.yaml patch /v1/transactions/{id}/refunds/cancel","href":"/api-reference/company-transactions/cancel-existing-pending-refund-for-a-transaction-by-id"},{"title":"Cancel a BOLEPIX transaction","deprecated":null,"version":null,"openapi":"/api-spec.yaml post /v1/transactions/{id}/cancel","href":"/api-reference/transactions/cancel-a-bolepix-transaction"},{"title":"Get company transactions overview","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/transactions/overview","href":"/api-reference/company-transactions/get-company-transactions-overview"},{"title":"Pay organization's own PIX or BOLEPIX transaction via QR code (Sandbox Only)","deprecated":null,"version":null,"openapi":"/api-spec.yaml post /v1/transactions/{transactionId}/pay","href":"/api-reference/transactions/pay-organizations-own-pix-or-bolepix-transaction-via-qr-code-sandbox-only"}]},{"group":"Company Cards","pages":[{"title":"Store a card","deprecated":null,"version":null,"openapi":"/api-spec.yaml post /v1/cards","href":"/api-reference/cards/store-a-card"},{"title":"List stored cards","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/cards","href":"/api-reference/cards/list-stored-cards"},{"title":"Get a stored card","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/cards/{cardId}","href":"/api-reference/cards/get-a-stored-card"},{"title":"Delete a stored card","deprecated":null,"version":null,"openapi":"/api-spec.yaml delete /v1/cards/{cardId}","href":"/api-reference/cards/delete-a-stored-card"}]},{"group":"Company Banking","pages":[{"title":"Get account balance for a company","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/banking/balance","href":"/api-reference/company-banking/get-account-balance-for-a-company"},{"title":"Add balance to organization bank account (Sandbox Only)","deprecated":null,"version":null,"openapi":"/api-spec.yaml post /v1/banking/balance","href":"/api-reference/banking/add-balance-to-organization-bank-account-sandbox-only"},{"title":"Get account statement (movements) for a company","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/banking/statement","href":"/api-reference/company-banking/get-account-statement-movements-for-a-company"},{"title":"List all PIX keys","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/pix/keys","href":"/api-reference/company-pix/list-all-pix-keys"},{"title":"Create a new PIX key","deprecated":null,"version":null,"openapi":"/api-spec.yaml post /v1/pix/keys","href":"/api-reference/company-pix/create-a-new-pix-key"},{"title":"Delete a PIX key","deprecated":null,"version":null,"openapi":"/api-spec.yaml delete /v1/pix/keys","href":"/api-reference/company-pix/delete-a-pix-key"},{"title":"Get a specific PIX key by ID","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/pix/keys/{id}","href":"/api-reference/company-pix/get-a-specific-pix-key-by-id"},{"title":"List judicial blockages","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/banking/judicial-blockages","href":"/api-reference/company-banking/list-judicial-blockages"}]},{"group":"Company Cashouts","pages":[{"group":"External PIX Keys","pages":[{"title":"List all company PIX keys","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/companies/me/pix-keys","href":"/api-reference/companies/list-all-company-pix-keys"},{"title":"Create a company PIX key","deprecated":null,"version":null,"openapi":"/api-spec.yaml post /v1/companies/me/pix-keys","href":"/api-reference/companies/create-a-company-pix-key"},{"title":"Get a company PIX key","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/companies/me/pix-keys/{id}","href":"/api-reference/companies/get-a-company-pix-key"},{"title":"Update a company PIX key","deprecated":null,"version":null,"openapi":"/api-spec.yaml patch /v1/companies/me/pix-keys/{id}","href":"/api-reference/companies/update-a-company-pix-key"},{"title":"Delete a company PIX key","deprecated":null,"version":null,"openapi":"/api-spec.yaml delete /v1/companies/me/pix-keys/{id}","href":"/api-reference/companies/delete-a-company-pix-key"}]},{"group":"External Bank Accounts","pages":[{"title":"List all bank accounts","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/companies/me/bank-accounts","href":"/api-reference/companies/list-all-bank-accounts"},{"title":"Registers a new bank account","deprecated":null,"version":null,"openapi":"/api-spec.yaml post /v1/companies/me/bank-accounts","href":"/api-reference/companies/registers-a-new-bank-account"},{"title":"Get specific bank account details","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/companies/me/bank-accounts/{id}","href":"/api-reference/companies/get-specific-bank-account-details"},{"title":"Update bank account information","deprecated":null,"version":null,"openapi":"/api-spec.yaml patch /v1/companies/me/bank-accounts/{id}","href":"/api-reference/companies/update-bank-account-information"},{"title":"Soft delete bank account","deprecated":null,"version":null,"openapi":"/api-spec.yaml delete /v1/companies/me/bank-accounts/{id}","href":"/api-reference/companies/soft-delete-bank-account"}]},{"title":"Create a new cashout request","deprecated":null,"version":null,"openapi":"/api-spec.yaml post /v1/banking/cashouts","href":"/api-reference/company-banking/create-a-new-cashout-request"},{"title":"List cashouts","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/banking/cashouts","href":"/api-reference/company-banking/list-cashouts"},{"title":"Get a specific cashout by ID","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/banking/cashouts/{id}","href":"/api-reference/company-banking/get-a-specific-cashout-by-id"},{"title":"Get cashout receipt","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/banking/cashouts/{id}/receipt","href":"/api-reference/company-banking/get-cashout-receipt"}]},{"group":"Company Ledger","pages":[{"title":"Get ledger entries","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/ledger-entries","href":"/api-reference/company-ledger/get-ledger-entries"},{"title":"Get a single ledger entry by ID","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/ledger-entries/{ledgerEntryId}","href":"/api-reference/company-ledger/get-a-single-ledger-entry-by-id"}]},{"group":"Company Receivables","pages":[{"title":"List contract effects on your receivables","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/receivables/contract-effects","href":"/api-reference/company-receivables/list-contract-effects-on-your-receivables"}]},{"group":"Company Disputes","pages":[{"title":"Get disputes","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/disputes","href":"/api-reference/company-disputes/get-disputes"},{"title":"Get a single dispute by ID","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/disputes/{id}","href":"/api-reference/company-disputes/get-a-single-dispute-by-id"}]}]},{"group":"User Management","pages":[{"group":"Users","pages":[{"title":"List users","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/users","href":"/api-reference/users/list-users"},{"title":"Create a new user","deprecated":null,"version":null,"openapi":"/api-spec.yaml post /v1/users","href":"/api-reference/users/create-a-new-user"},{"title":"Get user by ID","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/users/{userId}","href":"/api-reference/users/get-user-by-id"},{"title":"Update user information","deprecated":null,"version":null,"openapi":"/api-spec.yaml patch /v1/users/{userId}","href":"/api-reference/users/update-user-information"},{"title":"Suspend user","deprecated":null,"version":null,"openapi":"/api-spec.yaml post /v1/users/{userId}/suspend","href":"/api-reference/users/suspend-user"},{"title":"Activate user","deprecated":null,"version":null,"openapi":"/api-spec.yaml post /v1/users/{userId}/activate","href":"/api-reference/users/activate-user"},{"title":"Assign role to user","deprecated":null,"version":null,"openapi":"/api-spec.yaml post /v1/users/{userId}/roles","href":"/api-reference/users/assign-role-to-user"}]},{"group":"Roles \u0026 Permissions","pages":[{"title":"List roles","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/roles","href":"/api-reference/roles/list-roles"},{"title":"Create a new role","deprecated":null,"version":null,"openapi":"/api-spec.yaml post /v1/roles","href":"/api-reference/roles/create-a-new-role"},{"title":"Get role by ID","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/roles/{id}","href":"/api-reference/roles/get-role-by-id"},{"title":"Update role","deprecated":null,"version":null,"openapi":"/api-spec.yaml put /v1/roles/{id}","href":"/api-reference/roles/update-role"},{"title":"Delete role","deprecated":null,"version":null,"openapi":"/api-spec.yaml delete /v1/roles/{id}","href":"/api-reference/roles/delete-role"},{"title":"Get all available permissions","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/permissions","href":"/api-reference/permissions/get-all-available-permissions"}]}]},{"group":"System","pages":[{"title":"API health status","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /health","href":"/api-reference/system/api-health-status"},{"title":"Get zipcode information","deprecated":null,"version":null,"openapi":"/api-spec.yaml get /v1/zipcodes/{id}","href":"/api-reference/zipcode/get-zipcode-information"}]}]}]},"basePath":"","title":"Rinne API Documentation","buildId":"dpl_5joLUXmnJgwqjrHAS4dxZrQTdxgh","deploymentId":"dpl_5joLUXmnJgwqjrHAS4dxZrQTdxgh","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DPDWPCdE.js","utils-DyjUHyLo.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BWYE1cdS.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-COAzxpEw.js","snippetPresets-DNiD_S52.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-CjwVt80x.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-ByHQMk7z.js","shallow-CaZuw1AO.js","getApiPlaygroundDisplay-DPVPOknm.js","CodeSnippet-B31CH-Mp.js","CodeSnippets-BxTYZWz6.js","Page-DDHbuAIY.js","getPastedJson-DhoAwiNO.js","icon-Dhq8z75J.js","MethodPill-DLXmKOwr.js","DuplicateIcon-jzdVwyRU.js","createIcon-eD0b3klN.js","DynamicMarkdown-BfddVCX7.js","SectionHeading-2pSCIo17.js","axios-vUo_bRtp.js","Markdown-DsWjhwJ4.js","clsx-B2t_mZQG.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CUljsAY7.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Cf70306N.js"]}