Declare self-hosted counterparty

Creates a DECLARED self-hosted counterparty for the given owner (userId or businessId) and application.

Wallet ownership for subType OWNED is proven separately via POST /counterparty/self-hosted/verify-wallet. The signed message format and UTC date rules for that flow are documented on VerifySelfHostedWalletRequest.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Declare a self-hosted counterparty. Provide exactly one owner (userId/businessId) and exactly one identifier (counterpartyAddress/paymentHash/invoice). Wallet ownership is proven separately via POST /counterparty/self-hosted/verify-wallet.

uuid

Owner user id. Provide exactly one of userId / businessId.

uuid

Owner business id. Provide exactly one of userId / businessId.

string

On-chain destination address. Provide exactly one of counterpartyAddress / paymentHash / invoice.

string

Lightning payment hash (64-hex on BTC). Provide exactly one of counterpartyAddress / paymentHash / invoice.

string

bolt11 invoice (decoded server-side to a payment hash). Provide exactly one of counterpartyAddress / paymentHash / invoice.

string
required

Ledger currency ticker (e.g. SOL, POL, ETH). Must be a supported LedgerCryptoNetworks key.

string
required

Blockchain network for the currency (e.g. SOL, POLYGON, ETH). Must equal the network implied by currency.

string
enum
required

OWNED or THIRD_PARTY self-hosted counterparty.

Allowed:
string
enum
Allowed:
string
string
date
^\d{4}-\d{2}-\d{2}$

ISO 8601 date string (YYYY-MM-DD).

string
string
^[A-Z]{2}$

ISO 3166-1 alpha-2 country code (two uppercase letters).

string
length ≤ 500
string
string
^[A-Z0-9]{20}$

Legal Entity Identifier (20-character alphanumeric).

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json