Create a swap offer

By submitting a request to this endpoint, users can propose a swap offer, where they specify the assets they would like to exchange and the amount of units, either from the source or from the target asset. The request triggers the creation of a swap offer that can later be accepted by the user within its validity (as defined in swap_offer_validity & expires_at response parameters).

The users can swap any asset that is present in their portfolio to any other supported digital asset on our platform. When swapping an asset, it is first sold as a fiat token (F-Token) before the desired asset is bought. This happens to avoid price fluctuations.

SecuritybearerAuth
Request
header Parameters
bp-user-id
required
string <uuid>

User ID

Request Body schema: application/json

The swap offer to be created.

source_asset_id
required
integer

The unique identifier of the asset to be sold when the swap is executed.

target_asset_id
required
integer

The unique identifier of the target asset to be acquired when the swap is executed.

amount
required
string non-empty ^[0-9]+(\.[0-9]{1,8})?$

The quantity of the asset involved in the swap transaction. The specific amount will depend on the context defined by the 'amount_defined_for' parameter.

amount_defined_for
required
string

Specifies the context for the 'amount' parameter. If set to 'source', the 'amount' refers to the quantity or value of the 'source_asset_id' to be sold or exchanged. If set to 'target', the 'amount' refers to the quantity or value of the 'target_asset_id' to be acquired during the swap execution.

Enum: "source" "target"
Responses
201

Success Response (New offer has been created)

401

Unauthorized

403

Forbidden

405

Not Allowed

410

Gone

422

Validation Errors

429

Too Many Requests

500

Internal Error

503

Maintenance or Service unavailable

post/v1/swaps
Request samples
application/json
{
  • "source_asset_id": 1,
  • "target_asset_id": 2,
  • "amount": "1.00000001",
  • "amount_defined_for": "source"
}
Response samples
application/json
{
  • "data": {
    }
}