Retrieve a Chain

GEThttps://api.omise.co/chains/{id}

Retrieve details of a specific chain merchant connection. Chains represent sub-merchants who have authorized another account to create charges and perform actions on their behalf.

Request Parameters

Required - 1 fieldPath Parameters

▼

`id`STRING(required)

Chain identifier matching pattern /acch(_test)?_[0-9a-z]+/. This is provided in the URL path.

Example:"acch_test_5xuy4w91xqz7d1w9u0t"

Constraints:Must be a valid chain ID

---

Responses

200

Successful retrieval

Chain retrieved successfully. Returns the complete chain object with connection details.

Response includes:

• id - Chain identifier
• key - Authentication key for the sub-merchant
• email - Sub-merchant account email
• revoked - Whether chain access has been revoked
• livemode - Production vs test environment indicator
• created_at - Creation timestamp

400

Bad request

Request validation failed. Check the error message for details.

Common causes:

• Invalid chain ID format
• Malformed request

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

Chain not found with the provided ID.

Common causes:

• Invalid chain ID format
• Chain does not exist
• Chain belongs to different account
• Using test key with live chain ID (or vice versa)

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/chains/acch_test_5xuy4w91xqz7d1w9u0t \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

chain = Omise::Chain.retrieve('acch_test_5xuy4w91xqz7d1w9u0t')

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

chain = omise.Chain.retrieve('acch_test_5xuy4w91xqz7d1w9u0t')

Node.js

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

const chain = await omise.chains.retrieve('acch_test_5xuy4w91xqz7d1w9u0t');

PHP

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

$chain = OmiseChain::retrieve('acch_test_5xuy4w91xqz7d1w9u0t');

Java

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

Chain chain = client.chains().get("acch_test_5xuy4w91xqz7d1w9u0t");

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var chain = await client.Chains.Get("acch_test_5xuy4w91xqz7d1w9u0t");

Go

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

chain, _ := client.Chains().Get("acch_test_5xuy4w91xqz7d1w9u0t")

---

Error and result codes

Common Error Codes

Code	Description	Resolution
authentication_failure	Invalid API key	Verify your secret key is correct
not_found	Chain not found	Check chain ID is correct and exists
invalid_chain_id	Malformed chain ID	Ensure ID matches format acch(test)?[0-9a-z]+

Chain Object Fields

Field	Type	Description
object	string	Always returns "chain"
id	string	Unique chain identifier
key	string	Authentication key for performing actions on behalf of the sub-merchant
email	string	Sub-merchant account email
livemode	boolean	Production vs test environment indicator
revoked	boolean	Indicates if chain access has been revoked
created_at	string	Creation timestamp (ISO 8601)

---

🔑API Credentials

▼

Try it out

Your IP: ...Loading...