Coinbase · Schema

Payment

A payment received for a charge

BlockchainCryptocurrencyCustodyExchangeOnrampPaymentsTradingWalletWeb3

Properties

Name Type Description
network string Blockchain network
transaction_id string Blockchain transaction ID
status string Payment status
value object Payment value
block object Block information
View JSON Schema on GitHub

JSON Schema

coinbase-payment-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Payment",
  "title": "Payment",
  "type": "object",
  "description": "A payment received for a charge",
  "properties": {
    "network": {
      "type": "string",
      "description": "Blockchain network"
    },
    "transaction_id": {
      "type": "string",
      "description": "Blockchain transaction ID"
    },
    "status": {
      "type": "string",
      "description": "Payment status",
      "enum": [
        "PENDING",
        "CONFIRMED",
        "FAILED"
      ]
    },
    "value": {
      "type": "object",
      "description": "Payment value",
      "properties": {
        "amount": {
          "type": "string",
          "description": "Payment amount"
        },
        "currency": {
          "type": "string",
          "description": "Currency"
        }
      }
    },
    "block": {
      "type": "object",
      "description": "Block information",
      "properties": {
        "height": {
          "type": "integer",
          "description": "Block height"
        },
        "hash": {
          "type": "string",
          "description": "Block hash"
        },
        "confirmations_required": {
          "type": "integer",
          "description": "Required confirmations"
        },
        "confirmations": {
          "type": "integer",
          "description": "Current confirmations"
        }
      }
    }
  }
}