API Documentation
English
English
  • Authorization
  • Request signing
  • List of error codes
  • Webhooks
  • IFrame order
  • Payment acceptance widget
  • Telegram MiniApp
  • API Reference
    • Base actions
      • Check x-api-signature
      • Fetch available currencies
      • Current price request
      • Search for operations by TX hash
      • Check address format
      • Get transaction history
    • Advanced account
      • Get advanced balances of user
      • Get advanced balance by id
      • Get payment address for advanced balance top-up
    • Blockchain addresses
      • Search by id
      • Transactions tracking
      • Search by address
      • Meta-data
      • Address Transactions
      • Last transaction of the address
      • Getting a list of PayIn addresses
      • Getting a list of business addresses
      • Get recurrent addresses
      • Getting a list of PayOut addresses
      • Creating a new business wallet address
      • Creating a new PayOut wallet address
    • Personal addresses
      • User creation
      • Getting an address
      • Getting a list of addresses
      • Get user
      • Adding a trusted address
      • Getting a list of trusted addresses
      • Deleting a trusted address
    • Orders
      • Creating an order
      • Getting information about an order
      • Getting a list of orders
    • Withdraws
      • Getting a commission for making a withdrawal
      • Sync withdraw
      • Async withdrawal
      • Receiving withdrawal information
    • Invoices
      • Create an invoice for payment
      • Invoice information request
      • Getting a list of invoices
    • Auto swaps
      • Create auto-swap
      • Find auto-swap by ID
    • Withdrawals 2.0
      • Create auto-withdrawal
      • Find auto-withdrawal by ID
      • Additional confirmation of the withdrawal
    • Bridge
      • Getting limits for cross-chain transfer
      • Getting information about cross-chain transfer
      • Commission token formation
      • Creating a cross-chain translation
    • Swaps
      • Getting limits for cross-chain exchange
      • Getting information about cross-chain exchange
      • Commission token formation
      • Creation of a cross-chain exchange
    • Recurring payments
      • Creating a payment link
      • Get a payment link
      • Get payment links by user
      • Disabling the payment link
      • Create a subscription
      • Getting a subscription
      • Cancel Subscription
      • Creating a payment
    • KYT
      • Check transaction risks
      • Check withdrawal risks
      • Check withdrawal risks for provided address
    • Partners API
      • Create user
      • Get user
      • Get all users
      • Creating an organization
      • Getting a list of organizations
      • Getting the user's advance balances
      • Replenishment of the user's advance balance
      • Get general tariffs
      • Create/update individual tariff
      • Get individual tariffs
      • Create API key
      • Get API keys
      • Delete API key
    • Webhooks
      • Get webhook
      • Get webhook (extended)
    • Orphan transactions
      • Get a transaction
      • Get a list of transactions
      • Get a commission token
      • Withdrawal
    • Address book
      • Add an address
      • Delete an address
      • Update the address
      • Get a list of addresses
Powered by GitBook
On this page
  1. API Reference
  2. Base actions

Get transaction history

The method allows you to get organization transactions history.

Filters

Filters are available:

  • by transaction type (enum type)

  • by date (date parameter)

  • by coin (currency parameter)

  • by network (network parameter)

Pagination

Pagination is performed using the parameters limit, offset. Sorting by date also is available (parameter sortDate)

  • limit - the number of items to display as a result of the request (no less than 100 and no more than 1000, by default 100)

  • offset - the number of elements to skip

Description of enum basis

Тип
Описание

order

Order

withdrawal

Withdrawal

deposit

Deposit

transfer

Transfer

collecting

Collecting profits

kyt

KYT

exchange_AUTO

Swap API

payout_auto_swap

Auto-swap

Description of enum type

Тип
Описание

commission

Commission

commission_create_order

Order creation fee

commission_execute_order

Transaction order fee

commission_wallet_deposit

Wallet deposit fee

commission_recurrent_deposit

Recurrent address deposit fee

commission_personal_deposit

