> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://ixopay.ferndocs.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://ixopay.ferndocs.com/_mcp/server.

# Retrieve options list

POST https://gateway.ixopay.com/api/v3/options/{apiKey}/{optionsName}
Content-Type: application/json

Retrieve an options list based on a given option name.

Reference: https://ixopay.ferndocs.com/developer-hub/api-reference/transaction-api/options

## Request

### Path parameters

- `apiKey` (string, required) — API Key of Connector
- `optionsName` (string, required) — Options identifier of the appropriate adapter

### Body (application/json)

This endpoint expects an OptionsRequest.

- `parameters` (OptionsRequestParameters, optional)

## Response

### 200

Options response

- `success` (boolean, optional)
- `options` (list of OptionsResponseOptionsItems, optional)
- `error` (string, optional)

## Types

### OptionsRequestParameters

### OptionsResponseOptionsItems

- `key` (string, optional)
- `value` (string, optional)

## Examples

### success

**Response**

```json
{
  "success": true,
  "options": [
    {}
  ]
}
```

**SDK Code**

```python success
import requests

url = "https://gateway.ixopay.com/api/v3/options/apiKey/optionsName"

response = requests.post(url)

print(response.json())
```

```javascript success
const url = 'https://gateway.ixopay.com/api/v3/options/apiKey/optionsName';
const options = {method: 'POST'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go success
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://gateway.ixopay.com/api/v3/options/apiKey/optionsName"

	req, _ := http.NewRequest("POST", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby success
require 'uri'
require 'net/http'

url = URI("https://gateway.ixopay.com/api/v3/options/apiKey/optionsName")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
```

```java success
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://gateway.ixopay.com/api/v3/options/apiKey/optionsName")
  .asString();
```

```php success
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://gateway.ixopay.com/api/v3/options/apiKey/optionsName');

echo $response->getBody();
```

```csharp success
using RestSharp;

var client = new RestClient("https://gateway.ixopay.com/api/v3/options/apiKey/optionsName");
var request = new RestRequest(Method.POST);
IRestResponse response = client.Execute(request);
```

```swift success
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://gateway.ixopay.com/api/v3/options/apiKey/optionsName")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### error

**Response**

```json
{
  "success": false
}
```

**SDK Code**

```python error
import requests

url = "https://gateway.ixopay.com/api/v3/options/apiKey/optionsName"

response = requests.post(url)

print(response.json())
```

```javascript error
const url = 'https://gateway.ixopay.com/api/v3/options/apiKey/optionsName';
const options = {method: 'POST'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go error
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://gateway.ixopay.com/api/v3/options/apiKey/optionsName"

	req, _ := http.NewRequest("POST", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby error
require 'uri'
require 'net/http'

url = URI("https://gateway.ixopay.com/api/v3/options/apiKey/optionsName")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
```

```java error
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://gateway.ixopay.com/api/v3/options/apiKey/optionsName")
  .asString();
```

```php error
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://gateway.ixopay.com/api/v3/options/apiKey/optionsName');

echo $response->getBody();
```

```csharp error
using RestSharp;

var client = new RestClient("https://gateway.ixopay.com/api/v3/options/apiKey/optionsName");
var request = new RestRequest(Method.POST);
IRestResponse response = client.Execute(request);
```

```swift error
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://gateway.ixopay.com/api/v3/options/apiKey/optionsName")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### options_example

**Request**

```json
{
  "parameters": {
    "firstParam": "firstValue",
    "secondParam": "secondValue"
  }
}
```

**Response**

```json
{
  "success": true,
  "options": [
    {}
  ]
}
```

**SDK Code**

```python options_example
import requests

url = "https://gateway.ixopay.com/api/v3/options/apiKey/optionsName"

payload = { "parameters": {
        "firstParam": "firstValue",
        "secondParam": "secondValue"
    } }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript options_example
const url = 'https://gateway.ixopay.com/api/v3/options/apiKey/optionsName';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"parameters":{"firstParam":"firstValue","secondParam":"secondValue"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go options_example
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://gateway.ixopay.com/api/v3/options/apiKey/optionsName"

	payload := strings.NewReader("{\n  \"parameters\": {\n    \"firstParam\": \"firstValue\",\n    \"secondParam\": \"secondValue\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby options_example
require 'uri'
require 'net/http'

url = URI("https://gateway.ixopay.com/api/v3/options/apiKey/optionsName")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"parameters\": {\n    \"firstParam\": \"firstValue\",\n    \"secondParam\": \"secondValue\"\n  }\n}"

response = http.request(request)
puts response.read_body
```

```java options_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://gateway.ixopay.com/api/v3/options/apiKey/optionsName")
  .header("Content-Type", "application/json")
  .body("{\n  \"parameters\": {\n    \"firstParam\": \"firstValue\",\n    \"secondParam\": \"secondValue\"\n  }\n}")
  .asString();
```

```php options_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://gateway.ixopay.com/api/v3/options/apiKey/optionsName', [
  'body' => '{
  "parameters": {
    "firstParam": "firstValue",
    "secondParam": "secondValue"
  }
}',
  'headers' => [
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp options_example
using RestSharp;

var client = new RestClient("https://gateway.ixopay.com/api/v3/options/apiKey/optionsName");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"parameters\": {\n    \"firstParam\": \"firstValue\",\n    \"secondParam\": \"secondValue\"\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift options_example
import Foundation

let headers = ["Content-Type": "application/json"]
let parameters = ["parameters": [
    "firstParam": "firstValue",
    "secondParam": "secondValue"
  ]] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://gateway.ixopay.com/api/v3/options/apiKey/optionsName")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```