> For a complete page index, fetch https://docs.transak.com/llms.txt

# Transaction Request Status API

GET https://api-gateway-stg.transak.com/api/v2/transaction-session/request/{requestId}

Returns the composite status for a transaction-session request.

Reference: https://docs.transak.com/api/whitelabel/payments/headless-apple-pay/transaction-request-status-api

## Request

### Path parameters

- `requestId` (string, required)

### Headers

- `x-user-ip` (string, required) — End user's originating IP. More details [here](/guides/mandatory-security-changes#user-ip-header-in-apis)
- `x-api-key` (string, required) — Your Partner API key. You can find this in the [Partner Dashboard](https://docs.transak.com/guides/how-to-create-partner-dashboard-account#open-the-developers-section).
- `x-access-token` (string, required) — Your Partner Access Token. Please refer [here](/guides/how-to-create-partner-access-token) for a tutorial on generating your access token.

## Response

### 200

Success

- `data` (TransactionSessionRequestStatusResponseData, required)

## Errors

### 404 Not Found Error

Request ID Not Found

- `error` (ApiErrorBodyError, required)

## Types

### TransactionSessionRequestStatusResponseData

- `status` (string, required) — One of FAILED, IN_PROGRESS, COMPLETED.
- `orderId` (string, optional)
- `reason` (string, optional) — Failure reason when status is FAILED.

### ApiErrorBodyError

- `statusCode` (integer, required)
- `message` (string, required)
- `errorCode` (integer, optional) — Machine-readable error code for client handling.

## Examples

### Request processed

**Response**

```json
{
  "data": {
    "status": "COMPLETED",
    "orderId": "e053ef3e-2b89-4fa6-9679-89f31fe39625"
  }
}
```

**SDK Code**

```python Request processed
import requests

url = "https://api-gateway-stg.transak.com/api/v2/transaction-session/request/:requestId"

headers = {
    "x-access-token": "",
    "x-api-key": "",
    "x-user-ip": ""
}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript Request processed
const url = 'https://api-gateway-stg.transak.com/api/v2/transaction-session/request/:requestId';
const options = {
  method: 'GET',
  headers: {'x-access-token': '', 'x-api-key': '', 'x-user-ip': ''}
};

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

```go Request processed
package main

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

func main() {

	url := "https://api-gateway-stg.transak.com/api/v2/transaction-session/request/:requestId"

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

	req.Header.Add("x-access-token", "")
	req.Header.Add("x-api-key", "")
	req.Header.Add("x-user-ip", "")

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

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

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

}
```

```ruby Request processed
require 'uri'
require 'net/http'

url = URI("https://api-gateway-stg.transak.com/api/v2/transaction-session/request/:requestId")

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

request = Net::HTTP::Get.new(url)
request["x-access-token"] = ''
request["x-api-key"] = ''
request["x-user-ip"] = ''

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

```java Request processed
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api-gateway-stg.transak.com/api/v2/transaction-session/request/:requestId")
  .header("x-access-token", "")
  .header("x-api-key", "")
  .header("x-user-ip", "")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api-gateway-stg.transak.com/api/v2/transaction-session/request/:requestId', [
  'headers' => [
    'x-access-token' => '',
    'x-api-key' => '',
    'x-user-ip' => '',
  ],
]);

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

```csharp Request processed
using RestSharp;

var client = new RestClient("https://api-gateway-stg.transak.com/api/v2/transaction-session/request/:requestId");
var request = new RestRequest(Method.GET);
request.AddHeader("x-access-token", "");
request.AddHeader("x-api-key", "");
request.AddHeader("x-user-ip", "");
IRestResponse response = client.Execute(request);
```

```swift Request processed
import Foundation

let headers = [
  "x-access-token": "",
  "x-api-key": "",
  "x-user-ip": ""
]

let request = NSMutableURLRequest(url: NSURL(string: "https://api-gateway-stg.transak.com/api/v2/transaction-session/request/:requestId")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

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()
```

### Request in progress

**Response**

```json
{
  "data": {
    "status": "IN_PROGRESS",
    "orderId": "e053ef3e-2b89-4fa6-9679-89f31fe39625"
  }
}
```

**SDK Code**

```python Request in progress
import requests

url = "https://api-gateway-stg.transak.com/api/v2/transaction-session/request/:requestId"

headers = {
    "x-access-token": "",
    "x-api-key": "",
    "x-user-ip": ""
}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript Request in progress
const url = 'https://api-gateway-stg.transak.com/api/v2/transaction-session/request/:requestId';
const options = {
  method: 'GET',
  headers: {'x-access-token': '', 'x-api-key': '', 'x-user-ip': ''}
};

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

```go Request in progress
package main

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

func main() {

	url := "https://api-gateway-stg.transak.com/api/v2/transaction-session/request/:requestId"

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

	req.Header.Add("x-access-token", "")
	req.Header.Add("x-api-key", "")
	req.Header.Add("x-user-ip", "")

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

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

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

}
```

```ruby Request in progress
require 'uri'
require 'net/http'

url = URI("https://api-gateway-stg.transak.com/api/v2/transaction-session/request/:requestId")

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

request = Net::HTTP::Get.new(url)
request["x-access-token"] = ''
request["x-api-key"] = ''
request["x-user-ip"] = ''

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

```java Request in progress
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api-gateway-stg.transak.com/api/v2/transaction-session/request/:requestId")
  .header("x-access-token", "")
  .header("x-api-key", "")
  .header("x-user-ip", "")
  .asString();
```

```php Request in progress
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api-gateway-stg.transak.com/api/v2/transaction-session/request/:requestId', [
  'headers' => [
    'x-access-token' => '',
    'x-api-key' => '',
    'x-user-ip' => '',
  ],
]);

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

