Paginate through all payment transactions Beta

GET /2026-2/payment-transactions
Oauth2 Oauth2

Paginate through all payment transactions that are available based in the current authentication context.

Query parameters

  • filter object | string

    The filter(s) to apply to the payment transactions.

  • page object | string

    The pagination information for the request.

Responses

  • 200 application/json

    Retrieved a page of payment transactions successfully.

    Hide response attribute Show response attribute object
    • data array[object] Required

      The page of payment transactions

      Hide data attributes Show data attributes object
      • authorizationType string Required

        The type of the authorization for the transaction. Either PENDING if the authorized amount is a temporary hold on the user's funds, or FINAL if the authorized amount is the final amount that will be charged to the user.

        Values are PARTIAL or FINAL.

      • authorizedAmount string(decimal) | null Required

        The amount that was authorized from the payment transaction. This is the amount that was requested to be charged to the user.

        Minimum value is 0.

      • authorizedAt string(date-time) | null Required

        The date and time when the payment transaction was authorized

      • cancelledAt string(date-time) | null Required

        The timestamp when the transaction was cancelled. This field is only set if the transaction was cancelled.

      • capturedAmount string(decimal) | null Required

        The amount that was captured from the payment transaction. This is the amount that was actually charged to the user.

        Minimum value is 0.

      • capturedAt string(date-time) | null Required

        The date and time when the payment transaction was captured

      • cartId string(uuid) Required

        The unique identifier of the cart associated with the payment transaction.

      • clientId string Required

        The identifier of the client that authorized the payment transaction.

      • createdAt string(date-time) Required

        The date and time when the payment transaction was created

      • currency string Required

        The currency of the transaction.

      • failedAt string(date-time) | null Required

        The timestamp when the transaction failed. This field is only set if the transaction failed.

      • failureCode string | null Required

        The failure code of the transaction. This field is only set if the transaction failed.

        Values are PAYMENT_METHOD_EXPIRED, INVALID_CARD_NUMBER, INSUFFICIENT_FUNDS, FRAUD_DETECTED, RESTRICTED_CARD, WITHDRAWAL_LIMIT_EXCEEDED, WITHDRAWAL_FREQUENCY_LIMIT_EXCEEDED, INVALID_METADATA, or UNKNOWN.

      • id string(uuid) Required

        The unique identifier of the payment transaction

      • kind string Required

        The kind of the payment method used for this transaction.

      • paymentMethodId string(uuid) Required

        The unique identifier of the payment method used for the transaction

      • poi object Required

        The point of interaction (POI) where the transaction took place.

        Hide poi attributes Show poi attributes object
        • address object Required

          The address of the point of interest (POI) associated with the payment transaction.

          Hide address attributes Show address attributes object
          • city string Required

            The city of the POI address.

          • country string Required

            The country of the POI address.

          • houseNumber string | null Required

            The house number of the POI address.

          • postalCode string Required

            The postal code of the POI address.

          • street string Required

            The street name of the POI address.

        • id string(uuid) Required

          The unique identifier of the point of interest (POI) associated with the payment transaction.

        • name string Required

          The name of the point of interest (POI).

      • products object Required

        A list of products that are part of the transaction. Useful for reporting purposes like receipts.

        One of:
        CANCELLED object CONFIGURED object CONFIGURING object
      • proxy boolean Required

        Determines whether the payment transaction is a proxy transaction.

      • status string Required

        The current status of the payment transaction.

        Values are AUTHORIZING, AUTHORIZING_ACTIONS_REQUIRED, AUTHORIZING_FAILED, AUTHORIZING_CANCELLED, AUTHORIZED, AUTHORIZED_CANCELLING, AUTHORIZED_CANCELLING_FAILED, AUTHORIZED_CANCELLED, CAPTURING, CAPTURING_FAILED, CAPTURING_CANCELLED, or CAPTURED.

      • summary object Required

        The summary of the transaction, including the total amounts from each product.

        Hide summary attributes Show summary attributes object
        • currency string Required

          The currency of the transaction. This value matches the currency of each product in the transaction.

        • totalAmountExcludingVAT string(decimal) Required

          The total transaction amount excluding VAT.

          Minimum value is 0.

        • totalAmountIncludingVAT string(decimal) Required

          The total transaction amount including VAT.

          Minimum value is 0.

        • vatAmount string(decimal) Required

          The total VAT amount for the transaction.

          Minimum value is 0.

      • updatedAt string(date-time) Required

        The date and time when the payment transaction was last updated

      • userId string(uuid) Required

        The unique identifier of the user associated with the payment transaction.
  • 401

    Client authentication failed.

  • 403

    Missing one or more required scopes.

  • 500

    An internal server error occurred.

GET /2026-2/payment-transactions 
curl \
 --request GET 'https://api.pace.cloud/payment/2026-2/payment-transactions' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "data": [
    {
      "authorizationType": "PARTIAL",
      "authorizedAmount": "120.00",
      "authorizedAt": "2023-10-01T12:00:00.000Z",
      "cancelledAt": "2023-10-01T12:00:00.000Z",
      "capturedAmount": "46.87",
      "capturedAt": "2023-10-01T12:00:00.000Z",
      "cartId": "317643aa-b684-44de-873c-a72d9ed766ee",
      "clientId": "pace-drive-app",
      "createdAt": "2023-10-01T12:00:00.000Z",
      "currency": "EUR",
      "failedAt": "2023-10-01T12:00:00.000Z",
      "failureCode": "INSUFFICIENT_FUNDS",
      "id": "6fc2acbd-3afd-4df3-9967-836a7929b13f",
      "kind": "FUEL_CARD_PROVIDER",
      "paymentMethodId": "b4fd81c9-8969-4323-98b7-855a7d7f0d60",
      "poi": {
        "address": {
          "city": "Karlsruhe",
          "country": "DE",
          "houseNumber": "18",
          "postalCode": "76131",
          "street": "Haid-und-Neu-Straße"
        },
        "id": "154e01ae-557a-48b3-a68a-609f1507db1d",
        "name": "PACE Fuel Station"
      },
      "products": {
        "buyerId": "0151f0e1-f932-4d3a-9e2a-0f3818b8cb1c",
        "configurations": {
          "label": "Pump Number",
          "name": "PUMP_NUMBER",
          "type": "INPUT",
          "value": "100.00"
        },
        "contractId": "3fc6db3b-615c-4db2-9d86-c37e9df8ae47",
        "currency": "EUR",
        "id": "8394e4df-95f6-4b9e-87da-4982c0aaec4b",
        "label": "Fueling",
        "priceExcludingVAT": "61.34",
        "priceIncludingVAT": "72.99",
        "pricePerUnitExcludingVAT": "1.596",
        "pricePerUnitIncludingVAT": "1.899",
        "quantity": "38.62",
        "status": "CANCELLED",
        "supplierId": "1dd3721c-7c7b-4acb-8adc-e027267f603c",
        "type": "FUELING",
        "unit": "LITER",
        "vatAmount": "13.63",
        "vatRate": "0.19"
      },
      "proxy": true,
      "status": "CAPTURED",
      "summary": {
        "currency": "EUR",
        "totalAmountExcludingVAT": "88.90",
        "totalAmountIncludingVAT": "104.84",
        "vatAmount": "15.94"
      },
      "updatedAt": "2023-10-01T12:00:00.000Z",
      "userId": "a1c782d9-7a6c-4e5a-b05b-1d11b93c510a"
    }
  ]
}