Withdrawal

Receiving a commission token to withdraw an orphan transaction

Withdrawal

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

tokenstringOptional

Withdrawal Token

Example: U2FsdGVkX1+WkZAHdbTAgAbihIexHXXB7t3XbKXpFQur6ic3sQWc65YOwo9guFBLwE4XWB3HlUijwK500pG6PXLtvt3XnyYoTJweOkQgEAL0w5N2B9lw8PyKZYw8cETgAzctG1mBn7PVzaCcV7IVTgaxbqI6PTvhlZDfMXWeO5aT/NRvMQSQ0ti+CmxUJ3Am9BWTxPfOKj0vvSuj2uv7aA==

addressstringOptional

Output address

Example: 0x4642BEd309FdB7FFdB34175Cf39c409711cefa5a

commentstring | nullOptional

Comment on the conclusion

webhookUrlstringOptional

URL for sending a webhook about the withdrawal

Example: https://merchant.domain/webhooks/orphan

Responses

200Success

application/json

post

HTTPcURLJavaScriptPython

POST /api-gateway/orphan-deposits/withdrawal HTTP/1.1
Host: ocp.onchainpay.io
Content-Type: application/json
Accept: */*
Content-Length: 353

{
  "token": "U2FsdGVkX1+WkZAHdbTAgAbihIexHXXB7t3XbKXpFQur6ic3sQWc65YOwo9guFBLwE4XWB3HlUijwK500pG6PXLtvt3XnyYoTJweOkQgEAL0w5N2B9lw8PyKZYw8cETgAzctG1mBn7PVzaCcV7IVTgaxbqI6PTvhlZDfMXWeO5aT/NRvMQSQ0ti+CmxUJ3Am9BWTxPfOKj0vvSuj2uv7aA==",
  "address": "0x4642BEd309FdB7FFdB34175Cf39c409711cefa5a",
  "comment": null,
  "webhookUrl": "https://merchant.domain/webhooks/orphan"
}

200Success

{
  "success": true,
  "response": {
    "id": "288599a6-5489-40cd-b081-9a7537adcf72",
    "organizationId": "7dc2d4af-e8c6-41e5-b3e1-229ee9cd4294",
    "orderId": "cef41a74-c614-4394-8254-5cba1ff57d7c",
    "stage": "DEPOSIT",
    "status": "PROCESSED",
    "message": null,
    "currency": "BNB",
    "network": "ethereum",
    "amount": "0.00612",
    "canWithdrawal": true,
    "inTransaction": {
      "addressType": "PAY_IN",
      "addressId": "23a78e3e-a06e-431d-abdb-e4a5156ba961",
      "address": "0x4642BEd309FdB7FFdB34175Cf39c409711cefa5a",
      "txId": "0xdb81763509668071c5d2a18f295d8d7ac48a7a31927ed2463cea41e291394f8f",
      "amount": "0.00612",
      "status": "processed",
      "createdAt": "2025-05-14T13:39:50.411Z"
    },
    "outTransaction": {
      "address": "0x4642BEd309FdB7FFdB34175Cf39c409711cefa5a",
      "txId": "0xdb81763509668071c5d2a18f295d8d7ac48a7a31927ed2463cea41e291394f8f",
      "amount": "0.00612",
      "status": "processed",
      "feeAmount": "0.000090942",
      "feeAmountUSD": "0.03",
      "withdrawalId": "525a1fc1-02ba-4781-8f5b-e2f1d7003d73",
      "createdAt": "2025-05-14T13:39:50.411Z"
    },
    "createdAt": "2025-05-14T13:39:50.411Z"
  }
}