Fetch withdrawals

Fetch withdrawals for a business.

Request

Authorization

Add parameter in header

FRX-API

Example:

FRX-API: ********************

Query Params

businessId

string <uuid>

required

ID of the business.

clientWithdrawId

array[string]

optional

Withdrawal ID provided by the client.

coins

array[string]

optional

Comma-separated list of cryptocurrencies.

Allowed values:

BCHBNBBTCETHLINKLTCSOLTRXUSDCUSDTXLMXRP

statuses

array[string]

optional

Comma-separated list of withdrawal statuses.

Allowed values:

PENDINGCOMPLETEDFAILEDBLOCKED

after

integer <int64>

optional

Withdrawal creation date range start, in UNIX seconds, inclusive.

Example:

1702894529

before

integer <int64>

optional

Withdrawal creation date range end, in UNIX seconds, exclusive.

Example:

1702894529

limit

integer

optional

Limit of the results per request.

<= 2000

Default:

Example:

Responses

🟢200Returns withdrawals, sorted by `created`.

application/json

Body

withdrawals

array[object (FetchWithdrawalResponse) {26}]

optional

withdrawId

string <uuid>

required

clientWithdrawId

string

required

Withdrawal identifier provided by the merchant in the request body of POST /withdrawals.

recipientAddress

string

required

Address to which the actualWithdrawAmount was sent.

transactionId

string

optional

Blockchain transaction hash of the withdrawal.

initiatedBy

string

required

Initiator of the withdrawal request. When initiated from the Dashboard, the dashboard user's email is stored. When initiated from API, the backend URL is stored.

status

enum<string>

required

Allowed values:

PENDINGCOMPLETEDFAILEDBLOCKED

displayCurrency

enum<string>

required

Fiat currency.

Allowed values:

AEDARSAUDBDTBGNBRLCADCHFCLPCNYCZKDKKEURGBPHKDHRKHUFIDRILSINRISKJPYKESKRWMXNMYRNGNNOKNZDPENPHPPLNQARRONRUBSEKSGDTHBTRYUSDVNDZAR

withdrawCurrency

enum<string>

required

Cryptocurrency that was withdrawn.

Allowed values:

BCHBNBBTCETHLINKLTCSOLTRXUSDCUSDTXLMXRP

settlementCurrency

enum<string>

required

Currency in which the merchant's account was debited. Can be either fiat or cryptocurrency.

Allowed values:

BTCUSDCUSDTEURGBPUSD

estimatedDisplayAmount

string

required

Amount in displayCurrency requested for this withdrawal.

estimatedWithdrawAmount

string

required

Estimated amount for this withdrawal. Can be different than actualWithdrawAmount.

actualDisplayAmount

string

optional

Actual amount withdrawn in displayCurrency currency. Can be different than estimatedDisplayAmount.

actualWithdrawAmount

string

optional

Actual amount withdrawn in withdrawCurrency. Can be different than estimatedWithdrawAmount.

settlementDeductedAmount

string

optional

Amount debited from the merchant's balance in settlementCurrency.

displayDeductedAmount

string

optional

Amount debited from the merchant's balance in displayCurrency.

uniformDeductedAmount

string

optional

Amount debited from the merchant's balance in EUR.

settlementServiceFee

string

optional

Amount debited for fees from the merchant's balance in settlementCurrency.

displayServiceFee

string

optional

Amount debited for fees from the merchant's balance in displayCurrency.

uniformServiceFee

string

optional

Amount debited for fees from the merchant's balance in EUR.

withdrawFee

string

optional

Blockchain cost for this withdrawal in withdrawCurrency.

displayFee

string

optional

Blockchain cost for this withdrawal in displayCurrency.

network

enum<string>

required

Network on which this withdrawal will be initiated.

Allowed values:

BCHBTCLTCXLMXRPETHBSCSOLTRX

addressOwner

object (LegalEntityResponse)

required

Legal entity.

sourceRiskEntities

array[object (LegalEntityResponse) {2}]

required

Illicit sources from which the recipientAddress has received transactions.

destinationRiskEntities

array[object (LegalEntityResponse) {2}]

required

Illicit destinations to which the recipientAddress has sent transactions.

createdAt

integer <int64>

required

UNIX seconds at which the withdrawal was requested.

Example

{
    "withdrawals": [
        {
            "withdrawId": "5724d752-6084-3822-9590-a6ccdf91f603",
            "clientWithdrawId": "test-withdrawal-23-12-19-2",
            "recipientAddress": "0x5CF631Db2eB6be3eecB5E9fD0f31a19AC0F4C504",
            "transactionId": "0x6a01e5032de509be3ed2075f382396a48d43ae496debbe0f1a09d0590e419a8a",
            "initiatedBy": "john.doe@gmail.com",
            "status": "COMPLETED",
            "displayCurrency": "EUR",
            "withdrawCurrency": "USDC",
            "settlementCurrency": "EUR",
            "estimatedDisplayAmount": "21",
            "estimatedWithdrawAmount": "23.01742298",
            "actualDisplayAmount": "21",
            "actualWithdrawAmount": "23.01742298",
            "settlementDeductedAmount": "21.52",
            "displayDeductedAmount": "21.52",
            "uniformDeductedAmount": "21.52",
            "settlementServiceFee": "0.52",
            "displayServiceFee": "0.52",
            "uniformServiceFee": "0.52",
            "withdrawFee": "0",
            "displayFee": "0",
            "network": "BSC",
            "addressOwner": {
                "category": "Unknown",
                "name": "Unknown"
            },
            "sourceRiskEntities": [],
            "destinationRiskEntities": [],
            "createdAt": 1702999367
        },
        {
            "withdrawId": "fde3c760-2383-391e-8baf-7fb8508eca18",
            "clientWithdrawId": "test-withdrawal-23-12-19-1",
            "recipientAddress": "0x5CF631Db2eB6be3eecB5E9fD0f31a19AC0F4C504",
            "transactionId": "0xcf385e8b9301fb105b013d5df78c4bc09fabe604761334409e286c2c06a20cd3",
            "initiatedBy": "john.doe@gmail.com",
            "status": "COMPLETED",
            "displayCurrency": "EUR",
            "withdrawCurrency": "USDC",
            "settlementCurrency": "USDT",
            "estimatedDisplayAmount": "25.33",
            "estimatedWithdrawAmount": "27.46682584",
            "actualDisplayAmount": "25.33",
            "actualWithdrawAmount": "27.46682584",
            "settlementDeductedAmount": "28.144254",
            "displayDeductedAmount": "25.63",
            "uniformDeductedAmount": "25.63",
            "settlementServiceFee": "0.330163",
            "displayServiceFee": "0.3",
            "uniformServiceFee": "0.3",
            "withdrawFee": "0",
            "displayFee": "0",
            "network": "BSC",
            "addressOwner": {
                "category": "Unknown",
                "name": "Unknown"
            },
            "sourceRiskEntities": [],
            "destinationRiskEntities": [],
            "createdAt": 1702999081
        }
    ]
}

Request

Request samples

Responses