SEP-31

Generate Unique Address

GET 
/unique_address

If the platform is configured with depositInfoGeneratorType: api, the Platform make this request to the Anchor backend every time a transaction is initiated by a client application.

The Anchor must guarantee that the memo returned in this request is unique, so it can be mapped 1-to-1 to a Platform resource such as a SEP-31 transaction.

Here is how this flow would be used for Receiving Anchors that need to create their unique (account, memo) pairs outside the platform, using Circle:

Request

Query Parameters

transaction_id stringrequired

The platform server will save the posted transaction and pass the transaction_id through this endpoint. If the anchor wishes to return transaction-dependent unique_address, the anchor may query the GET /transactions endpoint of the Platform API.

Responses

200

Success.

application/json

Schema

Schema

unique_address

object

An object containing the unique stellar_address:memo pair used to identify a destination.

stellar_addressstringrequired

A G... stellar address or a M... muxed stellar address of an existing account in the Stellar network.

memostring

The memo to attach to the Stellar payment.

memo_typestring

The type of memo to attach to the Stellar payment (text, hash, or id).

Possible values: [text, hash, id]

Example (from schema)

{
  "unique_address": {
    "stellar_address": "string",
    "memo": "string",
    "memo_type": "text"
  }
}

500

Error. The Platform will respond to the client application with the same response code and body.

application/json

Schema

Schema

errorstringrequired
idstring

Example (from schema)

{
  "error": "string",
  "id": "string"
}