Retrieve account

GEThttps://api.omise.co/account

Returns information about the account. Both test and live API keys return the same account details. Use this endpoint to verify account configuration and capabilities.

Request Parameters

No parameters required for this endpoint.

---

Responses

200

Successful request

Returns the account object with all configuration details.

Account object contains:

• id - Account identifier
• email - Account email address
• country - Two-letter ISO 3166 country code
• currency - Three-letter ISO 4217 currency code
• supported_currencies - Array of supported currencies for charges
• webhook_uri - URI for account event notifications
• api_version - Default API version for the account
• chain_enabled - Boolean indicating if marketplace features are enabled
• chain_return_uri - Return URI for marketplace transactions
• zero_interest_installments - Boolean for merchant-funded installments
• metadata_export_keys - Metadata keys included in exports
• created_at - Account creation timestamp (ISO 8601)

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

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

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

account = Omise::Account.retrieve

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

account = omise.Account.retrieve()

Node.js

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

const account = await omise.account.retrieve();

PHP

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

$account = OmiseAccount::retrieve();

Java

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

Account account = client.account().get();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var account = await client.Account.Get();

Go

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

account, _ := client.Account().Get()

---

🔑API Credentials

▼

Try it out

Your IP: ...Loading...