Get all card payment events

Request

Returns a flat, chronological list of card payment events across one or more card payments. Each entry carries the event plus the parent CardPayment context (card, merchant, group).

Security

auth_token and api-key

Query

offsetinteger, (int32), >= 0

The offset value for paging, indicating the initial item number to be returned from the data set satisfying the given criteria. Leave out to fetch the first page of results.

limitinteger, (int32), [ 1 .. 100 ]

The limit of the results for paging, starting at the offset. Limit is always capped at 100.

cardPaymentIdstring^[0-9]+$

Filter events to a single card payment.

cardIdstring^[0-9]+$

Filter events to those on a single managed card.

typeArray of strings

Filter by one or more event types.

subtypeArray of strings

Filter events by one or more network subtypes.

reversalboolean

Filter events by reversal flag.

timestampFrominteger, (int64)

timestampTointeger, (int64)

sortOrderstring

Sort order on event timestamp. ASC = oldest first (default DESC).

Enum:"ASC""DESC"

acceptstring

A request parameter specifying the type of response the client would like. Must be one of application/json, application/pdf or text/csv.

The default response type (application/json) will be returned if specified incorrectly or not specified.

curl -i -X GET \
  'https://sandbox.weavr.io/multi/card_payment_events?offset=0&limit=1&cardPaymentId=string&cardId=string&type=AUTHORISATION&subtype=sale_purchases&reversal=true&timestampFrom=0&timestampTo=0&sortOrder=ASC' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'accept: string' \
  -H 'api-key: YOUR_API_KEY_HERE'

Responses

Success

Headers

request-refstringrequired

A request identifier. Providing this reference when contacting our support team will help us investigate your query.

Bodyapplication/json

eventsArray of objects(CardPaymentEventDetail)

countinteger, (int64)

responseCountinteger, (int64)

Response

{
  "events": [
    { … }
  ],
  "count": 0,
  "responseCount": 0
}