Lexicon Garden

network.attested.payment.initiate

Begin a payment flow. Called by the payer's client against the selected payment servicer using inter-service authentication. Returns an opaque token for status polling and a URL to direct the payer through the payment process in a browser.

Repository @attested.network did:plc:cq3w3bw7awp2rkeswfdzoubb namespace authority
Details · procedure
Kindprocedure
Authoritypayment.attested.network
Indexed
Compare Edit in builder → Fork →
cid bafyreiaxw2khfw22pntrsenov3ar3zooudygydj5qjy4pav4r3jzpat7wy

Checks

Valid
  • unlimited-string defs.main.input.schema.properties.productNo maxLength, maxGraphemes or format limits this string.
  • unlimited-string defs.main.output.schema.properties.tokenNo maxLength, maxGraphemes or format limits this string.
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Begin a payment flow. Called by the payer's client against the selected payment servicer using inter-service authentication. Returns an opaque token for status polling and a URL to direct the payer through the payment process in a browser.",
      "input": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "product": {
              "description": "Product identifier for the payment being initiated. The format is defined by the payment servicer.",
              "type": "string"
            }
          },
          "required": [
            "product"
          ],
          "type": "object"
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "token": {
              "description": "Opaque token used to poll payment status via network.attested.payment.status.",
              "type": "string"
            },
            "url": {
              "description": "URL to direct the payer to in a browser to complete the payment flow (entering payment details, confirming terms, etc).",
              "format": "uri",
              "type": "string"
            }
          },
          "required": [
            "token",
            "url"
          ],
          "type": "object"
        }
      },
      "type": "procedure"
    }
  },
  "id": "network.attested.payment.initiate",
  "lexicon": 1
}