Create a trade offer

POST

/v1/offers

This endpoint is responsible for initiating a buy/sell trade offer on behalf of the user.

The request triggers the creation of a trade offer that can later be accepted by the user within its validity (as defined in offer_validity & expires_at response parameters).
The offer includes details such as the asset to be traded, the fiat currency and the amount either in fiat currency or in units of the asset being traded.
By accommodating both fiat and asset unit denominations, the user experience is enhanced, catering to a wide range of trading preferences and strategies.

The trade offer response outlines the details of the proposed trade, including: asset, amount, price, fees, preliminary tax calculations if applicable, and any warning messages relevant to the user.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢201

application/json

New offer has been created

Body

🟠401

🟠403

🟠404

🟠409

🟠422

🔴500

🔴503

🟠429429

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://test.whitelabel.bitpanda.com/v1/offers' \
--header 'bp-user-id;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "buy",
    "fiat_id": 1,
    "asset_id": 1,
    "amount": "10",
    "amount_defined_for": "fiat",
    "trade_tag": "trade_tag_123"
}'

Response Example

201 - Example 1

{
    "data": {
        "id": "2e4c89ac-1290-426f-8de0-4c7b40b91d3a",
        "type": "buy",
        "fiat_id": 1,
        "asset_id": 1,
        "fiat_amount": "7.25",
        "tax_amount": "2.75",
        "total_amount": "10.00",
        "asset_amount": "0.00448235",
        "asset_price": "2230.97065877",
        "net_asset_price": "2259.97327734",
        "spread": "0.13000000",
        "volume": "10.13",
        "offer_validity": 60,
        "expires_at": "2021-07-01T18:00:09+03:00",
        "time": "2021-07-01T17:59:09+03:00",
        "warning": [
            {
                "message": "Please keep in mind that if you sell your assets now,you will lose your right to receive dividends for the amount you sell !",
                "message_key": "corporate.action.dividend.warning.message.sell",
                "helpdesk_article_id": "360020583999",
                "link_message": "For further information, please visit our helpdesk.",
                "link_message_key": "corporate.action.dividend.warning.link.message"
            },
            {
                "message": "Tax withholding provider is not available",
                "message_key": "tax.withholding.not.available",
                "helpdesk_article_id": "",
                "link_message": "",
                "link_message_key": ""
            },
            {
                "message": "Due to illiquid orderbook price deviates more than 10% to the traded price",
                "message_key": "illiquid.orderbook.price",
                "helpdesk_article_id": "",
                "link_message": "",
                "link_message_key": ""
            }
        ]
    }
}

Get prices V2

Create a trade offer V2