🔒Get business withdrawals

Get business withdrawals

GET https://payments.b2bpay.co/api/v1/withdrawals

Allows you to fetch all withdrawals for a business

Query Parameters

Name	Type	Description
businessId	string	Unique business identifier UUID
limit	integer	Results per request (Default: 25)
coins	array	Filter by coins comma delimited (BTC, ETH, XRP,...)
statuses	string	Can be used to filter per status . Accepts NEW PENDING COMPLETED FAILED
clientWithdrawId	string	Payment identifier of the client
before	integer	End date of the results
after	integer	Start date of the results
sortBy	string	Sort withdrawals by created

200 Withdrawals fetched successfully

{
    "withdrawals": [
        {
            "displayDeductedAmount": "25.41",
            "actualDisplayAmount": "25.16",
            "estimatedWithdrawAmount": "48.709621",
            "destinationRiskEntities": [],
            "uniformDeductedAmount": "25.41",
            "status": "COMPLETED",
            "settlementServiceFee": "0.24427985",
            "transactionId": "486001DE8F57AA04073A470F5F36183DF5F02044BBD1FEE3E6AAABF83DDB5DB4",
            "network": "XRP",
            "withdrawCurrency": "XRP",
            "withdrawId": "afe16c2f-b265-344b-b664-02550670b0e5",
            "settlementDeductedAmount": "24.67226454",
            "addressOwner": {
                "category": "Unknown",
                "name": "Unknown"
            },
            "displayServiceFee": "0.25",
            "displayCurrency": "EUR",
            "clientWithdrawId": "withdrawal-id",
            "displayFee": "0.00",
            "initiatedBy": "[e-mail]",
            "settlementCurrency": "USDT",
            "actualWithdrawAmount": "48.709621",
            "createdAt": 1665748957,
            "estimatedDisplayAmount": "25.16",
            "withdrawFee": "0.000015",
            "recipientAddress": "rDGEZi47v2XaR9hKekgPew2Q8YkNQ9zGB6?dt=1885748506",
            "uniformServiceFee": "0.25",
            "sourceRiskEntities": []
        }
    ]
}

Example: Fetch business withdrawals filtered by status COMPLETED and coin XRP

Request

curl --location --request GET 'https://dev-payments.b2bpay.co/api/v1/withdrawals?businessId=19dee3c4-4dc9-4bcc-b8ed-92e3d4f256bd&statuses=COMPLETED&coins=XRP' \
--header 'Content-Type: application/json' \
--header 'Authorization: FRX-API api-key=<your_api_key>,signature=<your_signature>,timestamp=<timestamp>'

Response

{
    "withdrawals": [
        {
            "displayDeductedAmount": "25.41",
            "actualDisplayAmount": "25.16",
            "estimatedWithdrawAmount": "48.709621",
            "destinationRiskEntities": [],
            "uniformDeductedAmount": "25.41",
            "status": "COMPLETED",
            "settlementServiceFee": "0.24427985",
            "transactionId": "486001DE8F57AA04073A470F5F36183DF5F02044BBD1FEE3E6AAABF83DDB5DB4",
            "network": "XRP",
            "withdrawCurrency": "XRP",
            "withdrawId": "afe16c2f-b265-344b-b664-02550670b0e5",
            "settlementDeductedAmount": "24.67226454",
            "addressOwner": {
                "category": "Unknown",
                "name": "Unknown"
            },
            "displayServiceFee": "0.25",
            "displayCurrency": "EUR",
            "clientWithdrawId": "withdrawal-id-w6Ve",
            "displayFee": "0.00",
            "initiatedBy": "[e-mail]",
            "settlementCurrency": "USDT",
            "actualWithdrawAmount": "48.709621",
            "createdAt": 1665748957,
            "estimatedDisplayAmount": "25.16",
            "withdrawFee": "0.000015",
            "recipientAddress": "rDGEZi47v2XaR9hKekgPew2Q8YkNQ9zGB6?dt=1885748506",
            "uniformServiceFee": "0.25",
            "sourceRiskEntities": []
        },
        {
            "displayDeductedAmount": "25.40",
            "actualDisplayAmount": "25.15",
            "estimatedWithdrawAmount": "52.818860",
            "destinationRiskEntities": [],
            "uniformDeductedAmount": "25.40",
            "status": "COMPLETED",
            "settlementServiceFee": "0.24294560",
            "transactionId": "C467EE89E1DAEF7B1729A3393167CE0B8E48F053B8608103AE4BAF604DE48743",
            "network": "XRP",
            "withdrawCurrency": "XRP",
            "withdrawId": "a5dbc59f-d28f-366c-8d44-e3f2623f8de0",
            "settlementDeductedAmount": "24.53750527",
            "addressOwner": {
                "category": "Unknown",
                "name": "Unknown"
            },
            "displayServiceFee": "0.25",
            "displayCurrency": "EUR",
            "clientWithdrawId": "withdrawal-id-13.10.2022vX2o",
            "displayFee": "0.00",
            "initiatedBy": "[e-mail]",
            "settlementCurrency": "USDT",
            "actualWithdrawAmount": "52.818860",
            "createdAt": 1665667821,
            "estimatedDisplayAmount": "25.15",
            "withdrawFee": "0.000015",
            "recipientAddress": "rDGEZi47v2XaR9hKekgPew2Q8YkNQ9zGB6?dt=2810190077",
            "uniformServiceFee": "0.25",
            "sourceRiskEntities": []
        }
    ]
}

Schema

Parameter	Type	Description
withdrawals	array [required]	Array containing all withdrawals for the chosen businessId
withdrawId	string [required]	Unique B2BPay withdrawal identifier UUID
clientWithdrawId	string [required]	Unique withdrawal identifier provided by the merchant in the request body of POST /withdrawals
recipientAddress	string [required]	The address to which the actualWithdrawAmount was sent
transactionId	string [optional]	Unique blockchain transaction ID of the withdrawal
initiatedBy	string [required]	Initiator of the withdrawal request. When initiated from the B2BPay Dashboard, the dashboard user's email is stored. When initiated from API, the backend URL is stored.
status	string [required]	One of NEW, PENDING, COMPLETED, FAILED or BLOCKED
displayCurrency	string [required]	The fiat currency chosen for display (denomination) purposes
withdrawCurrency	string [required]	Cryptocurrency to be withdrawn
settlementCurrency	string [required]	The currency in which the merchant's account was debited because of the withdrawal (can be either fiat or cryptocurrency)
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 (e.g.EUR, USD, GBP, TRY etc..)Can be different than estimatedDisplayAmount
actualWithdrawAmount	string [optional]	Actual amount withdrawn in withdrawCurrencyCan be different than estimatedWithdrawAmount
settlementDeductedAmount	string [optional]	Amount debited from the merchant's balance in settlementCurrency
withdrawFee	number [optional]	Blockchain cost for this withdrawal in withdrawCurrency
displayFee	number [optional]	Blockchain cost for this withdrawal in displayCurrency
addressOwner	object [required]	Address AML screening results
name	string [required]	Address owning entity name
category	string [required]	Address owning entity category
sourceRiskEntities	array [required]	Illicit sources from which the recipientAddress has received transactions
name	string [required]	Illicit source name
category	string [required]	Illicit source category
destinationRiskEntities	array [required]	Illicit destinations to which the recipientAddress has sent transactions
name	string [required]	Illicit destination name
category	string [required]	Illicit destination category
createdAt	number [required]	UNIX timestamp when the withdrawal was requested
exchangedAt	number [optional]	UNIX timestamp when the withdrawal was exchanged