curl --request GET \
--url https://api-sandbox.rinne.com.br/core/v1/merchants/{merchantId}/3ds-sessions/{sessionId} \
--header 'x-api-key: <api-key>'import requests
url = "https://api-sandbox.rinne.com.br/core/v1/merchants/{merchantId}/3ds-sessions/{sessionId}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api-sandbox.rinne.com.br/core/v1/merchants/{merchantId}/3ds-sessions/{sessionId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-sandbox.rinne.com.br/core/v1/merchants/{merchantId}/3ds-sessions/{sessionId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api-sandbox.rinne.com.br/core/v1/merchants/{merchantId}/3ds-sessions/{sessionId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-sandbox.rinne.com.br/core/v1/merchants/{merchantId}/3ds-sessions/{sessionId}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.rinne.com.br/core/v1/merchants/{merchantId}/3ds-sessions/{sessionId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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"
}{
"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"
}
}{
"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"
}
}{
"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"
}
}{
"error": {
"code": "INTEGRATION_ERROR",
"message": "Integration error with provider CELCOIN",
"status": 502,
"path": "/merchants/{merchantId}/balance",
"timestamp": "2023-11-07T05:31:56Z",
"requestId": "<string>",
"details": {}
}
}Get a 3D Secure session of a merchant
Returns a 3D Secure session with its current auth_status. Use it server-side to
confirm the outcome of a challenge the cardholder completed in the client-side SDK,
for example after saving a card with no charge.
Requires the merchant.3ds.view permission.
When to call: once, after the SDK’s onSuccess, onFailure or onError
callback fires — not in a loop. To learn the outcome without calling this endpoint,
subscribe to the three-d-secure-session.status-changed webhook, and call it once if
the event has not arrived by a cutoff of your own, such as the session’s expires_at:
a session the cardholder leaves before the challenge starts may never send it. While
the session is ACTION_REQUIRED, the status is re-read from the 3DS provider before
responding, so a challenge completed since creation is reflected here. AUTHENTICATED
and FAILED are final. ACTION_REQUIRED at your cutoff means the cardholder has not
completed the challenge so far; if the provider reports an outcome later, the webhook
is sent then.
Verifying a saved card: create the session with card.card_id, then check that
the card_id returned here is the card you saved. A session created with inline
card data returns card_id: null.
AUTHENTICATED is not always an authenticated cardholder: with
authentication_flow: attempt, the cardholder was not authenticated and only proof
of the authentication attempt exists.
curl --request GET \
--url https://api-sandbox.rinne.com.br/core/v1/merchants/{merchantId}/3ds-sessions/{sessionId} \
--header 'x-api-key: <api-key>'import requests
url = "https://api-sandbox.rinne.com.br/core/v1/merchants/{merchantId}/3ds-sessions/{sessionId}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api-sandbox.rinne.com.br/core/v1/merchants/{merchantId}/3ds-sessions/{sessionId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-sandbox.rinne.com.br/core/v1/merchants/{merchantId}/3ds-sessions/{sessionId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api-sandbox.rinne.com.br/core/v1/merchants/{merchantId}/3ds-sessions/{sessionId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-sandbox.rinne.com.br/core/v1/merchants/{merchantId}/3ds-sessions/{sessionId}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.rinne.com.br/core/v1/merchants/{merchantId}/3ds-sessions/{sessionId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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"
}{
"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"
}
}{
"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"
}
}{
"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"
}
}{
"error": {
"code": "INTEGRATION_ERROR",
"message": "Integration error with provider CELCOIN",
"status": 502,
"path": "/merchants/{merchantId}/balance",
"timestamp": "2023-11-07T05:31:56Z",
"requestId": "<string>",
"details": {}
}
}Path Parameters
Response
The 3DS session
Current authentication status:
ACTION_REQUIRED: Cardholder must complete 3DS challengeAUTHENTICATED: Authentication successful (frictionless or completed challenge), or only attempted: withauthentication_flow: attemptthe cardholder was not authenticated and only proof of the attempt existsFAILED: Authentication failed
ACTION_REQUIRED, AUTHENTICATED, FAILED "AUTHENTICATED"
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.
"cfb8d11b-8129-414e-983a-3e95f0f4f6c6"

