Skip to main content
GET
/
v1
/
accounts
/
{account_id}
/
price-trigger-swaps
curl
curl -X GET "https://api.services.payward.com/v1/accounts/W4BE9868GY65TB6523/price-trigger-swaps?statuses=active&page_size=20" \
  -H "API-Key: $PWS_API_KEY" \
  -H "API-Nonce: $PWS_API_NONCE" \
  -H "API-Sign: $PWS_API_SIGN"
{
  "data": [
    {
      "id": "swap_01J0M7C0Z9F8YX3GQH8E",
      "external_reference": "buy-dip-btc-001",
      "trade": {
        "from": {
          "symbol": "USD",
          "name": "US Dollar",
          "type": "fiat",
          "amount": "100.00"
        },
        "to": {
          "symbol": "BTC",
          "name": "Bitcoin",
          "type": "crypto"
        }
      },
      "when": {
        "base": {
          "symbol": "BTC",
          "name": "Bitcoin",
          "type": "crypto"
        },
        "quote": {
          "symbol": "USD",
          "name": "US Dollar",
          "type": "fiat"
        },
        "drops_to": "50000.00"
      },
      "status": "active"
    },
    {
      "id": "swap_01J0M7BMRWJTKBN0R0FY",
      "external_reference": "top-up-eth-2k",
      "trade": {
        "from": {
          "symbol": "USD",
          "name": "US Dollar",
          "type": "fiat"
        },
        "to": {
          "symbol": "ETH",
          "name": "Ethereum",
          "type": "crypto",
          "amount": "0.5"
        },
        "fees": {
          "trade": {
            "symbol": "USD",
            "name": "US Dollar",
            "type": "fiat",
            "amount": "5.00"
          }
        },
        "rate": {
          "base": {
            "symbol": "ETH",
            "name": "Ethereum",
            "type": "crypto"
          },
          "quote": {
            "symbol": "USD",
            "name": "US Dollar",
            "type": "fiat"
          },
          "price": "2000.00"
        }
      },
      "when": {
        "base": {
          "symbol": "ETH",
          "name": "Ethereum",
          "type": "crypto"
        },
        "quote": {
          "symbol": "USD",
          "name": "US Dollar",
          "type": "fiat"
        },
        "drops_to": "2000.00"
      },
      "status": "completed"
    }
  ],
  "next_page_token": "MjoyRHuBXSgoe0mDHt-iFALROW46EGdvk_trgja31Vwr7H4"
}

Authorizations

​
API-Key
string
header
required

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

​
API-Nonce
string
header
required

Monotonically increasing nonce included in the request signature.

​
API-Sign
string
header
required

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

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

​
statuses
enum<string>[]

Filter to swaps in one or more lifecycle statuses. Repeat the parameter to pass multiple values. Omit to include swaps in any status.

Available options:
active,
completed,
cancelled
​
page_token
string

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

Required string length: 1 - 256
​
page_size
integer<int32>
default:20

Maximum number of results to return on a single page. Defaults to 20, maximum 100.

Required range: 1 <= x <= 100

Response

Successful response

​
data
object[]

Price trigger swaps matching the filter, ordered newest first.

​
next_page_token
string

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

Required string length: 1 - 64