Retrieve a linked account

GEThttps://api.omise.co/linked_accounts/:id

Retrieve details of a specific linked account including verification status, capabilities, and account information.

---

Request Parameters

Required - 1 fieldRequired Parameters

▼

`id`STRING(required)

Linked Account ID (e.g., lacct_test_...). Provided in the URL path.

Example:"lacct_test_5xuy4w91xqz7d1w9u0t"

---

Responses

200

Successful transaction

Linked account retrieved successfully. Returns complete linked account object with all attributes.

Returned linked account attributes:

• id - Linked account identifier
• object - Always "linked_account"
• livemode - Whether this is a live or test account
• status - Account status (pending, verified, suspended, rejected)
• type - Account type (individual, business)
• name - Account holder or business name
• email - Contact email address
• capabilities - Enabled capabilities (card_payments, transfers, refunds)
• metadata - Custom metadata
• created_at - Account creation timestamp

400

Bad request

Request validation failed. Check the error message for details.

Common causes:

• Malformed linked account ID format
• Invalid request parameters

401

Unauthorized

Authentication failed. Invalid or missing API key.

Common causes:

• Missing Authorization header
• Invalid secret key
• Using public key instead of secret key
• Incorrect HTTP Basic Auth format

404

Not found

Linked account not found.

Common causes:

• Invalid linked account ID
• Linked account does not belong to your platform
• Linked account has been disconnected
• Mixing test and live mode IDs

5xx

Server error

Server-side error occurred. These are rare but should be handled gracefully.

How to handle:

• Retry the request with exponential backoff
• Check status.omise.co for service incidents
• See Error Handling for detailed guidance

---

Code samples

cURL

curl https://api.omise.co/linked_accounts/lacct_test_5xuy4w91xqz7d1w9u0t \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

linked_account = Omise::LinkedAccount.retrieve('lacct_test_5xuy4w91xqz7d1w9u0t')

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

linked_account = omise.LinkedAccount.retrieve('lacct_test_5xuy4w91xqz7d1w9u0t')

Node.js

const omise = require('omise')({
  secretKey: 'skey_test_5xuy4w91xqz7d1w9u0t'
});

const linkedAccount = await omise.linkedAccounts.retrieve('lacct_test_5xuy4w91xqz7d1w9u0t');

PHP

<?php
define('OMISE_SECRET_KEY', 'skey_test_5xuy4w91xqz7d1w9u0t');

$linked_account = OmiseLinkedAccount::retrieve('lacct_test_5xuy4w91xqz7d1w9u0t');

Java

Client client = new Client.Builder()
    .secretKey("skey_test_5xuy4w91xqz7d1w9u0t")
    .build();

LinkedAccount linkedAccount = client.linkedAccounts()
    .get("lacct_test_5xuy4w91xqz7d1w9u0t");

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var linkedAccount = await client.LinkedAccounts.Get("lacct_test_5xuy4w91xqz7d1w9u0t");

Go

client, _ := omise.NewClient(
    "pkey_test_5xuy4w91xqz7d1w9u0t",
    "skey_test_5xuy4w91xqz7d1w9u0t",
)

linkedAccount, _ := client.LinkedAccounts().Get("lacct_test_5xuy4w91xqz7d1w9u0t")

---

🔑API Credentials

▼

Try it out

Required - 1 fields

▼

id(Required)

Your IP: ...Loading...