Card payments

List card payments

Returns the aggregated card payments for the logged-in identity. A CardPayment represents the full lifecycle of a card payment (authorization + settlements + optional reversal/expiry/refund/original credit) as a single business-level entity.

get/card_payments

Request

  • Base URL: https://sandbox.weavr.io/multi
  • URL: https://sandbox.weavr.io/multi/card_payments
  • Auth: HTTP bearer and API key in header api-key

Query parameters

offsetinteger

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
Example:25

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

cardIdstring

Filter by the managed card the payment belongs to.

statusCardPaymentStatus[]

Filter by one or more card payment statuses.

typeCardPaymentType[]

Filter by one or more card payment types.

subtypeCardPaymentSubtype[]

Filter by one or more event subtypes (joined against the events timeline).

merchantNamestring

Partial, case-insensitive match against merchant name.

amountFrominteger

Filter for displayAmount.amount >= amountFrom.

amountTointeger

Filter for displayAmount.amount <= amountTo.

relatedCardPaymentIdstring

Filter for card payments related to the given parent id.

creationTimestampFrominteger

Filter for card payments created at or after this epoch timestamp in milliseconds.

creationTimestampTointeger

Filter for card payments created before this epoch timestamp in milliseconds.

lastUpdatedTimestampFrominteger

Filter for card payments updated at or after this epoch timestamp in milliseconds.

lastUpdatedTimestampTointeger

Filter for card payments updated before this epoch timestamp in milliseconds.

sortOrder'ASC' | 'DESC'

Sort order on creationTimestamp. ASC = oldest first.

Headers

accept'application/json' | 'text/csv' | 'application/pdf'
Example:application/json

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.

Response

Success

countinteger
responseCountinteger

Example response

{
  "cardPayments": [
    {
      "id": "123456789",
      "profileId": "10001",
      "card": {
        "id": "234567890",
        "friendlyName": "Travel card",
        "nameOnCard": "Alex Smith",
        "cardNumberFirstSix": "453201",
        "cardNumberLastFour": "0366",
        "linkedUserId": "987654321",
        "parentManagedAccountId": "123456789"
      },
      "merchant": {
        "id": "MID123456",
        "name": "Coffee Corner",
        "nameOther": "Coffee Corner Ltd",
        "networkId": "NET123456",
        "categoryCode": "5812",
        "description": "Coffee shop",
        "street": "1 High Street",
        "city": "London",
        "state": "Greater London",
        "postalCode": "W1A 1AA",
        "country": "GB",
        "telephone": "+442079460000",
        "url": "https://www.coffeecorner.example",
        "contact": "info@coffeecorner.example",
        "reference": "ORD-20260803-0001",
        "logoUrl": "https://www.coffeecorner.example/logo.png"
      },
      "displayAmount": {
        "currency": "GBP",
        "amount": 1250
      },
      "relatedCardPaymentId": "987654321",
      "creationTimestamp": 1786118400000,
      "lastUpdatedTimestamp": 1786118401250
    }
  ],
  "count": 42,
  "responseCount": 10
}

Changes

No recorded changes to this operation across all 1 revision of this API.