List payouts

GET

payments

payouts

List payouts

const url = 'https://api.openfx.com/v3/payments/payouts';
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

url = "https://api.openfx.com/v3/payments/payouts"

headers = {
    "Authorization": "Bearer <token>",
    "X-Request-Signature": "<api-key>"
}

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

print(response.text)

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/payments/payouts");

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/payments/payouts"

	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": "payout",
      "id": "pyt_9P3Gs3GSn4hMdHQ22Evi5f",
      "financialAccountId": "finacc_AmKC5dMVXUbiAW8VzKBfqz",
      "receiver": {
        "accountId": "acc_BMY3UenpGBn8ZQ8hio4BgE",
        "payoutAddressId": "pytadd_PbDQ126YUAbkNrNX6XbGL"
      },
      "rail": "SEPA",
      "sendAmount": "1087.000000",
      "sendCurrency": "USD",
      "receiveAmount": "995.40",
      "receiveCurrency": "EUR",
      "fees": {
        "totalAmount": "5.000000",
        "currency": "USD",
        "components": [
          {
            "type": "NETWORK_FEE",
            "amount": "5.000000",
            "currency": "USD"
          }
        ]
      },
      "fixedSide": "SEND",
      "fxRates": {
        "client": "1.08700",
        "convertedAmount": "1082.000000",
        "expiresAt": "2026-06-04T10:33:00.000Z"
      },
      "status": "PROCESSED",
      "settlementTraceId": {
        "status": "AVAILABLE",
        "key": "END_TO_END_IDENTIFIER",
        "value": "OFX-2026-0604-0001"
      },
      "confirmations": [
        {
          "type": "QUOTE"
        },
        {
          "type": "ACCOUNT_HOLDER_NAME",
          "mode": "SEPA_VOP",
          "result": "MATCH",
          "providedName": "Novalia Handels GmbH",
          "registeredName": "Novalia Handels GmbH",
          "createdAt": "2026-06-04T10:30:04.000Z",
          "verifiedAt": "2026-06-04T10:30:05.000Z",
          "expiresAt": null
        }
      ],
      "failure": null,
      "return": null,
      "createdAt": "2026-06-04T10:30:05.000Z",
      "updatedAt": "2026-06-04T10:32:30.000Z",
      "processedAt": "2026-06-04T10:32:30.000Z"
    }
  ],
  "pagination": {
    "limit": 25,
    "hasNext": false,
    "nextCursor": null,
    "hasPrev": false,
    "prevCursor": null
  }
}

Authorizations

Authorization

string

header

required

ES256 JWT bearer token, minted fresh per request.

See Authentication for the claims, including the nonce, the request signature, the two scopes, and which status means what.

X-Request-Signature

string

header

required

Body-bound ES256 signature over the request, required alongside the bearer token on every call. Base64url of an IEEE P-1363 fixed 64-byte r‖s signature.

See Authentication for the canonical string it signs, including the JWT nonce that binds it to the bearer token.

Headers

X-App-Mode

enum<string>

default:SANDBOX

Which environment this request runs against.

An omitted header means SANDBOX. Send it explicitly on every call rather than relying on that default, so live money movement is never missed because a header was forgotten: a live API key that reaches a live instance without an explicit LIVE value is rejected with AUTH_API_KEY_SANDBOX_REQUIRED. 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"

X-Request-Id

string

Your own correlation id for this request, returned on the response exactly as you sent it.

Optional. Where you send none the response omits it, and the X-Trace-Id response header is the handle to correlate on instead.

Example:

"9f2c1b7e-4d3a-4f81-9c2e-6b0a5d7e1f34"

Query Parameters

limit

integer

default:25

Page size. Default 25, max 100.

See Pagination for the cursors, the order, and the edge cases.

Required range: 1 <= x <= 100

startingAfter

string

Opaque cursor: return the items after it, which is the older page. Mutually exclusive with endingBefore.

endingBefore

string

Opaque cursor: return the items before it, which is the newer page. Mutually exclusive with startingAfter.

Response

A page of payouts.

Cursor-paginated list of payouts; every element is a full Payout, not a summary row. Newest-first by createdAt; see PaginationInfo for cursor semantics.

data

object[]

required

Show child attributes

pagination

object

required

Cursor-based pagination metadata, identical on every list endpoint that returns one.

See Pagination for the cursors, the order, the totals that do not exist, and the edge cases.

Show child attributes

⌘I

List payouts

const url = 'https://api.openfx.com/v3/payments/payouts';
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

url = "https://api.openfx.com/v3/payments/payouts"

headers = {
    "Authorization": "Bearer <token>",
    "X-Request-Signature": "<api-key>"
}

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

print(response.text)

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/payments/payouts");

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/payments/payouts"

	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": "payout",
      "id": "pyt_9P3Gs3GSn4hMdHQ22Evi5f",
      "financialAccountId": "finacc_AmKC5dMVXUbiAW8VzKBfqz",
      "receiver": {
        "accountId": "acc_BMY3UenpGBn8ZQ8hio4BgE",
        "payoutAddressId": "pytadd_PbDQ126YUAbkNrNX6XbGL"
      },
      "rail": "SEPA",
      "sendAmount": "1087.000000",
      "sendCurrency": "USD",
      "receiveAmount": "995.40",
      "receiveCurrency": "EUR",
      "fees": {
        "totalAmount": "5.000000",
        "currency": "USD",
        "components": [
          {
            "type": "NETWORK_FEE",
            "amount": "5.000000",
            "currency": "USD"
          }
        ]
      },
      "fixedSide": "SEND",
      "fxRates": {
        "client": "1.08700",
        "convertedAmount": "1082.000000",
        "expiresAt": "2026-06-04T10:33:00.000Z"
      },
      "status": "PROCESSED",
      "settlementTraceId": {
        "status": "AVAILABLE",
        "key": "END_TO_END_IDENTIFIER",
        "value": "OFX-2026-0604-0001"
      },
      "confirmations": [
        {
          "type": "QUOTE"
        },
        {
          "type": "ACCOUNT_HOLDER_NAME",
          "mode": "SEPA_VOP",
          "result": "MATCH",
          "providedName": "Novalia Handels GmbH",
          "registeredName": "Novalia Handels GmbH",
          "createdAt": "2026-06-04T10:30:04.000Z",
          "verifiedAt": "2026-06-04T10:30:05.000Z",
          "expiresAt": null
        }
      ],
      "failure": null,
      "return": null,
      "createdAt": "2026-06-04T10:30:05.000Z",
      "updatedAt": "2026-06-04T10:32:30.000Z",
      "processedAt": "2026-06-04T10:32:30.000Z"
    }
  ],
  "pagination": {
    "limit": 25,
    "hasNext": false,
    "nextCursor": null,
    "hasPrev": false,
    "prevCursor": null
  }
}

Core concepts

Endpoints

Webhooks

Authorizations

Headers

Query Parameters

Response