Loads a specified transaction

GET /V1/transactions/{id}

Loads a specified transaction.

Path parameters

  • id integer Required

    The transaction ID.

Responses

  • 200 Success.

    Hide response attributes Show response attributes object

    Transaction interface. A transaction is an interaction between a merchant and a customer such as a purchase, a credit, a refund, and so on.

    • transaction_id integer Required

      Transaction ID.

    • parent_id integer

      The parent ID for the transaction. Otherwise, null.

    • order_id integer Required

      Order ID.

    • payment_id integer Required

      Payment ID.

    • txn_id string Required

      Transaction business ID.

    • parent_txn_id string Required

      Parent transaction business ID.

    • txn_type string Required

      Transaction type.

    • is_closed integer Required

      Is-closed flag value.

    • Array of additional information. Otherwise, null.

    • created_at string Required

      Created-at timestamp.

    • child_transactions array[object] Required

      Transaction interface. A transaction is an interaction between a merchant and a customer such as a purchase, a credit, a refund, and so on.

      Transaction interface. A transaction is an interaction between a merchant and a customer such as a purchase, a credit, a refund, and so on.

      Transaction interface. A transaction is an interaction between a merchant and a customer such as a purchase, a credit, a refund, and so on.

    • ExtensionInterface class for @see \Magento\Sales\Api\Data\TransactionInterface

  • 401 Unauthorized

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Error details

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters item

        Hide parameters attributes Show parameters attributes object

        Error parameters item

    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Hide parameters attributes Show parameters attributes object

      Error parameters item

    • trace string

      Stack trace

  • Unexpected error

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Error details

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters item

        Hide parameters attributes Show parameters attributes object

        Error parameters item

    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Hide parameters attributes Show parameters attributes object

      Error parameters item

    • trace string

      Stack trace

GET /V1/transactions/{id}
curl \
 -X GET https://magento2.winkelstraat.mac/rest/all/V1/transactions/{id}
Response examples (200)
{
  "transaction_id": 42,
  "parent_id": 42,
  "order_id": 42,
  "payment_id": 42,
  "txn_id": "string",
  "parent_txn_id": "string",
  "txn_type": "string",
  "is_closed": 42,
  "additional_information": [
    "string"
  ],
  "created_at": "string",
  "child_transactions": [
    {}
  ],
  "extension_attributes": {}
}
Response examples (401)
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}
Response examples (default)
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}