v11

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-08-017364211.0 KB

Registration

Request Registration URL

The deposit endpoint allows a wallet to get deposit information from an anchor, so a user has all the information needed to initiate a deposit.

It also lets the anchor specify additional information that the user must submit interactively via a popup or embedded browser window to be able to deposit. Please check the detailed documentation here.

post/sep24/transactions/deposit/interactive

Request body

asset_codestring required

Stellar asset code for the deposit.

accountstring

Stellar account for the deposit; defaults to the SEP-10 subject.

langstring

Language for the interactive flow.

claimable_balance_supportedstring

Indicates if claimable balances are supported.

Response

An anchor requires the user to fill out information on a webpage hosted by the anchor.

typestring

Always set to interactive_customer_info_needed.

urlstring

URL hosted by the anchor. The wallet should show this URL to the user as a popup.

idstring

The anchor's internal ID for this deposit / withdrawal request. The wallet will use this ID to query the /transaction endpoint to check status of the request.

Example response

{
  "type": "interactive_customer_info_needed",
  "url": "https://api.example.com/kycflow?account=GACW7NONV43MZIFHCOKCQJAKSJSISSICFVUJ2C6EZIW5773OU3HD64VI",
  "id": "82fhs729f63dh0v4"
}