Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Weavr Card Payments API

Retrieve card payment activity, including authorisations, settlements, and related events.

Weavr Card Payments API is one of 43 APIs that Weavr publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Card Payments. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 3 operations across 3 paths, and defines 16 schemas. It is described by OpenAPI 3.1.0, at version v3.

Requests are made against a single base URL, https://sandbox.weavr.io/multi/backoffice.

3 operations 3 paths 16 schemas 3 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v3
Base URL
https://api.weavr.io/multi
Authentication
API Key, HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 2

Weavr Card Payments API declares 2 security schemes for authenticating requests. An API key is passed in the header as api-key (api_key). It accepts HTTP bearer tokens (JWT) (auth_token).

  • api_key — The API Key representing your Multi account.
  • auth_token — The authentication token representing the user. This will be included in the login response object.

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.

Card Payments 3

Retrieve card payment activity, including authorisations, settlements, and related events.

GET
/card_payments
Get all card payments
cardPaymentsGet 16 params → 200400401500default
GET
/card_payments/{id}
Get a single card payment
cardPaymentGet 1 param → 200401404500default
GET
/card_payment_events
Get all card payment events
cardPaymentEventsGet 11 params → 200400401500default

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are Merchant (16 properties), CardPayment (11 properties), Card (10 properties), CardPaymentList (3 properties). Each schema is shown below with its type and property counts.

CardPaymentStatus
string
Lifecycle status of a CardPayment. - SETTLEMENTINPROGRESS — authorised, not yet (or not fully) settled. The hold is still on the card. - SETTLED — fully settle…
CurrencyAmount
object
The object representing a monetary amount in a particular currency.
2 properties 2 required
CardPaymentEventType
string
Type of event recorded against a CardPayment. The reversal flag on each event distinguishes a reversal from the original action.
SyntaxError
object
Is returned as part of an HTTP error response whenever a syntax error is detected. A list of the fields together with their syntax error will be provided.
1 property
CardPaymentSubtype
string
Scheme-network subtype that further classifies an event. Reversal-vs-original lives on the separate reversal field on each event.
CardPaymentType
string
High-level type of card payment, derived from the first event. - PURCHASE — standard purchase at a merchant. - REFUND — refund from a merchant to the cardholde…
CardPaymentEventDetail
object
Standalone card payment event — same four variants as CardPaymentEvent, but each row also carries the parent CardPayment context (cardPaymentId, card, merchant…
1 property 1 required
Card
object
Information about a managed card — used wherever a card appears (the card on a card payment, or the access instrument that initiated a transaction).
10 properties 2 required
CardPayment
object
One card transaction's full lifecycle — authorisation, settlement, refunds — as a single resource that the platform keeps up to date as scheme events arrive. D…
11 properties 8 required
CardPaymentEvent
object
An event in a card payment's lifecycle, lean — used nested inside CardPayment.events[]. The parent card payment provides cardPaymentId, card, and merchant, so…
1 property 1 required
ProfileId
string
The profile Id which a specific identity, instrument or transaction type is linked to. Profiles contain configuration and determine behavioral aspects of the n…
Merchant
object
Information about a merchant — used wherever a merchant appears in card-payment flows, statement entries, and transaction activity.
16 properties 2 required
Currency
string
The currency expressed in ISO-4217 code. Example: GBP, EUR, USD.
CardPaymentEventList
object
Paginated list of CardPaymentEventDetail.
3 properties
CardPaymentList
object
Paginated list of CardPayments.
3 properties
Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

weavr-card-payments-api-openapi.yml Raw ↑

Other APIs Weavr publishes across the network.

Weavr Access Token API
Weavr Access Tokens API
Weavr Accounts API
Weavr Additional Factors API
Weavr Authentication Factors API
Weavr Authorised Signatories API
Weavr Authorised Users API
Weavr Buyer Authorised Users API
Weavr Buyers API
Weavr Cards API
Weavr Confirmation Challenges API
Weavr Consumers API