PayPal · Schema

Transaction Information

The information about the disputed transaction.

BillingCommerceDisputesInvoicesOrdersPaymentsPayoutsSubscriptionsTokensWebhooks

Properties

Name	Type	Description
buyer_transaction_id	string	The ID, as seen by the customer, for this transaction.
seller_transaction_id	string	The ID, as seen by the merchant, for this transaction.
reference_id	string	The ID, as seen by the partner, for this transaction.
create_time	object	The date and time when the transaction was created, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). For example, `yyyy`-`MM`-`dd``T``HH`:`mm`:`ss`.*`SS
transaction_status	string	The transaction status.
gross_amount	object	The gross amount of the transaction.
gross_asset	object	The gross asset of the transaction.
invoice_number	string	The ID of the invoice for the payment.
custom	string	A free-text field that is entered by the merchant during checkout.
buyer	object
seller	object
items	array	An array of items that were purchased as part of the transaction.
payment_processor	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/transaction_info",
  "title": "Transaction Information",
  "type": "object",
  "description": "The information about the disputed transaction.",
  "properties": {
    "buyer_transaction_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255,
      "description": "The ID, as seen by the customer, for this transaction.",
      "pattern": "^[A-Za-z0-9-]+$"
    },
    "seller_transaction_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255,
      "description": "The ID, as seen by the merchant, for this transaction.",
      "pattern": "^[A-Za-z0-9-]+$"
    },
    "reference_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255,
      "description": "The ID, as seen by the partner, for this transaction.",
      "pattern": "^[A-Za-z0-9-]+$"
    },
    "create_time": {
      "description": "The date and time when the transaction was created, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). For example, *`yyyy`*-*`MM`*-*`dd`*`T`*`HH`*:*`mm`*:*`ss`*.*`SSS`*`Z`.",
      "$ref": "#/components/schemas/date_time"
    },
    "transaction_status": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255,
      "pattern": "^[0-9A-Z_]+$",
      "description": "The transaction status.",
      "enum": [
        "COMPLETED",
        "UNCLAIMED",
        "DENIED",
        "FAILED",
        "HELD",
        "PENDING",
        "PARTIALLY_REFUNDED",
        "REFUNDED",
        "REVERSED",
        "CANCELLED"
      ]
    },
    "gross_amount": {
      "description": "The gross amount of the transaction.",
      "$ref": "#/components/schemas/money"
    },
    "gross_asset": {
      "description": "The gross asset of the transaction.",
      "$ref": "#/components/schemas/cryptocurrency"
    },
    "invoice_number": {
      "type": "string",
      "minLength": 1,
      "maxLength": 127,
      "description": "The ID of the invoice for the payment.",
      "pattern": "^[A-Za-z0-9:\\-|]+$"
    },
    "custom": {
      "type": "string",
      "minLength": 1,
      "maxLength": 2000,
      "description": "A free-text field that is entered by the merchant during checkout."
    },
    "buyer": {
      "$ref": "#/components/schemas/buyer"
    },
    "seller": {
      "$ref": "#/components/schemas/seller"
    },
    "items": {
      "type": "array",
      "minItems": 1,
      "maxItems": 100,
      "readOnly": true,
      "description": "An array of items that were purchased as part of the transaction.",
      "items": {
        "$ref": "#/components/schemas/item_info"
      }
    },
    "payment_processor": {
      "$ref": "#/components/schemas/payment_processor"
    }
  }
}