Loads a specified transaction

GET /V1/transactions/{id}

Loads a specified transaction.

Path parameters

id integer Required

The transaction ID.

Responses

200

application/json

application/json application/xml

200 Success.
Hide response attributes Show response attributes object
- 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.
- additional_information array[string]
  
  Array of additional information. Otherwise, null.
- created_at string Required
  
  Created-at timestamp.
- child_transactions array[object] Required
  
  Array of child transactions.
  
  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.
- extension_attributes object
  
  ExtensionInterface class for @see \Magento\Sales\Api\Data\TransactionInterface
Hide response attributes Show response attributes object
- 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.
- additional_information array[string]
  
  Array of additional information. Otherwise, null.
- created_at string Required
  
  Created-at timestamp.
- child_transactions array[object] Required
  
  Array of child transactions.
  
  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.
- extension_attributes object
  
  ExtensionInterface class for @see \Magento\Sales\Api\Data\TransactionInterface
401

application/json

application/json application/xml

401 Unauthorized
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Errors list
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Errors list
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
default

application/json

application/json application/xml

Unexpected error
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Errors list
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Errors list
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace

GET /V1/transactions/{id}

curl \
 --request 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 (200)

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <transaction-id type="integer">42</transaction-id>
  <parent-id type="integer">42</parent-id>
  <order-id type="integer">42</order-id>
  <payment-id type="integer">42</payment-id>
  <txn-id>string</txn-id>
  <parent-txn-id>string</parent-txn-id>
  <txn-type>string</txn-type>
  <is-closed type="integer">42</is-closed>
  <additional-information type="array">
    <additional-information>string</additional-information>
  </additional-information>
  <created-at>string</created-at>
  <child-transactions type="array">
    <child-transaction>
    </child-transaction>
  </child-transactions>
  <extension-attributes>
  </extension-attributes>
</root>

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 (401)

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <message>string</message>
  <errors type="array">
    <error>
      <message>string</message>
      <parameters type="array">
        <parameter>
          <resources>string</resources>
          <fieldName>string</fieldName>
          <fieldValue>string</fieldValue>
        </parameter>
      </parameters>
    </error>
  </errors>
  <code type="integer">42</code>
  <parameters type="array">
    <parameter>
      <resources>string</resources>
      <fieldName>string</fieldName>
      <fieldValue>string</fieldValue>
    </parameter>
  </parameters>
  <trace>string</trace>
</root>

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"
}

Response examples (default)

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <message>string</message>
  <errors type="array">
    <error>
      <message>string</message>
      <parameters type="array">
        <parameter>
          <resources>string</resources>
          <fieldName>string</fieldName>
          <fieldValue>string</fieldValue>
        </parameter>
      </parameters>
    </error>
  </errors>
  <code type="integer">42</code>
  <parameters type="array">
    <parameter>
      <resources>string</resources>
      <fieldName>string</fieldName>
      <fieldValue>string</fieldValue>
    </parameter>
  </parameters>
  <trace>string</trace>
</root>