Skip to main content
Weavr API
Card payments

List card payments

GET/card_payments

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.

Request

Header parameters

Query parameters

Responses

200OK

Success

Headers
Body
application/json
{}
CardPaymentListCardPaymentList · object · 3 fields
Response example
{  "cardPayments": [    {      "id": "string",      "profileId": "10001",      "type": {},      "card": {        "id": "string",        "type": "managed_cards",        "mode": "prepaid",        "friendlyName": "string",        "nameOnCard": "string",        "cardBrand": "MASTERCARD",        "cardNumberFirstSix": "string",        "cardNumberLastFour": "string",        "linkedUserId": "string",        "parentManagedAccountId": "string"      },      "merchant": {        "id": "string",        "name": "string",        "nameOther": "string",        "networkId": "string",        "categoryCode": "string",        "description": "string",        "street": "string",        "city": "string",        "state": "string",        "postalCode": "string",        "country": "string",        "telephone": "string",        "url": "string",        "contact": "string",        "reference": "string",        "logoUrl": "string"      },      "displayAmount": {        "currency": "GBP",        "amount": 1250      },      "status": "SETTLEMENT_IN_PROGRESS",      "relatedCardPaymentId": "string",      "events": [        {          "id": "string",          "subtype": "sale_purchases",          "reversal": true,          "result": {},          "authorisationCategory": {},          "authForwardingDetails": {            "triggered": true,            "decisionOutcome": {},            "innovatorTimedOut": true          },          "declineReason": {},          "authRuleFailedReason": "string",          "cancellationReason": "string",          "transactionAmount": {            "currency": "GBP",            "amount": 1250          },          "billingAmount": {            "currency": "GBP",            "amount": 1250          },          "forex": {            "exchangeRate": {              "value": 0,              "scale": 0            },            "padding": {              "currency": "GBP",              "amount": 1250            }          },          "userAmount": {            "currency": "GBP",            "amount": 1250          },          "userExchangeRate": {            "value": 0,            "scale": 0          },          "authCode": "string",          "fees": [            {              "id": "string",              "subtype": {},              "amount": {                "currency": "GBP",                "amount": 1250              }            }          ],          "timestamp": 0,          "processedTimestamp": 0        }      ],      "creationTimestamp": 0,      "lastUpdatedTimestamp": 0    }  ],  "count": 0,  "responseCount": 0}