Stellar · Schema

Payment

BlockchainCryptocurrencyDecentralized ExchangeLedgerPaymentsSmart ContractsWeb3

Properties

Name	Type	Description
id	string
amount	string	The amount of the payment
stellar_transaction_id	string	The ID of the transaction in the Stellar network. It can be used tio track the payment in the Stellar network using [Stellar Laboratory](https://laboratory.stellar.org/), or [StellarExpert](https://st
circle_transfer_request_id	string	The Circle transfer request ID. It is only present when the payment was made using Circle.
stellar_operation_id	string
status	object
status_history	object
type	string	The type of the payment.
disbursement	object
asset	object
receiver_wallet	object
external_payment_id	string	Optional external payment identifier provided by the client.
created_at	string
updated_at	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://developers.stellar.org/schemas/sdp/Payment.json",
  "title": "Payment",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "example": "ddf22f55-3259-4822-a4e2-ce01334997f4"
    },
    "amount": {
      "type": "string",
      "description": "The amount of the payment",
      "example": "100.00"
    },
    "stellar_transaction_id": {
      "type": "string",
      "description": "The ID of the transaction in the Stellar network. It can be used tio track the payment in the Stellar network using [Stellar Laboratory](https://laboratory.stellar.org/), or [StellarExpert](https://stellar.expert/).",
      "example": "0b339d1c89d314186b8147c2af4c9a9ed5bbdbcd7ada8d138633907649b"
    },
    "circle_transfer_request_id": {
      "type": "string",
      "description": "The Circle transfer request ID. It is only present when the payment was made using Circle.",
      "example": "74a68b6a-3f67-424b-b8b0-e593a19d7463"
    },
    "stellar_operation_id": {
      "type": "string"
    },
    "status": {
      "$ref": "#/components/schemas/PaymentStatus"
    },
    "status_history": {
      "$ref": "#/components/schemas/PaymentStatusHistory"
    },
    "type": {
      "type": "string",
      "description": "The type of the payment.",
      "enum": [
        "DISBURSEMENT",
        "DIRECT"
      ]
    },
    "disbursement": {
      "$ref": "#/components/schemas/DisbursementLite"
    },
    "asset": {
      "$ref": "#/components/schemas/Asset"
    },
    "receiver_wallet": {
      "$ref": "#/components/schemas/ReceiverWalletLite"
    },
    "external_payment_id": {
      "type": "string",
      "description": "Optional external payment identifier provided by the client.",
      "example": "payment-001"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "example": "2023-02-03T10:45:51Z"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "example": "2023-02-03T10:45:51Z"
    }
  }
}