Get all card payments

Request

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

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.

cardIdstring^[0-9]+$

Filter by the managed card the payment belongs to.

statusArray of strings

Filter by one or more card payment statuses.

typeArray of strings

Filter by one or more card payment types.

subtypeArray of strings

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

merchantNamestring

Partial, case-insensitive match against merchant name.

amountFrominteger, (int64)

Filter for displayAmount.amount >= amountFrom.

amountTointeger, (int64)

Filter for displayAmount.amount <= amountTo.

relatedCardPaymentIdstring^[0-9]+$

Filter for card payments related to the given parent id.

creationTimestampFrominteger, (int64)

creationTimestampTointeger, (int64)

lastUpdatedTimestampFrominteger, (int64)

lastUpdatedTimestampTointeger, (int64)

sortOrderstring

Sort order on creationTimestamp. ASC = oldest first.

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_payments?offset=0&limit=1&cardId=string&status=SETTLEMENT_IN_PROGRESS&type=PURCHASE&subtype=sale_purchases&merchantName=string&amountFrom=0&amountTo=0&relatedCardPaymentId=string&creationTimestampFrom=0&creationTimestampTo=0&lastUpdatedTimestampFrom=0&lastUpdatedTimestampTo=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

cardPaymentsArray of objects(CardPayment)

countinteger, (int64)

responseCountinteger, (int64)

Response

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