Transactions

Get a transaction by ID

Get a transaction by ID

get/api/v1/transactions/{id}

Path parameters

idstring uuid required

The unique identifier of the transaction

Example:123e4567-e89b-12d3-a456-426614174000

The unique identifier of the transaction

Response

Success

successboolean required

Example response

{
  "data": {
    "currency": {
      "code": "GBP",
      "symbol": "€",
      "name": "Euro",
      "minor_unit": 2
    },
    "payout_currency": {
      "code": "GBP",
      "symbol": "€",
      "name": "Euro",
      "minor_unit": 2
    },
    "payment_request": {
      "order_id": "ORD-2025-00123",
      "payment_token": "tok_abc123def456"
    },
    "merchant_webhook_deliveries": [
      {
        "event_type": "quidkey.payment_request.succeeded"
      }
    ],
    "fees": {
      "currency": {
        "code": "GBP",
        "symbol": "€",
        "name": "Euro",
        "minor_unit": 2
      },
      "items": [
        {
          "currency": {
            "code": "GBP",
            "symbol": "€",
            "name": "Euro",
            "minor_unit": 2
          }
        }
      ]
    },
    "refunds": [
      {
        "currency": {
          "code": "GBP",
          "symbol": "€",
          "name": "Euro",
          "minor_unit": 2
        },
        "payout_currency": {
          "code": "GBP",
          "symbol": "€",
          "name": "Euro",
          "minor_unit": 2
        },
        "payment_request": {
          "order_id": "ORD-2025-00123",
          "payment_token": "tok_abc123def456"
        },
        "merchant_webhook_deliveries": [
          {
            "event_type": "quidkey.payment_request.succeeded"
          }
        ],
        "fees": {
          "currency": {
            "code": "GBP",
            "symbol": "€",
            "name": "Euro",
            "minor_unit": 2
          },
          "items": [
            {
              "currency": {
                "code": "GBP",
                "symbol": "€",
                "name": "Euro",
                "minor_unit": 2
              }
            }
          ]
        }
      }
    ],
    "reversals": [
      {
        "currency": {
          "code": "GBP",
          "symbol": "€",
          "name": "Euro",
          "minor_unit": 2
        },
        "payout_currency": {
          "code": "GBP",
          "symbol": "€",
          "name": "Euro",
          "minor_unit": 2
        },
        "payment_request": {
          "order_id": "ORD-2025-00123",
          "payment_token": "tok_abc123def456"
        },
        "merchant_webhook_deliveries": [
          {
            "event_type": "quidkey.payment_request.succeeded"
          }
        ],
        "fees": {
          "currency": {
            "code": "GBP",
            "symbol": "€",
            "name": "Euro",
            "minor_unit": 2
          },
          "items": [
            {
              "currency": {
                "code": "GBP",
                "symbol": "€",
                "name": "Euro",
                "minor_unit": 2
              }
            }
          ]
        }
      }
    ]
  }
}

Changes

Changed in 3 of the 8 revisions of this API.2622

  • b372e7d5563d1621See the full diff
    • the error/code response's property type/format changed from string/ to / for status 400

      response-property-type-changed

    • removed the optional property error/errors from the response with the 400 status

      response-optional-property-removed

    • added the new converted enum value to the data/status response property for the response status 200

      response-property-enum-value-added

    • added the new fee_paid enum value to the data/status response property for the response status 200

      response-property-enum-value-added

    • added the new received enum value to the data/status response property for the response status 200

      response-property-enum-value-added

    • added the new reversal enum value to the data/transaction_type response property for the response status 200

      response-property-enum-value-added

    • added the new unknown enum value to the data/status response property for the response status 200

      response-property-enum-value-added

    • added the optional property data/problems to the response with the 200 status

      response-optional-property-added

    • added the optional property data/refunds to the response with the 200 status

      response-optional-property-added

    • added the optional property data/reversals to the response with the 200 status

      response-optional-property-added

    • added the optional property data/target_status to the response with the 200 status

      response-optional-property-added

    • added the optional property error/metadata to the response with the 400 status

      response-optional-property-added

    • added subschema #1 subschema #2 to the error/code response property allOf list for the response status 400

      response-property-all-of-added

    • removed the processing enum value from the data/status response property for the response status 200

      response-property-enum-value-removed

    • the data/currency/code response's property pattern ^[A-Za-z]{3}$ was added for the status 200

      response-property-pattern-added

    • the data/fees/currency/code response's property pattern ^[A-Za-z]{3}$ was added for the status 200

      response-property-pattern-added

    • the data/fees/items/items/currency/code response's property pattern ^[A-Za-z]{3}$ was added for the status 200

      response-property-pattern-added

    • added the required property data/can_refund to the response with the 200 status

      response-required-property-added

    • added the required property data/converted_amount to the response with the 200 status

      response-required-property-added

    • added the required property data/exchange_rate to the response with the 200 status

      response-required-property-added

    • added the required property data/merchant_webhook_deliveries to the response with the 200 status

      response-required-property-added

    • added the required property data/payment_request/anyOf[subschema #1]/authorization_agreement_record_id to the response with the 200 status

      response-required-property-added

    • added the required property data/payout_at to the response with the 200 status

      response-required-property-added

    • added the required property data/payout_batch_id to the response with the 200 status

      response-required-property-added

    • added the required property data/payout_currency to the response with the 200 status

      response-required-property-added

    • added the required property data/platform to the response with the 200 status

      response-required-property-added

    • added the required property data/provider_status_events to the response with the 200 status

      response-required-property-added

    • added the required property data/refund_status to the response with the 200 status

      response-required-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • endpoint added

      endpoint-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 367 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog