Card payments

Get a card payment

Returns the card payment identified by id, including its amount, merchant, current state, and related card details.

Read the card payments overview for the payment lifecycle and state transitions.

get/card_payments/{id}

Request

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

Path parameters

idstring required

The unique identifier of a card payment.

Response

Success

idstring required

Stable identifier across the entire payment lifecycle.

profileIdstring

The profile Id which a specific identity, instrument, or transaction type is linked to.

Profiles contain configuration and determine behavioral aspects of the newly created transaction, for example, fees that may apply.

You can have one or more profiles linked to your application, and these can be used to drive different behaviors according to your product's needs.

Profile Ids can be found in the Multi Portal, in the API Credentials page.

type'PURCHASE' | 'REFUND' | 'ORIGINAL_CREDIT' | 'ACCOUNT_FUNDING' | 'CASH_WITHDRAWAL' | 'BALANCE_INQUIRY' required

High-level type of card payment, derived from the first event.

  • PURCHASE — standard purchase at a merchant. A purchase of zero is the check a merchant runs to prove the card is live before storing it on file: no money moves, no hold is placed, and it is SETTLED on arrival since nothing further will follow. If the merchant later charges the same purchase, the card payment adopts the real type and amount.
  • REFUND — refund from a merchant to the cardholder.
  • ORIGINAL_CREDIT — push credit to the cardholder (OCT).
  • ACCOUNT_FUNDING — load funds onto an account.
  • CASH_WITHDRAWAL — cash withdrawn at ATM or scheme cash service.
  • BALANCE_INQUIRY — non-financial balance check.
status'SETTLEMENT_IN_PROGRESS' | 'SETTLED' | 'DECLINED' | 'CANCELLED' | 'EXPIRED' required

Lifecycle status of a CardPayment.

  • SETTLEMENT_IN_PROGRESS — authorized, not yet (or not fully) settled. The hold is still on the card.
  • SETTLED — terminal; nothing further is expected. The customer has been charged, except for a zero-amount card check, which settles on arrival without a charge.
  • DECLINED — the latest authorization was declined; no money moved.
  • CANCELLED — the authorization was cancelled/reversed before settlement; no charge applied.
  • EXPIRED — the authorization timed out without settling.
relatedCardPaymentIdstring

Direct parent linkage — id of the single prior card payment that this payment derives from. Set on:

  • REFUND payments referring to the original purchase
  • ORIGINAL_CREDIT payments referring to the prior purchase being credited
  • Tip / add-on payments referring to the original ride / fare / service
  • Installment / recurring payments referring to the initial setup transaction

Corresponds to Visa's "Original Transaction ID" linkage and Mastercard's DE 105 sub-element 002 (Economically Related Transaction Identifier). Not used for messages that share a single lifecycle — those are events on the same card payment.

creationTimestampinteger required

When the first event for this payment was received, Epoch milliseconds.

lastUpdatedTimestampinteger

When the most recent event for this payment was received, Epoch milliseconds.

Example response

{
  "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
}

Changes

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