v1

latestOpenAPI 3.1.02026-07-241653251.3 MB

Payins

List payin transactions

Retrieves a paginated list of pay transactions for the authenticated platform. Results can be filtered by participant, asset, deposit status, and timestamps. Each deposit also emits a crypto_pay_status_changed webhook when it settles or fails.

Note: Some filtering capabilities may not be available for all platforms. Contact support if you need access to additional filters.

get/pay/transactions

Query parameters

participant_codestring

Filter by participant code (6-character alphanumeric)

transaction_idstring

Filter by specific transaction ID (UUID format)

client_reference_idstring

Filter by client-provided reference ID. This filter may not be available for all platforms. Contact support if you need access.

pay_assetstring

Filter by the underlying crypto asset (e.g., BTC, ETH, USDC)

deposit_addressstring

Filter by the deposit address provided by zerohash for this payment.

success'true' | 'false'

Filters transactions by successful status. This is a boolean field, please specify either true or false

pagestring

Page number (1-indexed, max 5 digits)

page_sizestring

The number of results returned per page, with a maximum of 50 transactions per page

deposit_timestamp_gtestring

Deposit timestamp greater than or equal to this value (inclusive). Unix milliseconds (13-19 digits). This filter may not be available for all platforms. Contact support if you need access.

deposit_timestamp_gtstring

Deposit timestamp strictly greater than this value (exclusive). Unix milliseconds (13-19 digits). This filter may not be available for all platforms. Contact support if you need access.

deposit_timestamp_ltstring

Deposit timestamp strictly less than this value (exclusive). Unix milliseconds (13-19 digits). This filter may not be available for all platforms. Contact support if you need access.

deposit_timestamp_ltestring

Deposit timestamp less than or equal to this value (inclusive). Unix milliseconds (13-19 digits). This filter may not be available for all platforms. Contact support if you need access.

merchant_participant_codestring

Filter by merchant participant code.

Headers

X-SCX-SIGNEDstring required

HMAC-SHA256 signature of the request, base64-encoded. See the Authentication guide for the exact signing formula.

X-SCX-TIMESTAMPstring required

Example:1678901234

Current Unix timestamp in seconds. Must be within 60 seconds of server time or the request is rejected.

Response

List of pay transactions with pagination metadata

pageinteger

Current page number (1-indexed)

page_sizeinteger

Number of items per page (capped at 50)

total_pagesinteger

Total number of pages available

Example response

{
  "message": [
    {
      "participant_code": "ABCDEF",
      "pay_asset": "BTC",
      "rate": "65658.42",
      "quoted_currency": "USD",
      "source_address": "0xA32A6aA6a3B87b49BeaB01393e2020C3C191CD61",
      "deposit_address": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",
      "quantity": "0.00152307",
      "notional": "100.00",
      "success": true,
      "status_reason_code": "AMOUNT_ABOVE_MAXIMUM",
      "fund_timestamp": 1712756400000,
      "deposit_timestamp": 1712756700000,
      "transaction_id": "0x408482348dcb0e0331a9148d50f8c76db08138f63fb1586fcfc45200a91ccc5f",
      "account_label": "pay",
      "fund_id": "29e6d7b8-d604-4212-86ee-998fef35505e",
      "raw_fee_bps": "50",
      "deposit_fee_bps": "50",
      "raw_fee_notional": "0.50",
      "deposit_fee_notional": "0.50",
      "deposited_asset": "BTC",
      "reference_id": "order-12345",
      "source": {
        "type": "CUSTODIAL",
        "integration": "coinbase"
      },
      "deposit_fee_type": "flat",
      "fee_tier_breakdown": [
        {
          "tier": 1,
          "amount_in_tier": "100.00",
          "fee_bps": "40",
          "fee_amount": "0.40"
        }
      ],
      "merchant_participant_code": "MERCH01"
    }
  ],
  "page": 1,
  "page_size": 50,
  "total_pages": 1
}