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: U2FsdGVkX1917ygTMGz5re9+mNFK157RFTYFGL5zaY4rtWbbkrHl4nekHQHy3iQzYOGMRwP7ggpxgJeOSTKhNeAMBd/U+DRC6dmqVe6zQKxcWOvJpg4DWOMAGlDg9YA1DF3qMZevVrq4dzAOL2RtS88DdnumWokKS+EAZBvWlShTEX5K6xJqFynWTVtBXp/2A3Kq5B03akM8odQW1Fdgsg==

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://app.apollopayment.io/api-gateway/orphan-deposits/withdrawal' \
  --header 'Content-Type: application/json' \
  --data '{
    "token": "U2FsdGVkX1917ygTMGz5re9+mNFK157RFTYFGL5zaY4rtWbbkrHl4nekHQHy3iQzYOGMRwP7ggpxgJeOSTKhNeAMBd/U+DRC6dmqVe6zQKxcWOvJpg4DWOMAGlDg9YA1DF3qMZevVrq4dzAOL2RtS88DdnumWokKS+EAZBvWlShTEX5K6xJqFynWTVtBXp/2A3Kq5B03akM8odQW1Fdgsg==",
    "address": "0x4642BEd309FdB7FFdB34175Cf39c409711cefa5a",
    "webhookUrl": "https://merchant.domain/webhooks/orphan",
    "comment": null
  }'

200

200

{
  "success": true,
  "response": {
    "id": "2e0444dc-79e9-413d-95b7-9ae112882108",
    "organizationId": "5d380c7e-30e9-4b05-a489-36a4be9123e3",
    "currency": "BNB",
    "network": "ethereum",
    "amount": "0.00612",
    "canWithdrawal": true,
    "createdAt": "2024-12-26T08:21:53.280Z",
    "orderId": "be2ded2c-0755-4f1d-bc56-463d6e41c981",
    "stage": "DEPOSIT",
    "status": "PROCESSED",
    "message": null,
    "inTransaction": {
      "addressId": "d5d5b0b3-caf5-4ca2-baed-738e165e4386",
      "address": "0x4642BEd309FdB7FFdB34175Cf39c409711cefa5a",
      "txId": "0xdb81763509668071c5d2a18f295d8d7ac48a7a31927ed2463cea41e291394f8f",
      "amount": "0.00612",
      "createdAt": "2024-12-26T08:21:53.280Z",
      "addressType": "PAY_IN",
      "status": "processed"
    },
    "outTransaction": {
      "address": "0x4642BEd309FdB7FFdB34175Cf39c409711cefa5a",
      "txId": "0xdb81763509668071c5d2a18f295d8d7ac48a7a31927ed2463cea41e291394f8f",
      "amount": "0.00612",
      "feeAmount": "0.000090942",
      "feeAmountUSD": "0.03",
      "withdrawalId": "445ffbc7-a5ea-4d8d-b7ba-82740c031349",
      "createdAt": "2024-12-26T08:21:53.280Z",
      "status": "processed"
    }
  }
}