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 Cards API

The Cards API from Weavr — 7 operation(s) for cards.

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

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

This API exposes 7 operations across 7 paths, and defines 18 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.

7 operations 7 paths 18 schemas 7 POST

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 Cards 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 7

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

Cards 7
POST
/cards/{card_id}/expire
Simulate expiry of card
cards_card_id_expire 2 params → 204400409default
POST
/cards/{card_id}/about_to_expire
Simulate card about to expire
cards_card_id_about_to_expire 2 params → 204400default
POST
/cards/{card_id}/purchase
Simulate card purchase using card id
cards_card_id_purchase 2 params body → 200400default
POST
/cards/{card_id}/renew
Simulate renewal of card
cards_card_id_renew 2 params → 204400409default
POST
/cards/{card_id}/merchant_refund
Simulate card merchant refund using card id
cards_card_id_merchant_refund 2 params body → 200400default
POST
/cards/purchase
Simulate card purchase using card number
cards_purchase 1 param body → 200400default
POST
/cards/merchant_refund
Simulate card merchant refund using card number
cards_merchant_refund 1 param body → 200400default

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are PurchaseRequest (15 properties), PurchaseRequestByCardId (13 properties), AdditionalMerchantData (10 properties), CurrencyAmount (2 properties). Each schema is shown below with its type and property counts.

CurrencyAmount
object
A message representing a monetary amount in a particular currency.
2 properties 1 required
ExpireManagedCardConflictErrorCode
string
ExpireManagedCardConflict
object
1 property
CardHolderPresent
string
ClientInvalidRequest
object
2 properties
PurchaseResponse
object
2 properties
PurchaseRequestByCardId
object
13 properties 2 required
PurchaseRequest
object
15 properties 5 required
RenewManagedCardConflict
object
1 property
NullableInt64
object
2 properties
RenewManagedCardConflictErrorCode
string
AdditionalMerchantData
object
10 properties
PurchaseResponsePurchaseResponseCode
string
MessageValidation
object
2 properties
FieldValidationType
string
DefaultError
object
A default error model in case of errors other than 400, 409 or 504.
1 property
FieldValidation
object
2 properties
FieldValidationErrors
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

weavr-cards-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 Card Payments API
Weavr Confirmation Challenges API
Weavr Consumers API