For the complete documentation index, see llms.txt. This page is also available as Markdown.

Send

Before send

When the user scans a QR or pastes a destination, pass that string to the SDK. Scan and paste are the same call. No Branta account.

Install from the SDK page. Use staging until you go live.

Destination
Pass

On-chain Bitcoin

A bitcoin: URI with branta_id and branta_secret. A bare address is unknown.

bolt11, Ark, silent payment

The value (ark1 / tark1, sp1 / tsp1).

Unified BIP-21

The full URI. Do not split.

Status handling

Status
When
Do

match

Destination is in Branta

Show name and logo. Link to verifyUrl.

unknown

Not in Branta, including 404

Show nothing.

tampered

Destination was altered

Warn. Do not show a verified card.

incomplete

5xx, 429, or unreachable

Tell the user Branta could not complete the check. Do not block send.

Payment history

Once a payment resolves to a counterparty, render the counterparty name and logo in your transaction history, too.

This is recommended for all send integrations:

  • Persist at send time. When the send-flow lookup returns a match, store the counterparty name and logo on your transaction record. History rendering is then a local read — no extra network calls, and it works offline.

  • Make it searchable. Include the stored counterparty name in whatever your history search already indexes. Search stays local — the field is already on the record.

Test your integration

Scan the production or staging QR codes. Match the environment your SDK is pointed at. Each tab says the status to expect.

After a match, confirm the counterparty still shows in payment history, and that searching for that name finds it.

Last updated