Retrieve a deposit - OpenFX

GET

/

v3

/

fx

/

deposits

/

{id}

Node.js

const url = 'https://api.openfx.com/v3/fx/deposits/{id}';
const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'X-Request-Signature': '<api-key>'}
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests
# sign_request mints a fresh 60s JWT AND the matching X-Request-Signature. See Authentication
deposit_id = 'dpt_EA9vbVngB76PmMibCiMNPb'
url = f'https://api.openfx.com/v3/fx/deposits/{deposit_id}'
headers, _ = sign_request('GET', url, b'')
deposit = requests.get(url, headers=headers).json()

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_WRITEDATA, stdout);
curl_easy_setopt(hnd, CURLOPT_URL, "https://api.openfx.com/v3/fx/deposits/{id}");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer <token>");
headers = curl_slist_append(headers, "X-Request-Signature: <api-key>");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

package main

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

func main() {

	url := "https://api.openfx.com/v3/fx/deposits/{id}"

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("X-Request-Signature", "<api-key>")

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

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

	fmt.Println(string(body))

}

{
  "data": {
    "object": "deposit",
    "id": "dpt_EA9vbVngB76PmMibCiMNPb",
    "currency": "USD",
    "assetType": "FIAT",
    "depositAmount": "10000.00",
    "status": "COMPLETED",
    "network": null,
    "transactionHash": null,
    "referenceId": "Deposit from XYZ",
    "memo": null,
    "paymentDetails": {
      "FEDWIRE": {
        "imad": "20260428B1QGC07C001234",
        "omad": "20260428L1B7012C003456"
      }
    },
    "createdAt": "2026-04-28T09:50:00.000Z"
  }
}

Authorizations

Authorization

string

header

required

ES256-signed JWT bearer token, single-use, 60-second TTL. See Authentication for how to mint one.

X-Request-Signature

string

header

required

ES256 signature over the request, bound to the bearer JWT. Required on every request. See Authentication → Request signing.

Headers

X-Request-Id

string

Optional, client-supplied correlation ID for this request. Echoed verbatim on the response when supplied; the response omits it when the request did not supply one. Distinct from X-Trace-Id (server-generated, always present). See Metadata & tracing.

Example:

"my-req-abc-123"

X-App-Mode

enum<string>

default:SANDBOX

Environment selector, matching the API key's bound environment. Defaults to SANDBOX when omitted. See Environments. When present, the value must be SANDBOX or LIVE, matched without regard to case. Any other value, including an empty one, returns 400 INVALID_APP_MODE; details.received echoes the value you sent.

Available options:

SANDBOX,

LIVE

Example:

"SANDBOX"

Path Parameters

id

string

required

Deposit ID. Accepts an ID in either of two forms: the current readable, typed-prefix ID (see ResourceId), for example tde_5W7guYdHT24JFnRQrZN9y8, or a legacy bare UUID, for example 550e8400-e29b-41d4-a716-446655440000, kept for backward compatibility with IDs persisted before v3 introduced readable IDs. Both forms resolve to the same underlying record. Responses always return the readable form — see Resource IDs.

Pattern: ^([a-z]{3,5}_[1-9A-HJ-NP-Za-km-z]{1,22}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$

Example:

"tde_5W7guYdHT24JFnRQrZN9y8"

Response

The deposit.

data

object

required

A deposit into your trade account.

Show child attributes

⌘I

Node.js

const url = 'https://api.openfx.com/v3/fx/deposits/{id}';
const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'X-Request-Signature': '<api-key>'}
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests
# sign_request mints a fresh 60s JWT AND the matching X-Request-Signature. See Authentication
deposit_id = 'dpt_EA9vbVngB76PmMibCiMNPb'
url = f'https://api.openfx.com/v3/fx/deposits/{deposit_id}'
headers, _ = sign_request('GET', url, b'')
deposit = requests.get(url, headers=headers).json()

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_WRITEDATA, stdout);
curl_easy_setopt(hnd, CURLOPT_URL, "https://api.openfx.com/v3/fx/deposits/{id}");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer <token>");
headers = curl_slist_append(headers, "X-Request-Signature: <api-key>");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

package main

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

func main() {

	url := "https://api.openfx.com/v3/fx/deposits/{id}"

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("X-Request-Signature", "<api-key>")

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

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

	fmt.Println(string(body))

}

{
  "data": {
    "object": "deposit",
    "id": "dpt_EA9vbVngB76PmMibCiMNPb",
    "currency": "USD",
    "assetType": "FIAT",
    "depositAmount": "10000.00",
    "status": "COMPLETED",
    "network": null,
    "transactionHash": null,
    "referenceId": "Deposit from XYZ",
    "memo": null,
    "paymentDetails": {
      "FEDWIRE": {
        "imad": "20260428B1QGC07C001234",
        "omad": "20260428L1B7012C003456"
      }
    },
    "createdAt": "2026-04-28T09:50:00.000Z"
  }
}