List API Versions

GEThttps://api.omise.co/account/api_versions

Returns a list of all available API versions for the account. Use this endpoint to discover supported API versions and determine which version to use for your integration.

Request Parameters

No parameters required for this endpoint.

---

Responses

200

Successful request

Returns a list of available API versions with details about each version.

Response structure:

• object - Always returns "list"
• data - Array of API version objects
• location - API endpoint URL

API version object contains:

• object - Always returns "api_version"
• name - Version identifier (e.g., "2019-05-29")
• current - Boolean indicating if this is the account's current default version

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

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

api_versions = Omise::Account.api_versions

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

api_versions = omise.Account.api_versions()

Node.js

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

const apiVersions = await omise.account.listApiVersions();

PHP

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

$apiVersions = OmiseAccount::apiVersions();

Java

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

ScopedList<ApiVersion> apiVersions = client.account().apiVersions().list();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var apiVersions = await client.Account.ListApiVersions();

Go

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

apiVersions, _ := client.Account().ListApiVersions()

---

🔑API Credentials

▼

Try it out

Your IP: ...Loading...