Withdrawal

Receiving a commission token to withdraw an orphan transaction

Withdrawal

POSThttps://ocp.onchainpay.io/api-gateway/orphan-deposits/withdrawal

Header parameters

Body

tokenstring

Withdrawal Token

Example:

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

addressstring

Output address

Example: "0x4642BEd309FdB7FFdB34175Cf39c409711cefa5a"

commentstringnull

Comment on the conclusion

webhookUrlstring

URL for sending a webhook about the withdrawal

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

Response

Body

success*boolean

Request success indicator

response*OrphanResponse (object)

Request

const response = await fetch('https://ocp.onchainpay.io/api-gateway/orphan-deposits/withdrawal', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

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

PreviousGet a commission token NextAddress book

Last updated 5 months ago

const response = await fetch('https://ocp.onchainpay.io/api-gateway/orphan-deposits/withdrawal', { method: 'POST', headers: { "Content-Type": "application/json" }, body: JSON.stringify({}), }); const data = await response.json();

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