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
      • 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
      • (DEPRECATED) 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. Withdrawals 2.0

Find auto-withdrawal by ID

PreviousCreate auto-withdrawalNextAdditional confirmation of the withdrawal

Last updated 8 months ago

Getting auto-withdrawal data by its ID

Find auto-withdrawal by ID

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
idstringRequired

Auto-withdrawal ID

Example: ba47ea7a-5b3f-48db-b9e7-45c2447f83b6
Responses
200Success
application/json
post
POST /api-gateway/auto-withdrawals/get HTTP/1.1
Host: ocp.onchainpay.io
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "id": "ba47ea7a-5b3f-48db-b9e7-45c2447f83b6"
}
200Success
{
  "success": true,
  "response": {
    "id": "ba47ea7a-5b3f-48db-b9e7-45c2447f83b6",
    "organizationId": "d567fadf-3b5b-4bd0-8be8-0c52838dff88",
    "type": "WITHDRAWAL",
    "status": "PENDING",
    "message": null,
    "addressRiskLevel": "Low",
    "currencyFrom": "USDT",
    "networkFrom": "bsc",
    "currencyTo": "BTC",
    "networkTo": "bitcoin",
    "addressFromId": "25a8de42-a359-47f1-bb82-bc9f6c20f1b9",
    "addressFrom": "0xD65D24ABCd85165a243C33Cf8133ffBaaa98255D",
    "addressTo": "0x22aECc7ff5b435E38be5457C8538256918783F67",
    "amountFrom": "1000",
    "amountFromUSD": "1000",
    "amountTo": "0.1",
    "amountToUSD": "990",
    "amountToReceive": "0.999",
    "rate": "10000",
    "blockchainFeeFrom": "0.34",
    "blockchainFeeFromUSD": "0.34",
    "blockchainFeeToSource": "ADVANCED",
    "blockchainFeeTo": "0.001",
    "blockchainFeeToUSD": "10",
    "serviceFee": "10",
    "txId": "0xadcc95b8bcd123e41612c46b057df889e32a73297e973c21e8b38046ac04130a",
    "webhookUrl": "https://merchant.domain/webhooks/...",
    "approveUrl": "https://merchant.domain/webhooks/...",
    "approveResult": {
      "apiKey": {
        "id": "2108544f-65df-4632-9589-581c0d8ce7ad",
        "public": "c9jeO7OJcJb7cnBTVXrgtRzazf60W4Lbsz3/wOYM1m2EsJyZz5wGfbIIuoJ4Ugs6HMowQj8zlv2jf8Vt1ra4Fw=="
      },
      "request": {
        "ip": "123.231.123.100",
        "userAgent": "axios/1.6.0"
      },
      "approve": true,
      "time": "2025-06-04T09:36:10.109Z"
    },
    "requestedClientId": "89c64b5a-cfe3-4208-b302-10df1fd6298e",
    "requestedCurrency": "EUR",
    "requestedAmount": "5500",
    "createdAt": "2025-06-04T09:36:10.109Z",
    "updatedAt": "2025-06-04T09:36:10.109Z"
  }
}