```csharp Request in progress
using RestSharp;

var client = new RestClient("https://api-gateway-stg.transak.com/api/v2/transaction-session/request/:requestId");
var request = new RestRequest(Method.GET);
request.AddHeader("x-access-token", "");
request.AddHeader("x-api-key", "");
request.AddHeader("x-user-ip", "");
IRestResponse response = client.Execute(request);
```

```swift Request in progress
import Foundation

let headers = [
  "x-access-token": "",
  "x-api-key": "",
  "x-user-ip": ""
]

let request = NSMutableURLRequest(url: NSURL(string: "https://api-gateway-stg.transak.com/api/v2/transaction-session/request/:requestId")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

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()
```

### Request failed

**Response**

```json
{
  "data": {
    "status": "FAILED",
    "reason": "User KYC is not approved."
  }
}
```

**SDK Code**

```python Request failed
import requests

url = "https://api-gateway-stg.transak.com/api/v2/transaction-session/request/:requestId"

headers = {
    "x-access-token": "",
    "x-api-key": "",
    "x-user-ip": ""
}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript Request failed
const url = 'https://api-gateway-stg.transak.com/api/v2/transaction-session/request/:requestId';
const options = {
  method: 'GET',
  headers: {'x-access-token': '', 'x-api-key': '', 'x-user-ip': ''}
};

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

```go Request failed
package main

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

func main() {

	url := "https://api-gateway-stg.transak.com/api/v2/transaction-session/request/:requestId"

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

	req.Header.Add("x-access-token", "")
	req.Header.Add("x-api-key", "")
	req.Header.Add("x-user-ip", "")

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

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

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

}
```

```ruby Request failed
require 'uri'
require 'net/http'

url = URI("https://api-gateway-stg.transak.com/api/v2/transaction-session/request/:requestId")

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

request = Net::HTTP::Get.new(url)
request["x-access-token"] = ''
request["x-api-key"] = ''
request["x-user-ip"] = ''

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

```java Request failed
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api-gateway-stg.transak.com/api/v2/transaction-session/request/:requestId")
  .header("x-access-token", "")
  .header("x-api-key", "")
  .header("x-user-ip", "")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api-gateway-stg.transak.com/api/v2/transaction-session/request/:requestId', [
  'headers' => [
    'x-access-token' => '',
    'x-api-key' => '',
    'x-user-ip' => '',
  ],
]);

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

```csharp Request failed
using RestSharp;

var client = new RestClient("https://api-gateway-stg.transak.com/api/v2/transaction-session/request/:requestId");
var request = new RestRequest(Method.GET);
request.AddHeader("x-access-token", "");
request.AddHeader("x-api-key", "");
request.AddHeader("x-user-ip", "");
IRestResponse response = client.Execute(request);
```

```swift Request failed
import Foundation

let headers = [
  "x-access-token": "",
  "x-api-key": "",
  "x-user-ip": ""
]

let request = NSMutableURLRequest(url: NSURL(string: "https://api-gateway-stg.transak.com/api/v2/transaction-session/request/:requestId")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

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()
```