> For a complete index of Agora Finance documentation, fetch https://docs.agora.finance/llms.txt

# Get a Route by ID

GET https://api.sandbox.agora.finance/v0/routes/{routeId}

Retrieve a single route by its id, including the full reusable `instructions` block. Route ids are deterministic — the same canonical inputs always derive the same id — so a `404` means no route with those parameters has been created for your organization.


Reference: https://docs.agora.finance/api/endpoints/routes/getbyid

## Authentication

- `Authorization` header (bearer token, required) — Session JWT from `POST /v0/auth/token`, sent as `Authorization: Bearer <sessionJwt>`. See [Authentication](/api/authentication) for more details.

## Request

### Path parameters

- `routeId` (string, required)

## Response

### 200

OK

- `id` (string, required) — Deterministic route UUID; same canonical inputs always derive the same id.
- `createdAt` (datetime, required)
- `direction` (enum, required) — Which of the four flows this route is.
  - Allowed values: `mint-fiat`, `mint-stablecoin`, `redeem-fiat`, `redeem-stablecoin`
- `to` (V0RoutesRouteIdGetResponsesContentApplicationJsonSchemaTo, required)
- `instructions` (list of V0RoutesRouteIdGetResponsesContentApplicationJsonSchemaInstructionsItems, required) — Next-step instructions. Mint-fiat: one wire instruction with memo + beneficiary. On-chain directions: one deposit address per supported chain, alphabetical by chain.
- `name` (string, optional, nullable) — User-set label, or null when unset.

## Errors

### 400 Bad Request Error

One or more request parameters are invalid.

- `code` (enum, required)
  - Allowed values: `parameter_invalid`
- `docs_url` (string, required)
- `message` (string, required)
- `context` (ErrorResponse400ParameterInvalidContext, optional)

### 401 Unauthorized Error

Authentication is required.

- `code` (enum, required)
  - Allowed values: `unauthorized`
- `docs_url` (string, required)
- `message` (string, required)
- `context` (ErrorResponse401UnauthorizedContext, optional)

### 403 Forbidden Error

- `account_not_eligible`: The account is not eligible for this request. - `account_not_provisioned`: The account is not provisioned for this product. - `account_verification_pending`: Account verification for this product is pending. - `forbidden`: Access to this resource is forbidden.

- `code` (enum, required)
  - Allowed values: `account_not_eligible`, `account_not_provisioned`, `account_verification_pending`, `forbidden`
- `docs_url` (string, required)
- `message` (string, required)

### 404 Not Found Error

- `not_found`: Resource not found. - `route_not_found`: Route not found.

- `code` (enum, required)
  - Allowed values: `not_found`, `route_not_found`
- `docs_url` (string, required)
- `message` (string, required)

### 429 Too Many Requests Error

Too many requests.

- `code` (enum, required)
  - Allowed values: `rate_limit_exceeded`
- `docs_url` (string, required)
- `message` (string, required)

### 500 Internal Server Error

An unexpected error occurred.

- `code` (enum, required)
  - Allowed values: `internal_error`
- `docs_url` (string, required)
- `message` (string, required)

## Types

### V0RoutesRouteIdGetResponsesContentApplicationJsonSchemaTo

- `currency` (enum, required) — Currency identifier.
  - Allowed values: `ausd`, `usd`, `ctk`
- `accountId` (string, required)
- `chain` (enum, optional) — Route chain (kebab-case). Restricted to chains Agora supports for routes (EVM + Solana).
  - Allowed values: `avalanche-fuji`, `ethereum-sepolia`

### V0RoutesRouteIdGetResponsesContentApplicationJsonSchemaInstructionsItems

- V0RoutesRouteIdGetResponsesContentApplicationJsonSchemaInstructionsItems0
- V0RoutesRouteIdGetResponsesContentApplicationJsonSchemaInstructionsItems1

### ErrorResponse400ParameterInvalidContext

- `issues` (list of ErrorResponse400ParameterInvalidContextIssuesItems, required)

