Stellar · Schema

CreateDirectPaymentRequest

BlockchainCryptocurrencyDecentralized ExchangeLedgerPaymentsSmart ContractsWeb3

Properties

Name	Type	Description
amount	string	The payment amount
asset	object	Asset reference - specify either id or type with required fields
receiver	object	Receiver reference - specify exactly one identifier
wallet	object	Wallet reference - specify either id or address
external_payment_id	string	Optional external payment identifier

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://developers.stellar.org/schemas/sdp/CreateDirectPaymentRequest.json",
  "title": "CreateDirectPaymentRequest",
  "type": "object",
  "required": [
    "amount",
    "asset",
    "receiver",
    "wallet"
  ],
  "properties": {
    "amount": {
      "type": "string",
      "description": "The payment amount"
    },
    "asset": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Asset ID (use either id or type)"
        },
        "type": {
          "type": "string",
          "enum": [
            "native",
            "classic",
            "contract",
            "fiat"
          ],
          "description": "Asset type (use either id or type)"
        },
        "code": {
          "type": "string",
          "description": "Asset code (required for classic and fiat assets)"
        },
        "issuer": {
          "type": "string",
          "description": "Asset issuer address (required for classic assets)"
        },
        "contract_id": {
          "type": "string",
          "description": "Contract ID (required for contract assets)"
        }
      },
      "description": "Asset reference - specify either id or type with required fields"
    },
    "receiver": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Receiver ID"
        },
        "email": {
          "type": "string",
          "description": "Receiver email address"
        },
        "phone_number": {
          "type": "string",
          "description": "Receiver phone number"
        },
        "wallet_address": {
          "type": "string",
          "description": "Receiver wallet address (Stellar account or contract)"
        }
      },
      "description": "Receiver reference - specify exactly one identifier"
    },
    "wallet": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Wallet ID"
        },
        "address": {
          "type": "string",
          "description": "Wallet address (Stellar account or contract)"
        }
      },
      "description": "Wallet reference - specify either id or address"
    },
    "external_payment_id": {
      "type": "string",
      "description": "Optional external payment identifier"
    }
  }
}