PUT

Update Config

A referência da API está em inglês. Os guias, a autenticação, os webhooks e os códigos de erro estão em português.

Registers, updates or removes the webhook_url for fixed addresses.

The webhook_url field is required: send "" or null to remove the URL. A body without the field is refused with 400 invalid_parameters instead of clearing the stored URL. Returns 403 feature_disabled if the feature is disabled.

PUThttps://bridge.bifrostcrypto.com/v1/fixed-wallets/config

Escopo exigido:wallets:write(chave nova sem lista é somente leitura)

É Preciso a Permissão do Guardião

"Nem todo viajante pode erguer um portão eterno. Para manter um portal aberto e vigiar o seu limiar sem descanso, o guardião vigilante deve primeiro conceder a sua bênção: implore a Heimdall, e só então a sua pedra rúnica perdurará."

Heimdallr Níu-mæðra sonr

Headers

Key	Value	Description
`X-Bifrost-Invoke`	`{{api_key}}`	Private API key
`Content-Type`	`application/json`	-

Body Parameters

Field	Type	Description
`webhook_url`required	`string \| null`	Callback URL for fixed address deposit notifications. Must be a valid, public HTTPS URL (max 756 chars); private or reserved hosts and blocked ports are refused. Send "" or null to remove it.

Request Body

json

{
  "webhook_url": "https://your-site.com/webhook-fixed-wallets"
}

cURL Example

bash

curl -X PUT "https://bridge.bifrostcrypto.com/v1/fixed-wallets/config" \
  -H "X-Bifrost-Invoke: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "webhook_url": "https://your-site.com/webhook-fixed-wallets"
}'

Response Example

json

{
  "message": "fixed_wallets_config_update_success",
  "webhook_url": "https://your-site.com/webhook-fixed-wallets"
}

Errors

Every error has the shape error.code, error.message and, when useful, error.details. Authentication, scope and rate-limit errors (401, 403, 429) apply to every endpoint and are described under Authentication.

Status	Code	When	What to do
400	`invalid_parameters`	webhook_url is missing, not a string or null, not a valid URL, or longer than 756 characters; details.fields explains.	Fix the request before sending it again.
400	`invalid_webhook_url`	The URL is well formed but not allowed (not HTTPS, private address, non-standard port).	Fix the request before sending it again.
403	`feature_disabled`	Fixed addresses are not enabled for the account.	Contact support.
500	`config_update_failed`	The change could not be saved.	Nothing was changed. Retry later.

Outras respostas

Respostas que não são o caminho feliz e ainda assim precisam de tratamento na sua integração.

400

Field missing or invalid

invalid_parameters when webhook_url is absent, is not a string or null, is not a valid URL, or is longer than 756 characters; details.fields.webhook_url explains which. invalid_webhook_url when the URL is well formed but not allowed (not HTTPS, private or reserved address, blocked port). 403 feature_disabled if the feature is off; 500 config_update_failed if the change could not be saved.

json

{
  "error": {
    "code": "invalid_parameters",
    "message": "Invalid parameters provided",
    "details": {
      "fields": {
        "webhook_url": "The webhook_url field is required; send an empty value to remove it."
      }
    }
  }
}