Offer Status Notification

These notifications allow you to receive real-time updates regarding the outcome of an offer. It ensures seamless communication and timely updates enabling you to take necessary actions promptly, like notifying your users or updating their portfolio, without the need to poll GET /v1/offer-status/{offer-id}.
The events include the following statuses:

Finished - Indicates that the offer has been successfully executed and a trade was created. Use asset_amount and fiat_amount to reflect the executed amounts in your system.

Failed - Indicates that the offer could not be executed and no funds were moved. Use fail_reason to determine the cause and notify your user accordingly.

Examples

1. Finished

{
  "params": {
    "user_id": "1ef2efc7-1d0c-658b-8bdb-7398fd6afe94",
    "offer_id": "01ef52f5-9f60-60e1-8165-8a61e573af23",
    "trade_id": "01ef5401-cf20-6165-b0cb-3e1e8185fb3c",
    "asset_id": "a49406ee-ee33-11ec-aafe-062d595118ef",
    "fiat_id": "ea96ccef-edee-11eb-9bf0-06502b1fe55d",
    "asset_amount": "2.43667276",
    "fiat_amount": "1",
    "type": "buy",
    "status": "finished",
    "fail_reason": null,
    "created_at": "2024-08-06T14:40:21.848515Z",
    "updated_at": "2024-08-06T14:40:21.848515Z",
    "external_trade_id": "partner-order-12345"
  }
}

2. Failed (insufficient funds)

{
  "params": {
    "user_id": "1ef2efc7-1d0c-658b-8bdb-7398fd6afe94",
    "offer_id": "01ef52f5-9f60-60e1-8165-8a61e573af23",
    "trade_id": null,
    "asset_id": "a49406ee-ee33-11ec-aafe-062d595118ef",
    "fiat_id": "ea96d0fc-edee-11eb-9bf0-06502b1fe55d",
    "asset_amount": null,
    "fiat_amount": null,
    "type": "buy",
    "status": "failed",
    "fail_reason": "insufficient_funds",
    "created_at": "2024-08-05T06:40:36.612535Z",
    "updated_at": "2024-08-06T14:40:21.848515Z",
    "external_trade_id": null
  }
}

3. Failed (trade failure)

{
  "params": {
    "user_id": "1ef2efc7-1d0c-658b-8bdb-7398fd6afe94",
    "offer_id": "01ef52f5-9f60-60e1-8165-8a61e573af23",
    "trade_id": null,
    "asset_id": "a49406ee-ee33-11ec-aafe-062d595118ef",
    "fiat_id": "ea96d0fc-edee-11eb-9bf0-06502b1fe55d",
    "asset_amount": null,
    "fiat_amount": null,
    "type": "sell",
    "status": "failed",
    "fail_reason": "trade.failure",
    "created_at": "2024-08-05T06:40:36.612535Z",
    "updated_at": "2024-08-06T14:40:21.848515Z",
    "external_trade_id": null
  }
}

curl --location 'https://your-api-server.com' \ --header 'X-BTS-Idempotency-Key;' \ --header 'Signature;' \ --header 'Content-Digest;' \ --header 'Date;' \ --header 'Content-Type: application/json' \ --data '{ "params": { "user_id": "1ef2efc7-1d0c-658b-8bdb-7398fd6afe94", "offer_id": "01ef52f5-9f60-60e1-8165-8a61e573af23", "trade_id": "01ef5401-cf20-6165-b0cb-3e1e8185fb3c", "asset_id": "a49406ee-ee33-11ec-aafe-062d595118ef", "fiat_id": "ea96ccef-edee-11eb-9bf0-06502b1fe55d", "asset_amount": "2.43667276", "fiat_amount": "1", "type": "buy", "status": "finished", "fail_reason": null, "created_at": "2024-08-06T14:40:21.848515Z", "updated_at": "2024-08-06T14:40:21.848515Z", "external_trade_id": "partner-order-12345" } }'

Examples

1. Finished

2. Failed (insufficient funds)

3. Failed (trade failure)

Request

Responses

Offer Status Notification

Examples#

1. Finished#

2. Failed (insufficient funds)#

3. Failed (trade failure)#

Request

Responses

Examples

1. Finished

2. Failed (insufficient funds)

3. Failed (trade failure)