Sign in

v1

latestOpenAPI 3.1.0© Modulr Finance2026-08-04207430590.4 KB
Cards

View activities for specific cards or over a date range

View activities for a specified list of cards and a given time frame. View activities for all cards belonging to a specified list of accounts and a given time frame. View all activities for a single card when a single card ID is specified, time frame is optional.

get/activities

Query parameters

fromCreatedDatestring

Activities with a created date equal to or after this date. Format: 'yyyy-MM-dd'T'HH:mm:ssZ'. Value cannot be more than 7 days in the past when mandatory. Value is optional if only a single Card ID has been provided

toCreatedDatestring

Activities with a created date before this date. Format: 'yyyy-MM-dd'T'HH:mm:ssZ'. Value is optional if only a single Card ID has been provided or from date is within last 7 days

statuses'DECLINED' | 'APPROVED' | 'SETTLED' | 'EXPIRED' | 'APPLIED' | 'PENDING'

Activities with possibly multiple statuses equal to this value. Omitting this is equivalent to supplying all values

types'AUTHORISATION' | 'REVERSAL' | 'SETTLEMENT' | 'REFUND' | 'ORIGINAL_CREDIT' | 'OFFLINE_TRANSACTION' | 'ASI' | 'CREDIT_AUTH' | 'CREDIT_AUTH_REV'

Activities with possibly multiple types equal to this value. Omitting this is equivalent to supplying all values

cardsstring[]

Activities with possibly multiple card IDs equal to this value. Only one of 'cards' or 'accounts' must be supplied

accountsstring[]

Activities with possibly multiple account IDs equal to this value. Only one of 'cards' or 'accounts' must be supplied

idsstring[]

Activities with the specified IDs. Only 'page' and/or 'size' may be used in conjunction with this filter.

orderIdinteger

Activites with specified Order Id

channelManagerIdstring

Id of channel manager to return activities for

sortFields'createdDate' | 'orderId'

A list of fields to sort the response by. Sorting will be applied in the order the fields are given

sortOrders'ASC' | 'DESC'

A list of orders to apply to the respective sortFields. The only accepted sortOrders will be ASC and DESC (case insensitive)

pageinteger

Page to fetch (0 indexed)

sizeinteger

Size of page to fetch

Response

Card activity data returned successfully

sizeinteger required

Page size

totalSizeinteger required

Total count

pageinteger required

Current page number, 0 based; i.e first-page = 0, second-page = 1

totalPagesinteger required

Total pages

Example response

{
  "content": [
    {
      "id": "X000000001",
      "orderId": "1234",
      "cardId": "V000000001",
      "reason": "Account has insufficient funds",
      "createdDate": "2019-01-29T11:22:00+0000",
      "transactionCurrency": "EUR",
      "billingCurrency": "GBP",
      "mcc": "5182",
      "merchantName": "Loudons Cafe",
      "merchantId": "123456789012345",
      "merchantCountry": "GBR",
      "acquirerReferenceNumber": "123451234512345"
    }
  ]
}