BVbvnk
Crypto Payments

Create an estimate payout

Changed on

Retrieves latest exchange rates, fees and network costs for a crypto payout without creating an actual payout. Provide either walletRequiredAmount (amount to send) or paidRequiredAmount (amount the recipient should receive). See the Estimate Crypto Payouts guide for details.

post/api/v1/pay/estimate

Request

Request body

OR

Example request

{
  "walletId": "acc:23040543559277:x8rvQ:0",
  "merchantId": "5C8D8D78-366A-4AFB-B658-A64CE543C5DB",
  "walletCurrency": "ETH",
  "paidCurrency": "ETH",
  "reference": "XRP commission",
  "complianceDetails": {
    "requesterIpAddress": "172.16.254.1",
    "contactId": "1b083898-73ca-42ba-b433-7dc20ea67667",
    "partyDetails": [
      {
        "type": "BENEFICIARY",
        "firstName": "John",
        "lastName": "Doe",
        "dateOfBirth": "1984-06-30",
        "relationshipType": "THIRD_PARTY",
        "countryCode": "DE",
        "regionCode": "UA-46"
      }
    ]
  },
  "walletRequiredAmount": 2000
}

Response

Created

externalIdstring uuid

Unique ID for the estimate request generated by the system.

accountIdstring uuid

Internal account ID associated with the estimate.

walletIdstring

Wallet identifier

customerReferencestring

The reference provided in the request.

walletCurrencystring

The currency from which funds are debited.

walletRequiredAmountnumber float

Calculated amount in the wallet currency required to fund the payout.

paidCurrencystring

The currency in which the payout is made.

paidRequiredAmountnumber float

The amount the recipient will receive.

feeCurrencystring

Currency in which the transaction fee is calculated.

feePredictedAmountnumber float

Estimated transaction fee in the feeCurrency.

networkFeeCurrencystring

Currency for the blockchain network fee.

networkFeePredictedAmountnumber float

Estimated blockchain network fee in networkFeeCurrency.

totalWalletAmountnumber float

Total amount debited from the wallet, including fees and network costs.

exchangeRatenumber float

Exchange rate applied between walletCurrency and paidCurrency.

customerIdstring

Associated customer ID, if applicable.

paymentExternalIdstring

External payment ID, if linked to an actual transaction.

networkstring

Blockchain network used for the estimate.

Example response

{
  "externalId": "4f7768e5-cd82-42c4-80d6-18d84a5b3832",
  "accountId": "4ea1277f-29d7-11ed-84d9-0a878439b77f",
  "walletId": "acc:23040543559277:x8rvQ:0",
  "customerReference": "REF46730",
  "walletCurrency": "USD",
  "walletRequiredAmount": 15.79,
  "paidCurrency": "USDT",
  "paidRequiredAmount": 15,
  "feeCurrency": "USD",
  "feePredictedAmount": 0.16,
  "networkFeeCurrency": "USD",
  "networkFeePredictedAmount": 1.62,
  "totalWalletAmount": 15.95,
  "exchangeRate": 0.949715,
  "network": "ETHEREUM"
}

Changes

  • c386d436bf2cRevision changes
    • info

      added the new ARBITRUM enum value to the request property

    • info

      added the new ARC enum value to the request property

    • info

      added the new BASE enum value to the request property