curl

curl -X GET "https://api.services.payward.com/v1/accounts/ABCD1234EFGH5678/portfolio/transactions" \
  -H "API-Key: $PWS_API_KEY" \
  -H "API-Nonce: $PWS_API_NONCE" \
  -H "API-Sign: $PWS_API_SIGN"

import requests

url = "https://api.services.payward.com/v1/accounts/{account_id}/portfolio/transactions"

headers = {
    "API-Key": "<api-key>",
    "API-Sign": "<api-key>",
    "API-Nonce": "<api-key>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {'API-Key': '<api-key>', 'API-Sign': '<api-key>', 'API-Nonce': '<api-key>'}
};

fetch('https://api.services.payward.com/v1/accounts/{account_id}/portfolio/transactions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.services.payward.com/v1/accounts/{account_id}/portfolio/transactions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "API-Key: <api-key>",
    "API-Nonce: <api-key>",
    "API-Sign: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.services.payward.com/v1/accounts/{account_id}/portfolio/transactions"

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

	req.Header.Add("API-Key", "<api-key>")
	req.Header.Add("API-Sign", "<api-key>")
	req.Header.Add("API-Nonce", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.services.payward.com/v1/accounts/{account_id}/portfolio/transactions")
  .header("API-Key", "<api-key>")
  .header("API-Sign", "<api-key>")
  .header("API-Nonce", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.services.payward.com/v1/accounts/{account_id}/portfolio/transactions")

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

request = Net::HTTP::Get.new(url)
request["API-Key"] = '<api-key>'
request["API-Sign"] = '<api-key>'
request["API-Nonce"] = '<api-key>'

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

{
  "data": [
    {
      "id": "tx_01J0M7C0Z9F8YX3GQH8E",
      "timestamp": "2026-04-15T13:42:18.000Z",
      "type": "swap",
      "status": "successful",
      "spend": {
        "timestamp": "2026-04-15T13:42:18.500Z",
        "sub_total": {
          "symbol": "USD",
          "name": "US Dollar",
          "type": "fiat",
          "amount": "1000.00",
          "amount_in_quote": "1000.00"
        },
        "fee": {
          "symbol": "USD",
          "name": "US Dollar",
          "type": "fiat",
          "amount": "5.00",
          "amount_in_quote": "5.00"
        },
        "total": {
          "symbol": "USD",
          "name": "US Dollar",
          "type": "fiat",
          "amount": "1005.00",
          "amount_in_quote": "1005.00"
        },
        "balance": {
          "symbol": "USD",
          "name": "US Dollar",
          "type": "fiat",
          "amount": "4995.00",
          "amount_in_quote": "4995.00"
        }
      },
      "receive": {
        "timestamp": "2026-04-15T13:42:18.500Z",
        "sub_total": {
          "symbol": "BTC",
          "name": "Bitcoin",
          "type": "crypto",
          "amount": "0.01587302",
          "amount_in_quote": "1000.00"
        },
        "fee": {
          "symbol": "BTC",
          "name": "Bitcoin",
          "type": "crypto",
          "amount": "0",
          "amount_in_quote": "0"
        },
        "total": {
          "symbol": "BTC",
          "name": "Bitcoin",
          "type": "crypto",
          "amount": "0.01587302",
          "amount_in_quote": "1000.00"
        },
        "balance": {
          "symbol": "BTC",
          "name": "Bitcoin",
          "type": "crypto",
          "amount": "0.51587302",
          "amount_in_quote": "32500.00"
        }
      }
    },
    {
      "id": "tx_01J0M7C0Z9F8YX3GQH8G",
      "timestamp": "2026-04-13T00:00:00.000Z",
      "type": "earn_reward",
      "status": "successful",
      "receive": {
        "timestamp": "2026-04-13T00:00:00.000Z",
        "sub_total": {
          "symbol": "ETH",
          "name": "Ethereum",
          "type": "crypto",
          "amount": "0.00125",
          "amount_in_quote": "4.50"
        },
        "fee": {
          "symbol": "ETH",
          "name": "Ethereum",
          "type": "crypto",
          "amount": "0",
          "amount_in_quote": "0"
        },
        "total": {
          "symbol": "ETH",
          "name": "Ethereum",
          "type": "crypto",
          "amount": "0.00125",
          "amount_in_quote": "4.50"
        },
        "balance": {
          "symbol": "ETH",
          "name": "Ethereum",
          "type": "crypto",
          "amount": "2.50125",
          "amount_in_quote": "9004.50"
        }
      }
    }
  ],
  "next_page_token": "cursor_eyJrIjoxfQ",
  "quote_symbol": "USD",
  "quote_type": "fiat"
}

{
  "error": {
    "type": "<string>",
    "status": 400,
    "instance": "<string>",
    "code": "bad_request",
    "doc_url": "<string>",
    "causes": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 401,
    "instance": "<string>",
    "code": "unauthenticated",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 403,
    "instance": "<string>",
    "code": "forbidden",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 429,
    "instance": "<string>",
    "code": "resource_exhausted",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 500,
    "instance": "<string>",
    "code": "internal",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 501,
    "instance": "<string>",
    "code": "unimplemented",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 503,
    "instance": "<string>",
    "code": "unavailable",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 504,
    "instance": "<string>",
    "code": "deadline_exceeded",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

Portfolio

List Portfolio Transactions

Lists account portfolio transactions with optional filters for type, asset, status, transaction ID, originating reference, time range, and sort direction. Results are cursor-paginated. Results are ordered newest first by default; set sort_direction=asc for oldest first. Page tokens are valid for up to 24 hours.

Transactions can appear asynchronously. To discover new activity, poll this operation with the applicable types filters and an appropriate time range, omitting statuses or including in_progress while a transaction is being processed. For a transfer created by POST /v1/transfers, use types=transfer and the from account from the create request. The transfer_id returned by create is the id in a reference with kind=transfer. Once the transaction appears, that reference can be submitted in references for deterministic subsequent lookup. A transfer may appear with status=in_progress before it reaches the terminal successful or failed status; filtering only by successful can therefore hide a newly materialized transfer. The first Portfolio response after POST /v1/transfers may contain no matching transaction even when the create response has status=complete; continue polling until the transaction is present.

A deposit address is not a funding reference: the address together with any required tag or memo describes the payment destination and is not accepted by references. The returned transaction id uses the TX namespace and is distinct from the reference identifier.

GET

accounts

{account_id}

portfolio

transactions

curl

curl -X GET "https://api.services.payward.com/v1/accounts/ABCD1234EFGH5678/portfolio/transactions" \
  -H "API-Key: $PWS_API_KEY" \
  -H "API-Nonce: $PWS_API_NONCE" \
  -H "API-Sign: $PWS_API_SIGN"

import requests

url = "https://api.services.payward.com/v1/accounts/{account_id}/portfolio/transactions"

headers = {
    "API-Key": "<api-key>",
    "API-Sign": "<api-key>",
    "API-Nonce": "<api-key>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {'API-Key': '<api-key>', 'API-Sign': '<api-key>', 'API-Nonce': '<api-key>'}
};

fetch('https://api.services.payward.com/v1/accounts/{account_id}/portfolio/transactions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.services.payward.com/v1/accounts/{account_id}/portfolio/transactions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "API-Key: <api-key>",
    "API-Nonce: <api-key>",
    "API-Sign: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.services.payward.com/v1/accounts/{account_id}/portfolio/transactions"

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

	req.Header.Add("API-Key", "<api-key>")
	req.Header.Add("API-Sign", "<api-key>")
	req.Header.Add("API-Nonce", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.services.payward.com/v1/accounts/{account_id}/portfolio/transactions")
  .header("API-Key", "<api-key>")
  .header("API-Sign", "<api-key>")
  .header("API-Nonce", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.services.payward.com/v1/accounts/{account_id}/portfolio/transactions")

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

request = Net::HTTP::Get.new(url)
request["API-Key"] = '<api-key>'
request["API-Sign"] = '<api-key>'
request["API-Nonce"] = '<api-key>'

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

{
  "data": [
    {
      "id": "tx_01J0M7C0Z9F8YX3GQH8E",
      "timestamp": "2026-04-15T13:42:18.000Z",
      "type": "swap",
      "status": "successful",
      "spend": {
        "timestamp": "2026-04-15T13:42:18.500Z",
        "sub_total": {
          "symbol": "USD",
          "name": "US Dollar",
          "type": "fiat",
          "amount": "1000.00",
          "amount_in_quote": "1000.00"
        },
        "fee": {
          "symbol": "USD",
          "name": "US Dollar",
          "type": "fiat",
          "amount": "5.00",
          "amount_in_quote": "5.00"
        },
        "total": {
          "symbol": "USD",
          "name": "US Dollar",
          "type": "fiat",
          "amount": "1005.00",
          "amount_in_quote": "1005.00"
        },
        "balance": {
          "symbol": "USD",
          "name": "US Dollar",
          "type": "fiat",
          "amount": "4995.00",
          "amount_in_quote": "4995.00"
        }
      },
      "receive": {
        "timestamp": "2026-04-15T13:42:18.500Z",
        "sub_total": {
          "symbol": "BTC",
          "name": "Bitcoin",
          "type": "crypto",
          "amount": "0.01587302",
          "amount_in_quote": "1000.00"
        },
        "fee": {
          "symbol": "BTC",
          "name": "Bitcoin",
          "type": "crypto",
          "amount": "0",
          "amount_in_quote": "0"
        },
        "total": {
          "symbol": "BTC",
          "name": "Bitcoin",
          "type": "crypto",
          "amount": "0.01587302",
          "amount_in_quote": "1000.00"
        },
        "balance": {
          "symbol": "BTC",
          "name": "Bitcoin",
          "type": "crypto",
          "amount": "0.51587302",
          "amount_in_quote": "32500.00"
        }
      }
    },
    {
      "id": "tx_01J0M7C0Z9F8YX3GQH8G",
      "timestamp": "2026-04-13T00:00:00.000Z",
      "type": "earn_reward",
      "status": "successful",
      "receive": {
        "timestamp": "2026-04-13T00:00:00.000Z",
        "sub_total": {
          "symbol": "ETH",
          "name": "Ethereum",
          "type": "crypto",
          "amount": "0.00125",
          "amount_in_quote": "4.50"
        },
        "fee": {
          "symbol": "ETH",
          "name": "Ethereum",
          "type": "crypto",
          "amount": "0",
          "amount_in_quote": "0"
        },
        "total": {
          "symbol": "ETH",
          "name": "Ethereum",
          "type": "crypto",
          "amount": "0.00125",
          "amount_in_quote": "4.50"
        },
        "balance": {
          "symbol": "ETH",
          "name": "Ethereum",
          "type": "crypto",
          "amount": "2.50125",
          "amount_in_quote": "9004.50"
        }
      }
    }
  ],
  "next_page_token": "cursor_eyJrIjoxfQ",
  "quote_symbol": "USD",
  "quote_type": "fiat"
}

{
  "error": {
    "type": "<string>",
    "status": 400,
    "instance": "<string>",
    "code": "bad_request",
    "doc_url": "<string>",
    "causes": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 401,
    "instance": "<string>",
    "code": "unauthenticated",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 403,
    "instance": "<string>",
    "code": "forbidden",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 429,
    "instance": "<string>",
    "code": "resource_exhausted",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 500,
    "instance": "<string>",
    "code": "internal",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 501,
    "instance": "<string>",
    "code": "unimplemented",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 503,
    "instance": "<string>",
    "code": "unavailable",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

{
  "error": {
    "type": "<string>",
    "status": 504,
    "instance": "<string>",
    "code": "deadline_exceeded",
    "doc_url": "<string>",
    "causes": [
      {}
    ]
  }
}

Authorizations

API-Key

string

header

required

Your public API key. Identifies the partner making the request.

API-Sign

string

header

required

HMAC signature over the request, computed with your private key.

API-Nonce

string

header

required

Monotonically increasing nonce included in the request signature.

Path Parameters

account_id

string

required

ID of the account the request applies to. This refers to one of the accounts held by the user the request is acting on behalf of (typically the user's main account, but any of the user's accounts is accepted). Routes the request to that specific account container. Canonical identifier for an account in the Payward public API.

Required string length: 14 - 42

Query Parameters

page_token

string | null

Opaque page token returned by a previous response's next_page_token. Omit to start from the beginning.

Required string length: 1 - 256

types

enum<string>[] | null

Filter by portfolio transaction type.

Available options:

swap,

price_trigger_swap,

earn_reward,

deposit,

withdrawal,

transfer

page_size

integer<uint64> | null

default:20

Number of transactions to return per page. Defaults to 20 if not specified. Maximum 25.

Required range: 1 <= x <= 25

assets

object[] | null

Filter transactions by specific assets. Each entry is an asset reference with symbol and type. Encode using indexed deep-object syntax, e.g. ?assets[0][symbol]=BTC&assets[0][type]=crypto&assets[1][symbol]=USDT&assets[1][type]=stablecoin.

Show child attributes

start_timestamp

string<date-time> | null

Start of the time window (inclusive). Only results whose timestamp is greater than or equal to start_timestamp are returned.

end_timestamp

string<date-time> | null

End of the time window (inclusive). Only results whose timestamp is less than or equal to end_timestamp are returned.

statuses

enum<string>[] | null

Filter transactions by their status

Filter criteria for transaction status in query results.

Available options:

in_progress,

successful,

failed,

no_status,

uncategorized

ids

string[] | null

Filter transactions by specific transaction IDs

A unique identifier for a portfolio transaction.

sort_direction

enum<string> | null

default:desc

Direction of the sort. Use asc for ascending order (oldest first); desc for the inverse.

Available options:

asc,

desc

quote_symbol

string | null

default:USD

Asset to use for quoting amounts and fees in the response. Defaults to USD. Quoting is best-effort based on rates at transaction time. If quoting is unavailable, quoted fields will be null.

Maximum string length: 16

quote_type

enum<string> | null

default:fiat

Classification of the quote asset. Supports fiat and stablecoin.

Available options:

fiat,

stablecoin

references

object[]

Filter by originating references. Entries are ORed together and combined with types and other filters using AND semantics. Reference kind selects the originating system namespace. For a transfer, use kind=transfer and the transfer_id returned by POST /v1/transfers. Reference identifiers are distinct from the TX identifiers accepted by ids.

Show child attributes

Response

data

object[]

required

List of portfolio transactions matching the query parameters

Show child attributes

quote_symbol

string

required

The asset used as the quote currency for all amount_in_quote fields. Echoes the quote_symbol query parameter or its default.

Maximum string length: 16

quote_type

enum<string>

required

Classification of the quote asset. Echoes the quote_type query parameter or its default.

Available options:

fiat,

stablecoin

next_page_token

string

Opaque token for the next page of results. Absent when there are no more pages.

Required string length: 1 - 256

⌘I