Get authorization transactions

Get Authorization Transactions

Deprecated: This endpoint is deprecated and may be removed in a future version. Migrate to the current transaction events endpoints for retrieving authorization data.

Retrieves open (pending) authorization transactions associated with a payment card. Results can be filtered by card identifier and a date/time range. This endpoint is useful for reviewing holds or pending charges that have been authorized but not yet settled.

Endpoint

GET /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 check which payment card authorizations are still open (pending settlement) for a given card and time window. This is helpful for customer service workflows or reconciliation processes where you need to identify funds on hold before they are captured or released.

Query Parameters

ParameterTypeRequiredDescription
paymentCardIdstringNoThe unique identifier of the payment card whose open authorizations you want to retrieve.
fromstring (date-time)NoStart of the date/time range for filtering open authorizations (ISO 8601 format, e.g. 2024-01-01T00:00:00Z).
tostring (date-time)NoEnd of the date/time range for filtering open authorizations (ISO 8601 format, e.g. 2024-01-31T23:59:59Z).

Response

200 OK

Returns a list of open authorization transaction records matching the provided filters. The response body schema is not formally defined for this deprecated endpoint; the structure may vary. Common fields observed in authorization transaction responses include:

FieldTypeDescription
idstringUnique identifier of the authorization transaction event.
paymentCardIdstringThe payment card associated with the authorization.
amountnumberThe authorized amount in the card's currency.
currencystringCurrency code (e.g. USD).
merchantNamestringName of the merchant that initiated the authorization.
statusstringCurrent status of the authorization (e.g. OPEN, PENDING).
authorizedAtstring (date-time)Timestamp when the authorization was created.
[
  {
    "id": "auth-event-00112233",
    "paymentCardId": "card-aabbccdd-1122-3344-5566-eeff00112233",
    "amount": 75.00,
    "currency": "USD",
    "merchantName": "Example Merchant",
    "status": "OPEN",
    "authorizedAt": "2024-06-01T14:32:00Z"
  }
]

Error Codes

CodeWhen it happens
400Invalid query parameter format (e.g. malformed date-time value for from or to)
401Token missing, expired, or invalid
403Insufficient permissions to access transaction events
404Specified paymentCardId not found
500Internal server error

Common Mistakes

  • Providing from or to values in a non-ISO 8601 date-time format will result in a 400 error; always use the YYYY-MM-DDTHH:MM:SSZ format.
  • Omitting paymentCardId returns open authorizations across all accessible cards, which may produce large result sets; supply the card ID to scope the query.
  • This endpoint is deprecated — plan migration to the current transaction events endpoints to avoid disruption when this endpoint is removed.

Related Endpoints

  • GET /api/transactionEvents — Retrieve all transaction events for a card or account
  • GET /api/transactionEvents/{id} — Retrieve a specific transaction event by ID
  • GET /api/paymentCards/{paymentCardId} — Retrieve payment card details

Example

curl -X GET "https://api.banking.netevia.dev/api/transactionEvents/openAuthorizations?paymentCardId=card-aabbccdd-1122-3344-5566-eeff00112233&from=2024-06-01T00:00:00Z&to=2024-06-30T23:59:59Z" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
Query Params
string
date-time
date-time
Response
200

Success

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here!