### ErrorResponse401UnauthorizedContext

- `reason` (enum, required)
  - Allowed values: `invalid_token`, `key_not_provisioned`, `missing_claim`, `missing_header`, `token_expired`, `token_paused`, `token_revoked`, `unknown_tenant`

### V0RoutesRouteIdGetResponsesContentApplicationJsonSchemaInstructionsItems0

- `memo` (string, required) — Memo / reference field that uniquely identifies the route on the inbound wire.
- `beneficiaryName` (string, required)
- `beneficiaryAddress` (string, required)
- `accountNumber` (string, required)
- `bankName` (string, required)
- `bankAddress` (string, required)
- `routingNumber` (string, required)
- `supportedCurrencies` (list of enum, required) — Currencies this wire instruction accepts
  - Allowed values: `ausd`, `usd`, `ctk`
- `swiftCode` (string, optional)

### V0RoutesRouteIdGetResponsesContentApplicationJsonSchemaInstructionsItems1

- `chain` (enum, required) — Route chain (kebab-case). Restricted to chains Agora supports for routes (EVM + Solana).
  - Allowed values: `avalanche-fuji`, `ethereum-sepolia`
- `depositAddress` (string, required)
- `supportedCurrencies` (list of enum, required) — Currencies the deposit address accepts
  - Allowed values: `ausd`, `usd`, `ctk`

### ErrorResponse400ParameterInvalidContextIssuesItems

- `field` (string, required)
- `message` (string, required)

## Examples

**Response**

```json
{
  "id": "5a8e9f12-1b2c-4d3e-9f0a-1b2c3d4e5f6a",
  "createdAt": "2026-05-13T18:00:00Z",
  "to": {
    "currency": "ausd",
    "accountId": "7f3a1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c",
    "chain": "ethereum-sepolia"
  },
  "instructions": [
    {
      "accountNumber": "00000000",
      "bankAddress": "0 Nowhere Street, Example City, XX 00000, SANDBOX",
      "bankName": "SANDBOX TEST BANK, NOT A REAL BANK",
      "beneficiaryAddress": "0 Nowhere Street, Example City, XX 00000, SANDBOX",
      "beneficiaryName": "SANDBOX TEST ACCOUNT, NOT A REAL BENEFICIARY",
      "memo": "eth93e6c8",
      "routingNumber": "000000000",
      "supportedCurrencies": [
        "usd"
      ],
      "swiftCode": "SANDBOX0"
    }
  ],
  "name": "Operating wire → ETH treasury",
  "from": {
    "currency": "usd"
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.sandbox.agora.finance/v0/routes/5a8e9f12-1b2c-4d3e-9f0a-1b2c3d4e5f6a"

headers = {"Authorization": "Bearer <token>"}

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

print(response.json())
```

```javascript
const url = 'https://api.sandbox.agora.finance/v0/routes/5a8e9f12-1b2c-4d3e-9f0a-1b2c3d4e5f6a';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

```go
package main

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

func main() {

	url := "https://api.sandbox.agora.finance/v0/routes/5a8e9f12-1b2c-4d3e-9f0a-1b2c3d4e5f6a"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

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

}
```

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

url = URI("https://api.sandbox.agora.finance/v0/routes/5a8e9f12-1b2c-4d3e-9f0a-1b2c3d4e5f6a")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

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

HttpResponse<String> response = Unirest.get("https://api.sandbox.agora.finance/v0/routes/5a8e9f12-1b2c-4d3e-9f0a-1b2c3d4e5f6a")
  .header("Authorization", "Bearer <token>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.sandbox.agora.finance/v0/routes/5a8e9f12-1b2c-4d3e-9f0a-1b2c3d4e5f6a', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.sandbox.agora.finance/v0/routes/5a8e9f12-1b2c-4d3e-9f0a-1b2c3d4e5f6a");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.sandbox.agora.finance/v0/routes/5a8e9f12-1b2c-4d3e-9f0a-1b2c3d4e5f6a")! 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()
```