Skip to Content
BuildBitcoin for AI AgentsConfigure Partner ID

Configure Partner ID

This section covers the environment variables required to attribute native BTC deposits to your integration and enable revenue sharing in production.


What is a Partner ID

A Partner ID is a string that identifies the integrating application to the Lombard backend so deposits can be attributed and (where applicable) revenue-shared. Lombard issues a Partner ID per integration; the default values shown below are non-revenue test partners suitable for development.

Native BTC deposit flows (prepare_btc_to_lbtc_deposit, prepare_btc_to_btcb_deposit) require a Partner ID. Set it explicitly for production traffic to ensure deposits are attributed correctly.


Environment variables

VariableDefaultDescription
LOMBARD_PARTNER_IDlombardtest1Mainnet partner ID for native BTC deposit-address generation.
LOMBARD_TESTNET_PARTNER_IDtest1Testnet partner ID. Mainnet and testnet partner registries are separate.
LOMBARD_BFF_URLhttps://bff.prod.lombard-fi.comBackend API URL.

When a Partner ID is required

Required

Native BTC deposit flows. Both prepare_btc_to_lbtc_deposit and prepare_btc_to_btcb_deposit generate BTC deposit addresses bound to a Partner ID. Set it explicitly for production traffic to ensure deposits are attributed (and revenue-shared) correctly.

The default lombardtest1 is a non-revenue test partner: fine for development, not for production.

Not required

Claim-only flows. prepare_claim_lbtc_deposit and the sdk-agentkit claim_lbtc_deposit action only claim already-notarized deposits. They don’t generate deposit addresses, so they don’t need a Partner ID.


Provisioning a Partner ID

For full Partner ID setup and provisioning, see Configure Partner ID in the SDK docs.

Last updated on