Withdrawal

Receiving a commission token to withdraw an orphan transaction

Withdrawal

post

/api-gateway/orphan-deposits/withdrawal

Header parameters

x-api-public-keystring

Public API-key

x-api-signaturestring

Signing the request body with a private API-key

Content-typestring

Request content type

Example: application/json

Body

tokenstring

Withdrawal Token

Example: U2FsdGVkX1/hg1DyMSK6tu1KH0XuXBmOUnjntmf6+tsyjaG12pdLa8C9tPuRY0dctW9uKbs++4YMi514VRHPTInsUqOM6Mp5Rbpuf2NnaB7+36O3tlr+WVnLe+m70ou2gfXU3ii2bkBtbnBRzh2afe4WGepwMNVT7kXzlGIOSwrBtEmAtdq0u2YRUAbHbi/Jm94SuhqFx7P0CLmSTfbT3Q==

addressstring

Output address

Example: 0x4642BEd309FdB7FFdB34175Cf39c409711cefa5a

webhookUrlstring

URL for sending a webhook about the withdrawal

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

commentstring | null

Comment on the conclusion

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://ocp.onchainpay.io/api-gateway/orphan-deposits/withdrawal' \
  --header 'Content-Type: application/json' \
  --data '{"token":"U2FsdGVkX1/hg1DyMSK6tu1KH0XuXBmOUnjntmf6+tsyjaG12pdLa8C9tPuRY0dctW9uKbs++4YMi514VRHPTInsUqOM6Mp5Rbpuf2NnaB7+36O3tlr+WVnLe+m70ou2gfXU3ii2bkBtbnBRzh2afe4WGepwMNVT7kXzlGIOSwrBtEmAtdq0u2YRUAbHbi/Jm94SuhqFx7P0CLmSTfbT3Q==","address":"0x4642BEd309FdB7FFdB34175Cf39c409711cefa5a","webhookUrl":"https://merchant.domain/webhooks/orphan","comment":null}'

200

200

{
  "success": true,
  "response": {
    "id": "6c81c190-49b9-4c62-8b6d-c52b1a0d45c1",
    "organizationId": "e334a8e2-60c6-4d96-8857-db27bc28584a",
    "currency": "BNB",
    "network": "ethereum",
    "amount": "0.00612",
    "canWithdrawal": true,
    "createdAt": "2024-12-26T08:21:33.143Z",
    "orderId": "9f5e6167-b4f2-4714-a152-6211b3a5c14e",
    "stage": "DEPOSIT",
    "status": "PROCESSED",
    "message": null,
    "inTransaction": {
      "addressId": "eb4080a9-cdf8-47b9-ba18-84b5f4eba8ff",
      "address": "0x4642BEd309FdB7FFdB34175Cf39c409711cefa5a",
      "txId": "0xdb81763509668071c5d2a18f295d8d7ac48a7a31927ed2463cea41e291394f8f",
      "amount": "0.00612",
      "createdAt": "2024-12-26T08:21:33.143Z",
      "addressType": "PAY_IN",
      "status": "processed"
    },
    "outTransaction": {
      "address": "0x4642BEd309FdB7FFdB34175Cf39c409711cefa5a",
      "txId": "0xdb81763509668071c5d2a18f295d8d7ac48a7a31927ed2463cea41e291394f8f",
      "amount": "0.00612",
      "feeAmount": "0.000090942",
      "feeAmountUSD": "0.03",
      "withdrawalId": "60fea35e-8dd0-4cec-9518-f4b5a40b9f02",
      "createdAt": "2024-12-26T08:21:33.143Z",
      "status": "processed"
    }
  }
}