Get authorization transactions

Get Authorization Transactions

This endpoint retrieves open authorization transaction events associated with a specific payment card for a specified date period. Open authorizations are card transactions that have been approved but not yet settled. Use this endpoint to monitor pending card activity and track authorized spend before final settlement.

Deprecation Notice: This endpoint is marked as deprecated. Consider migrating to the current transaction events endpoint when available.

Endpoint

POST /api/transactionEvents/openAuthorizations

Authentication

Bearer token required. Obtain via:

POST https://api.banking.netevia.dev/api/auth/v2

Include in header: Authorization: Bearer {token}
Token lifetime: 10 minutes. Refresh via POST /api/auth/refresh.

When to use

Use this endpoint to retrieve a list of authorized-but-unsettled card transactions for a payment card, useful for displaying pending charges to a cardholder or reconciling real-time card spend. It supports optional amount range filtering, keyword search, and pagination for large result sets. This is particularly relevant for dashboards or reporting tools that need to show in-flight authorizations before they post.

Request Body

The request body accepts one of two schemas. The base schema (paymentcardwithperiodandfilterrequest) requires only the card ID and date range. The extended schema (paymentcardwithperiodandamountfilterrequest) adds optional amount filtering, search string, and pagination.

Base fields (both variants):

FieldTypeRequiredDescription
paymentCardIdstringYesThe unique identifier of the payment card whose open authorizations are being queried. Minimum length: 1.
dateFromstring (date-time)YesStart of the date range for the query (ISO 8601 format, e.g., 2026-05-01T00:00:00Z).
dateTostring (date-time)YesEnd of the date range for the query (ISO 8601 format, e.g., 2026-05-31T23:59:59Z).
filterobjectNoTransaction type filter object. Contains boolean-valued filter items: all, deposit, withdraw, pos, transactionStatus.
jsonFilterstringNoRaw JSON string for advanced filtering.

Extended fields (amount filter variant only):

FieldTypeRequiredDescription
amountFilterobjectNoAmount range filter. Contains minValue (integer, int64) and maxValue (integer, int64) in cents.
searchStringstringNoKeyword string to search within transaction results.
paginationSettingsobjectNoPagination control. Contains take (integer 1–10000, number of records to return) and skip (integer 0–2147483647, number of records to skip).

Base request example:

{
  "paymentCardId": "pcd_abc123def456",
  "dateFrom": "2026-05-01T00:00:00Z",
  "dateTo": "2026-05-31T23:59:59Z"
}

Extended request example (with amount filter and pagination):

{
  "paymentCardId": "pcd_abc123def456",
  "dateFrom": "2026-05-01T00:00:00Z",
  "dateTo": "2026-05-31T23:59:59Z",
  "amountFilter": {
    "minValue": 500,
    "maxValue": 50000
  },
  "searchString": "grocery",
  "paginationSettings": {
    "take": 50,
    "skip": 0
  }
}

Response

200 OK

FieldTypeDescription
dataarrayList of transaction event objects matching the query.
data[].typenamestringThe type name of the transaction event.
data[].responseCodestringAuthorization response code returned by the card network.
data[].responseDescriptionstringHuman-readable description of the authorization response.
data[].createdAtstring (date-time)Timestamp when the transaction event was created.
data[].approvedAmountobjectThe approved amount. Contains value (integer, in cents) and currencyCode (string, e.g., "USD").
data[].requestedAmountobjectThe amount originally requested by the merchant. Contains value and currencyCode.
data[].transactionobjectSource transaction reference. Contains typename, id, and transactionEvents (array).
data[].merchantDetailsobjectMerchant information. Contains name, category, categoryCode, countryCodeAlpha3, description, merchantId.
data[].paymentCardobjectPayment card used for the transaction. Contains id, bin, last4, status, formFactor, expirationDate, network, and related spend/velocity rules.
data[].feesarrayAssociated transaction fees. Each item contains type, approvedFeeAmount, and requestedFeeAmount.
filterobjectEcho of the filter settings applied to the query. Contains all, deposit, withdraw, pos, and transactionStatus filter items.
{
  "data": [
    {
      "typename": "AuthorizationEvent",
      "responseCode": "00",
      "responseDescription": "Approved",
      "createdAt": "2026-05-15T14:32:00Z",
      "approvedAmount": {
        "value": 4250,
        "currencyCode": "USD"
      },
      "requestedAmount": {
        "value": 4250,
        "currencyCode": "USD"
      },
      "merchantDetails": {
        "name": "WHOLE FOODS MARKET",
        "category": "GROCERY_STORES_SUPERMARKETS",
        "categoryCode": "5411",
        "countryCodeAlpha3": "USA",
        "description": "Grocery purchase",
        "merchantId": "mch_7890xyz"
      },
      "paymentCard": {
        "id": "pcd_abc123def456",
        "bin": "411111",
        "last4": "4242",
        "status": "ACTIVE",
        "formFactor": "VIRTUAL",
        "expirationDate": "12/2028",
        "network": "VISA"
      },
      "fees": []
    }
  ],
  "filter": {
    "all": {
      "displayName": "All",
      "value": true
    },
    "pos": {
      "displayName": "Point of Sale",
      "value": true
    }
  }
}

Error Codes

CodeWhen it happens
400Missing required fields (paymentCardId, dateFrom, or dateTo) or invalid date format
401Token missing, expired, or invalid
403Insufficient permissions to access the specified payment card
404Payment card not found
500Internal server error

Common Mistakes

  • Omitting paymentCardId, dateFrom, or dateTo — all three are required in the base request and will result in a 400 error.
  • Providing dates in a format other than ISO 8601 date-time (e.g., omitting the time component or timezone indicator).
  • Setting paginationSettings.take to 0 or above 10000 — valid range is 1 to 10000.
  • Querying a paymentCardId that does not belong to the authenticated partner's customers, which will return 403 or 404.
  • Using this deprecated endpoint for new integrations; plan migration to the current transaction events endpoint.

Related Endpoints

  • POST /api/transactionEvents — Retrieve settled transaction events for a payment card
  • POST /api/transactionEvents/filter — Retrieve filtered transaction events with extended query options
  • GET /api/paymentCards/{paymentCardId} — Retrieve payment card details including status and form factor

Example

curl -X POST https://api.banking.netevia.dev/api/transactionEvents/openAuthorizations \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "paymentCardId": "pcd_abc123def456",
    "dateFrom": "2026-05-01T00:00:00Z",
    "dateTo": "2026-05-31T23:59:59Z",
    "amountFilter": {
      "minValue": 100,
      "maxValue": 100000
    },
    "paginationSettings": {
      "take": 50,
      "skip": 0
    }
  }'
Body Params
string
required
length ≥ 1
date-time
required
date-time
required
filter
object
string | null
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Response

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json