Get a counterparty by identifier

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

Look up a declared counterparty. Exactly one owner + exactly one identifier.

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

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

Responses

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