List Transactions

This endpoint enables you to fetch a list of Settlement Transactions that you have created (own the source_profile_id) or have been alleged against you (own the target_profile_id). You can use query parameters to filter the results returned by statuses, source_profile_id and target_profile_id.

Note that this endpoint supports pagination and returns a cursor token for fetching next pages.

GET /settlement/transactions

List Transactions

cURL

curl --request GET \
  --url https://api.paxos.com/v2/settlement/transactions \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "id": "d99a03ee-6b88-4362-89da-087c2c8cd4a7",
    "ref_id": "d840cf31-352f-4190-a476-7522bf3eafda",
    "settlement_window_start": "2023-08-25T14:25:41.648486573Z",
    "settlement_window_end": "2023-08-25T14:25:41.648486953Z",
    "source_profile_id": "4fd025ab-f29f-47e6-a02e-df90a61c7ec9",
    "target_profile_id": "47db6271-50d6-4934-8c81-c42d87bfb390",
    "legs": [
      {
        "id": "ace21517-447e-4764-8733-765cb12a7fab",
        "direction": "DELIVER",
        "asset": "BTC",
        "amount": "100"
      }
    ],
    "status": "PENDING",
    "created_at": "2023-08-25T14:25:41.648489333Z",
    "updated_at": "2023-08-25T14:25:41.648489493Z"
  },
  {
    "id": "738b465a-7bea-42cf-be8d-63572f5745e7",
    "ref_id": "8f1dcf84-56e7-4e84-80aa-f01ef2eb1ab0",
    "settlement_window_start": "2023-08-26T00:25:41.648486573Z",
    "settlement_window_end": "2023-08-29T19:25:41.648486953Z",
    "source_profile_id": "4fd025ab-f29f-47e6-a02e-df90a61c7ec9",
    "target_profile_id": "47db6271-50d6-4934-8c81-c42d87bfb390",
    "legs": [
      {
        "id": "ace21517-447e-4764-8733-765cb12a7fab",
        "direction": "RECEIVE",
        "asset": "ETH",
        "amount": "39.231"
      }
    ],
    "status": "PENDING",
    "created_at": "2023-08-24T18:29:41.648489333Z",
    "updated_at": "2023-08-24T18:29:41.648489493Z"
  }
]

OAuth Scope

settlement:read_transaction

Authorizations

Authorization · string · header · required

Paxos APIs use OAuth 2 with the client credentials grant flow.

Token URLs:

• Production: https://oauth.paxos.com/oauth2/token
• Sandbox: https://oauth.sandbox.paxos.com/oauth2/token

Learn more in the API credentials guide →

Query Parameters

statuses · enum<string>[]

Transaction statuses to filter on

• PENDING: Initial state of a settlement transaction upon creation.
• SETTLED: Indicates all obligations belong to the settlement transaction have been enacted.
• EXPIRED: Indicates the settlement transaction is no longer eligible for settlement.
• CANCELLED: Indicates the settlement transaction was cancelled by the source profile.
• AFFIRMED: Indicates the settlement transaction will be eligible for settlement once within the window.

Available options: PENDING, SETTLED, EXPIRED, CANCELLED, AFFIRMED

source_profile_id · string

The profile_id of the entity on the submitting side of the transaction.

target_profile_id · string

The profile_id of the entity on the receiving side of the transaction.

limit · integer<int64>

Number of results to return. Defaults to 100 if no limit is provided.

page_cursor · string

Cursor for getting the next page of results.

Response

200

application/json

A successful response.

items · object[]

Show child attributes

next_page_cursor · string