Archive a payout address

POST

payments

payout-addresses

{payoutAddressId}

archive

Archive a payout address

const url = 'https://api.openfx.com/v3/payments/payout-addresses/{payoutAddressId}/archive';
const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    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/payout-addresses/{payoutAddressId}/archive"

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

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

print(response.text)

HttpResponse<String> response = Unirest.post("https://api.openfx.com/v3/payments/payout-addresses/{payoutAddressId}/archive")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("X-Request-Signature", "<api-key>")
  .asString();

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_WRITEDATA, stdout);
curl_easy_setopt(hnd, CURLOPT_URL, "https://api.openfx.com/v3/payments/payout-addresses/{payoutAddressId}/archive");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Idempotency-Key: <idempotency-key>");
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/payout-addresses/{payoutAddressId}/archive"

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

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	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))

}

curl --request POST \
  --url https://api.openfx.com/v3/payments/payout-addresses/{payoutAddressId}/archive \
  --header 'Authorization: Bearer <token>' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'X-Request-Signature: <api-key>'

{
  "data": {
    "object": "payoutAddress",
    "id": "pytadd_PbDQ126YUAbkNrNX6XbGL",
    "payoutAddressType": "BANK_ACCOUNT",
    "accountId": "acc_BMY3UenpGBn8ZQ8hio4BgE",
    "bankAccount": {
      "routingFamily": "SEPA",
      "accountHolderName": "Novalia Handels GmbH",
      "accountNumber": "DE89370400440532013000",
      "country": "DE"
    },
    "supportedCurrencies": [
      "EUR"
    ],
    "supportedRails": [
      "SEPA"
    ],
    "status": "ACTIVE",
    "verifications": [
      {
        "kind": "NAME_MATCH",
        "mode": "SEPA_VOP",
        "result": "MATCH",
        "providedName": "Novalia Handels GmbH",
        "registeredName": "Novalia Handels GmbH",
        "createdAt": "2026-06-04T10:30:00.000Z",
        "verifiedAt": "2026-06-04T10:31:20.000Z",
        "expiresAt": null
      }
    ],
    "archivedAt": "2026-07-01T09:05:00.000Z",
    "createdAt": "2026-06-04T10:30:00.000Z",
    "updatedAt": "2026-06-04T10:31:20.000Z"
  }
}

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"

Idempotency-Key

string

required

Unique client-generated key identifying this request.

A request that timed out or failed can be replayed safely under the same key. See Idempotency keys.

Pattern: ^[a-zA-Z0-9_-]{1,255}$

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

Path Parameters

payoutAddressId

string

required

Payout address id.

Pattern: ^pytadd_[1-9A-HJ-NP-Za-km-z]{21,22}$

Response

The archived payout address (archivedAt set).

data

object

required

A registered destination an account can be paid at. Carries bankAccount, the routable identifiers of the destination.

The record is immutable apart from archiving. There is no update operation, so correcting anything on it means creating a replacement and archiving this one.

Show child attributes

⌘I

Archive a payout address

const url = 'https://api.openfx.com/v3/payments/payout-addresses/{payoutAddressId}/archive';
const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    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/payout-addresses/{payoutAddressId}/archive"

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

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

print(response.text)

HttpResponse<String> response = Unirest.post("https://api.openfx.com/v3/payments/payout-addresses/{payoutAddressId}/archive")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("X-Request-Signature", "<api-key>")
  .asString();

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_WRITEDATA, stdout);
curl_easy_setopt(hnd, CURLOPT_URL, "https://api.openfx.com/v3/payments/payout-addresses/{payoutAddressId}/archive");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Idempotency-Key: <idempotency-key>");
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/payout-addresses/{payoutAddressId}/archive"

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

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	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))

}

curl --request POST \
  --url https://api.openfx.com/v3/payments/payout-addresses/{payoutAddressId}/archive \
  --header 'Authorization: Bearer <token>' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'X-Request-Signature: <api-key>'

{
  "data": {
    "object": "payoutAddress",
    "id": "pytadd_PbDQ126YUAbkNrNX6XbGL",
    "payoutAddressType": "BANK_ACCOUNT",
    "accountId": "acc_BMY3UenpGBn8ZQ8hio4BgE",
    "bankAccount": {
      "routingFamily": "SEPA",
      "accountHolderName": "Novalia Handels GmbH",
      "accountNumber": "DE89370400440532013000",
      "country": "DE"
    },
    "supportedCurrencies": [
      "EUR"
    ],
    "supportedRails": [
      "SEPA"
    ],
    "status": "ACTIVE",
    "verifications": [
      {
        "kind": "NAME_MATCH",
        "mode": "SEPA_VOP",
        "result": "MATCH",
        "providedName": "Novalia Handels GmbH",
        "registeredName": "Novalia Handels GmbH",
        "createdAt": "2026-06-04T10:30:00.000Z",
        "verifiedAt": "2026-06-04T10:31:20.000Z",
        "expiresAt": null
      }
    ],
    "archivedAt": "2026-07-01T09:05:00.000Z",
    "createdAt": "2026-06-04T10:30:00.000Z",
    "updatedAt": "2026-06-04T10:31:20.000Z"
  }
}

Core concepts

Endpoints

Webhooks

Archive a payout address

Authorizations

Headers

Path Parameters

Response