Personal address deposit fee

commission_payout_deposit

Payout balance deposit fee

commission_wallet_withdrawal

Wallet withdrawal fee

commission_recurrent_withdrawal

Recurrent address withdrawal fee

commission_personal_withdrawal

Personal address withdrawal fee

commission_collect_withdrawal

Collect address withdrawal fee

commission_payout_withdrawal

Payout balance withdrawal fee

bridge_internal_fee

Blockchain bridge fee

bridge_external_fee

Blockchain bridge API fee

bridge_internal

Blockchain bridge

bridge_external

Blockchain bridge API

exchange_internal

Swap

exchange_auto

Swap API

exchange_internal_fee

Swap fee

exchange_auto_fee

Swap API fee

network_fee

Network commission

deposit

Advanced balance replenishment

withdrawal

Withdrawal

commission_withdrawal

Withdrawal fee

order_transaction

Order transaction

deposit_payout_balance

Payout balance replenishment

deposit_wallet

Wallet replenishment

deposit_recurrent

Recurrent address replenishment

deposit_personal

Personal address replenishment

deposit_collect

Collect address replenishment

kyt_transaction_fee

Transaction risks

kyt_withdrawal_address_fee

Withdrawal risks

kyt_address_fee

Address risks

payout_auto_swap

Auto-swap

payout_auto_swap_fee

Auto-swap fee

PreviousCheck address formatNextAdvanced account

Last updated 7 months ago

  • Filters
  • Pagination
  • Description of enum basis
  • Description of enum type
  • POSTGet transaction history

Get transaction history

post
Header parameters
x-api-public-keystringOptional

Public API-key

x-api-signaturestringOptional

Signing the request body with a private API-key

Content-typestringOptional

Request content type

Example: application/json
Body

Transactions history request body

offsetintegerRequired

Offset (for pagination)

limitintegerRequired

Limit (for pagination). No less than 100 and no more than 1000, by default 100

currencystring[]Optional

Filter by currencies

Example: ["USDT"]
networkstring[]Optional

Filter by networks

Example: ["bsc"]
typestring[]Optional

Filter by transaction type

Example: ["order_transaction"]
sortDatestringOptional

Sort by date. 'ASC' or 'DESC'

Example: ASC
Responses
200Success
application/json
post
POST /api-gateway/get-transaction-history HTTP/1.1
Host: ocp.onchainpay.io
Content-Type: application/json
Accept: */*
Content-Length: 161

{
  "currency": [
    "USDT"
  ],
  "network": [
    "bsc"
  ],
  "type": [
    "order_transaction"
  ],
  "date": {
    "from": "2024-07-11T00:00:00.000Z",
    "to": "2024-07-11T23:59:59.999Z"
  },
  "sortDate": "DESC"
}
200Success
{
  "success": true,
  "response": {
    "transactions": [
      {
        "id": "07902bb3-59be-4370-a3ab-0d154a02075f",
        "basis": "order",
        "status": "processed",
        "type": "order_transaction",
        "currency": "USDT",
        "network": "ethereum",
        "addressFrom": "0x1AFfB0a96FBefAa97dCe488DfD97512346cf3Ab8",
        "addressTo": "0x00000005707Bf50EfA35a2db020eDe9Ac0780b9f",
        "deposit": "12.99",
        "credit": null,
        "tx": "0x2a6113054f5b4fbcdbb5fa128815bf07ce355021165b13c616545438a0fda3ca",
        "comment": null,
        "createdAt": "2025-05-14T13:39:50.480Z",
        "bridgeId": "5c6689cb-f427-4807-bb2c-02e8683d8fd3",
        "swapId": "5c6689cb-f427-4807-bb2c-02e8683d8fd3",
        "autoSwapId": "5c6689cb-f427-4807-bb2c-02e8683d8fd3",
        "autoWithdrawalId": "5c6689cb-f427-4807-bb2c-02e8683d8fd3"
      }
    ],
    "count": 1
  }
}