agents

Turn the DePix direct rail on or off

Registers (or removes) the dedicated confidential Liquid address the agent's merchant is paid at on the DePix rail, so its checkouts can be paid in DePix on-chain instead of only by Pix. Auth is the agent keypair signature — the human twin of this endpoint is password-gated dashboard surface, which an agent account can never satisfy. Enabling requires the address AND its blinding private key: the key is proof of possession (the address is rebuilt from it and must match) and it is the ONLY thing that lets us read the amounts arriving there. It is sealed at rest and never returned. The address must be confidential (lq1…) and exclusive — the payout and split addresses are refused. Disabling takes no key and deletes the grant; an address with a DePix payment still in flight keeps its key until that checkout is terminal. Requires a verified account (for an agent, that is the domain proof) and rejects a suspended merchant.

post/api/agents/depix-pay

Request

  • Base URL: https://api.depixapp.com
  • URL: https://api.depixapp.com/api/agents/depix-pay
  • Auth: none required

Request body

enabledboolean required

true → register the dedicated address and start watching it. false → turn the rail off and delete the view key (no other field is read, and none is required).

addressstring

The dedicated CONFIDENTIAL Liquid address (lq1…) this merchant will be paid at. Required when enabled is true. An unconfidential ex1/base58 address is refused: it would publish every amount received to the whole world. It must also be exclusive — never the merchant's payout or split address.

blinding_keystring

The 32-byte blinding PRIVATE key of that address, hex. It grants visibility of the amounts arriving at that ONE script and nothing else: no spending power, no other address, no descriptor. Sent once, stored sealed, and deleted when the rail is turned off.

derivation_indexinteger nullable

Optional wallet derivation index of the address, echoed back so the wallet can keep the index reserved across a restore. Non-negative integer.

Response

The rail's new state.

Changes

No recorded changes to this operation across all 1 revision of this API.