Weavr Managed Cards API
Managed Cards are a type of financial instrument offered by Weavr. Cards created in prepaid mode have their own balance, whereas those created in debit mode tap into the balance of their parent Managed Accounts. Apart from being used at merchants for puchases, prepaid mode cards can also be used as sources and destinations in the `transfer` transaction.With the `access_token` representing the identity and the consent of the identity, you will be able to perform operations on the identity's Managed Cards,such as getting a Managed Card's details and managing its spend rules.
Weavr Managed Cards API is one of 55 APIs that Weavr publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Managed Cards. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 25 operations across 20 paths, and defines 159 schemas. It is described by OpenAPI 3.2.0, at version 1.0.
Requests are made against 3 base URLs: https://sandbox.weavr.io/multi/backoffice, https://sandbox.weavr.io/multi, "".
25 operations
20 paths
159 schemas
1 DELETE8 GET4 PATCH12 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 4
Weavr Managed Cards API declares
4 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).
An API key is passed in the header as api-key (api-key).
An API key is passed in the header as webhooks-key (webhooks_key).
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.api-key— An API key defined in your User API Client (or Delegate API Client - this feature is available only to customers enabled with delegation functionality). API Cl…webhooks_key— The Webhooks key can be found in the API Credentials tab in your Portal Page.
Paths & Operations 25
Across 20 paths, the API surfaces 25 operations — 1 DELETE, 8 GET, 4 PATCH, 12 POST. Each is listed below with its method, path, parameters, and response codes.
Managed Cards 25
Managed Cards are a type of financial instrument offered by Weavr. Cards created in prepaid mode have their own balance, whereas those created in debit mode tap into the balance o…
GET
/managed_cards/{id}
Get a managed card
PATCH
/managed_cards/{id}
Update a managed card
PATCH
/managed_cards/{id}/renewal
Update a managed card's renewal type
POST
/managed_cards/{id}/remove
Remove a managed card
POST
/managed_cards/{id}/block
Block a managed card
POST
/managed_cards/{id}/unblock
Unblock a managed card
GET
/managed_cards/{id}/spend_rules
Get all spend rules for a managed card
POST
/managed_cards/{id}/spend_rules
Create spend rules for a managed card
PATCH
/managed_cards/{id}/spend_rules
Update spend rules for a managed card
DELETE
/managed_cards/{id}/spend_rules
Delete all spend rules for a managed card
GET
/managed_cards/{id}/statement
Get a managed card statement
POST
/managed_cards
Create a managed card
GET
/managed_cards
Get all managed cards
GET
/deprecated/managed_cards/{id}/statementdeprecated
Get a managed card statement (deprecated)
GET
/managed_cards/{id}/transactions
Get transaction activity for a managed card
GET
/managed_cards/{id}/transactions/{transactionId}
Get a specific transaction for a managed card
POST
/managed_cards/{id}/physical
Upgrade a card to physical
POST
/managed_cards/{id}/physical/activate
Activate a physical card
GET
/managed_cards/{id}/physical/pin
Get PIN for a physical card
PATCH
/managed_cards/{id}/physical/pin/unblock
Unblock PIN for a physical card
POST
/managed_cards/{id}/physical/replace_damaged
Replace a damaged physical card
POST
/managed_cards/{id}/physical/report_lost
Report a physical card as lost
POST
/managed_cards/{id}/physical/report_stolen
Report a physical card as stolen
POST
/managed_cards/{id}/physical/replace_lost_stolen
Replace a lost or stolen physical card
POST
/managed_cards/{id}/physical/contactless_limit/reset
Reset contactless limit for a physical card
Schemas 159
The contract defines 159 schemas that model the data the API accepts and returns. The most detailed are ManagedCard (33 properties), ManagedCardsAuthorisationEvent (29 properties), ManagedCardsSettlementEvent (24 properties), OutgoingWireTransfer (18 properties). Each schema is shown below with its type and property counts.
ThreeDSecureAuthConfig
object
3 properties
2 required
UserCurrencyTransactionDetails
object
The object representing the user transaction's currency, amount and rate.
2 properties
2 required
CommonLevelSpendRules
object
12 properties
CardRenewalType
string
Indicates how the card will be handled once it is close to expiring. - RENEW: The card will be automatically renewed, keeping the same card number but with a n…
BulkCardDelivery
boolean
Bulk delivery is available for deliveryMethods REGISTEREDMAIL or COURIER. All cards marked as bulk and ordered within the fulfilment centre’s dispatch window w…
Statement
object
The list of statement entries.
6 properties
SensitiveCardNumber
object
The full card number of the card. Unless you are PCI-DSS compliant and have opted to switch off Weavr's security model, the card number will be tokenised. To s…
1 property
Error
object
2 properties
DeliveryTrackingUrl
string
The delivery tracking URL for tracking the physical card's delivery status.
ValidationError
array
Is returned as part of an HTTP error response whenever a validation error is detected. A list of the fields together with their syntax error will be provided.
SpendLimitInterval
string
The time period for which the spendLimit is valid. - DAILY: starting from 00:00:00 UTC of current day to 23:59:59 UTC of current day - WEEKLY: 00:00:00 UTC Mon…
ManagedInstrumentState
object
3 properties
1 required
StatementEntry
object
16 properties
4 required
AllLevelSpendRules
object
17 properties
ManufacturingState
string
Information on the manufacturing of the physical card, as follows: - REQUESTED: The upgrade of the card to physical has been requested. - SENTFORFULFILLMENT -…
CardLevelSpendRules
RolloverPolicy
object
The rollover policy will dictate how Weavr handles any eventual overspending. This is possible if a merchant clears more funds than authorised, or when a merch…
1 property
1 required
DeliveryTrackingMethod
string
The delivery tracking method for tracking the physical card's delivery status.
StatementEntryState
string
The transaction entry state, as follows: - PENDING: The transaction has started and some of the fund movements have completed, however additional fund movement…
PhoneNumber
string
IdentityLevelSpendRules
DeliveryAddress
object
The delivery address where the physical card is delivered.
9 properties
6 required
StatementTransactionType
string
UserId
string
DestroyedReason
string
The reason why the instrument has been destroyed: - SYSTEM: The platform or an administrator of the platform has destroyed the instrument. - USER: The root, or…
SpendLimitUpdateMethod
string
The spend limit update method to apply. Currently supported: - OVERWRITE: (default option if nothing selected). Overwrites the previous values for the spendLim…
DigitalWallets
object
3 properties
ManagedCard
object
33 properties
20 required
ExternalData
array
External data fields, as provided and managed by the caller that are to be stored and associated with a Managed Card instance. This information is not processe…
ScaledAmount
object
A floating point number, represented as a value and its scale. Its actual value can be obtained using the equation: value pow(10, -scale).
2 properties
PhysicalCardDetails
object
13 properties
1 required
BillingAddress
object
6 properties
4 required
BaseCardLevelSpendRules
SensitiveCvv
object
The CVV of the card. Unless you are PCI-DSS compliant and have opted to switch off Weavr's security model, the card's CVV will be tokenised. To show the card's…
1 property
ProfileLevelSpendRules
BlockedReason
string
The reason why the instrument has been blocked: - USER: The root, or an authorised user, of the identity owning the instrument has temporarily blocked the inst…
ManagedCardReplacement
object
Indicates if the card is replaced by another card.
2 properties
2 required
TransactionId
object
2 properties
2 required
SpendLimit
object
3 properties
2 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…
Currency
string
The currency expressed in ISO-4217 code. Example: GBP, EUR, USD.
CurrencyAmount
object
The object representing a monetary amount in a particular currency.
2 properties
2 required
DeliveryTrackingCode
string
The delivery tracking code for tracking the physical card's delivery status. This may not always be available on the first dispatched event, and so you will re…
Tag
string
The tag field is a custom field that can be used to search and filter.
InstrumentState
string
The state of the instrument indicating what it can and cannot do as follows: - ACTIVE: The instrument is in an active state and can be used in transactions. -…
DeliveryMethod
string
The delivery methods supported for delivering printed physical cards. If not specified, the STANDARDDELIVERY method will be used.
UpdateCardLevelSpendRules
DigitalWalletType
string
The digital wallet type.
CorrespondentBankingSEPABeneficiary
object
CBT-specific beneficiary details for SEPA/IBAN wire transfers with Banking Circle FI-to-FI field limits.
9 properties
3 required
CorrespondentBankingIndividualOriginator
object
An individual (natural person) originator of the transfer. Travel Rule Requirements: - Mandatory: Full name and account number (via bankAccountDetails) - Manda…
6 properties
4 required
SendState
string
The state of the send transaction, as follows: - INVALID: The send transaction has failed initial validation checks. - INITIALISED: The initial state of a send…
StatementResponseEntryTransaction
object
Reference to the transaction this statement entry records. The concrete shape is identified by the type discriminator — see the per-type variants for the avail…
1 property
2 required
StatementResponseEntryTransactionType
string
The top-level type of transaction represented by this statement entry.
InstrumentCounterparty
object
Counterparty that is an internal platform instrument (managed account, managed card).
4 properties
2 required
FeeSubtype
string
The category of fee — indicates the activity or instrument-lifecycle event the fee relates to.
SensitivePin
object
The PIN used for in-person transactions done with physical cards. Unless you are PCI-DSS compliant and have opted to switch off Weavr's security model, the car…
1 property
1 required
SWIFTBeneficiary
object
Beneficiary details for SWIFT wire transfers.
9 properties
4 required
CardPaymentEventType
string
Type of event recorded against a CardPayment. The reversal flag on each event distinguishes a reversal from the original action.
PhysicalCardActivationCode
string
ScheduledTimestamp
string
The epoch timestamp at which the transaction is scheduled to be executed.
CorrespondentBankingIndividualAddressAndBirthInfo
object
Birth information for an individual originator.
2 properties
2 required
SEPABeneficiary
object
Beneficiary details for SEPA/IBAN wire transfers.
9 properties
2 required
MerchantCounterparty
object
Counterparty for a card transaction — a merchant.
5 properties
1 required
IncomingWireTransfer
object
An incoming wire transfer received from an external bank account.
14 properties
5 required
FasterPaymentsBankDetailsOrBACSBankDetails
object
Bank details used in case the wire transfer is executed over Faster Payments.
3 properties
2 required
SystemTransaction
object
A system-generated transaction applied to an instrument by the platform (balance adjustments, account closures, dispute outcomes, replacement balance transfers…
9 properties
5 required
FeeTransaction
object
A fee charged or reversed on an instrument. Surfaced through GET /fees, GET /transactions (Transaction Activity), and as line items on statements.
9 properties
6 required
DateOfBirth
string
The date of birth in ISO 8601 format (YYYY-MM-DD).
StatementResponseEntry
object
A single entry in an instrument statement. Each entry represents a posted transaction that caused the actual balance of the instrument to change.
11 properties
5 required
StatementResponse
object
A financial statement for an instrument over a given period. Contains only posted/completed transactions where funds have definitively moved (actual balance ch…
6 properties
InstrumentType
string
CorrespondentBankingOwt
object
15 properties
9 required
CorrespondentBankingFasterPaymentsBeneficiary
object
CBT-specific beneficiary details for Faster Payments wire transfers with Banking Circle FI-to-FI field limits.
11 properties
5 required
Transfer
object
12 properties
7 required
OutgoingWireTransferValidationOutcome
object
2 properties
2 required
TransactionState
string
Status of the transaction.
TransactionCancellationReason
string
The reason the scheduled transaction was cancelled.
TransactionForex
object
Foreign exchange details when the transaction involved currency conversion.
4 properties
UKConfirmationOfPayeeResult
object
3 properties
1 required
InstrumentId
object
2 properties
2 required
AccessInstrumentType
string
The type of access instrument that initiated a transaction.
OutgoingWireTransferState
string
The state of the Outgoing wire transfer transaction, as follows: - INVALID: The wire transfer has failed initial validation checks. - PENDINGCHALLENGE: The wir…
CorrespondentBankingOwtValidationOutcome
object
2 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
RIXBeneficiary
object
Beneficiary details for RIX wire transfers.
9 properties
2 required
Send
object
16 properties
7 required
ExternalAccountType
string
ChallengeExemptionReason
string
The Reason the transaction was exempted from SCA verification
CorrespondentBankingBankAccountDetails
object
Bank account details for the originator.
2 properties
2 required
OutgoingWireTransferBeneficiary
object
Details of the beneficiary of the outgoing wire transfer. Deprecated: Use SEPABeneficiary for SEPA/IBAN transfers or FasterPaymentsBeneficiary for Faster Payme…
9 properties
2 required
InstrumentTransactionActivityList
object
A paginated list of transaction activity entries scoped to a single instrument.
3 properties
Merchant
object
Information about a merchant — used wherever a merchant appears in card-payment flows, statement entries, and transaction activity.
16 properties
2 required
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
CorrespondentBankingExternalData
object
External data key-value pair.
2 properties
2 required
StatementResponseEntryExecutingAccessInstrument
object
The access instrument that initiated the transaction. The concrete shape is identified by the type discriminator.
1 property
2 required
OutgoingWireTransferRejectedInfo
string
Additional info when the outgoing wire transfer has been rejected, as follows: - SYSTEM: The wire transfer was rejected by the system. - USER: The wire transfe…
TransactionActivityDirection
string
Whether funds were credited to or debited from the instrument.
FeeSummary
object
4 properties
3 required
InstrumentTransactionActivityItem
object
A transaction activity entry returned by the per-instrument transactions endpoints (e.g. /managedaccounts/{id}/transactions). The instrument is omitted because…
9 properties
5 required
OutgoingWireTransfer
object
18 properties
6 required
IncomingWireTransferMultiState
string
The state of an incoming wire transfer: - PENDING: The transfer has been received and is being processed. Funds have not yet been credited to the destination a…
Nationality
string
Nationality of the user - using ISO 3166 alpha-2.
TransactionActivitySortBy
string
The field to sort transaction activity results by: - creationTimestamp: Sort by when the transaction was first created (default). - lastUpdatedTimestamp: Sort…
ManagedCardRequest
object
14 properties
5 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
OutgoingWireTransferType
string
The wire transfer rails used, from SEPA, Faster Payments, SWIFT or RIX.
FasterPaymentsBeneficiary
object
Beneficiary details for Faster Payments wire transfers.
11 properties
4 required
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…
Id
string
ExecutionTimestamp
string
The epoch timestamp at which the transaction was executed, transitioning to a final state such as COMPLETED, REJECTED, or FAILED.
SystemTransactionSubtype
string
The specific kind of system-generated transaction.
CorrespondentBankingRIXBeneficiary
object
CBT-specific beneficiary details for RIX wire transfers with Banking Circle FI-to-FI field limits.
9 properties
3 required
CorrespondentBankingOwtState
string
The state of the correspondent bank transfer transaction, as follows: - INVALID: The transfer has failed initial validation checks. - PENDINGCHALLENGE: The tra…
IBANDetails
object
Bank details used in case the wire transfer is executed over SEPA or RIX
2 properties
1 required
ExternalAccountId
object
The id of an external account, such as a Linked Account, registered with the Weavr Platform.
2 properties
2 required
BeneficiaryId
object
1 property
1 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
CorrespondentBankingBusinessAddressAndIdInfo
object
Business identification for a business originator.
2 properties
2 required
TransactionActivityType
string
The type of transaction: - transfers: Internal transfer between instruments of the same identity - sends: Transfer between instruments of different identities…
BankAccountCounterparty
object
Counterparty that is a bank account (for wire transfers).
7 properties
InstrumentStatementSortOrder
string
SEPAVerificationOfPayeeResult
object
2 properties
1 required
FeeTransactionStatus
string
Lifecycle status of a fee transaction: - PENDING: Fee accompanies a transaction that is still processing; it may still be cancelled. - COMPLETED: Fee was charg…
CorrespondentBankingIndividualAddressAndIdInfo
object
Personal identification for an individual originator.
2 properties
2 required
CorrespondentBankingBusinessOriginator
object
A business (legal entity) originator of the transfer. Travel Rule Requirements: - Mandatory: Full legal name and account number (via bankAccountDetails) - Mand…
6 properties
4 required
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…
TransactionActivityStatus
string
Normalised lifecycle status of a transaction: - DRAFT: Transaction ID has been created. There are additional user-actions required before the transaction is co…
AuthorisationCategory
string
The category of the authorisation.
StringWrappedTypeId
object
2 properties
2 required
ManagedCardsSettlementEventSettlementState
string
AuthDeclineReason
string
ReplacementType
string
ManagedCardsSettlementEvent
object
24 properties
10 required
AuthForwardingDetails
object
3 properties
ManagedCardsAdjustmentEvent
object
8 properties
6 required
StateChangeState
object
3 properties
ManagedCardsReplacementEventType
string
CardAdjustmentDetailsAdjustmentType
string
ManagedCardsExpiryAndRenewalEventType
string
DigitalWalletDetails
object
Contains information about the digital wallet, if it has been used.
1 property
CardHolderPresent
string
CardAuthorisationDetailsAuthorisationType
string
CardType
string
PrepaidModeDetails
object
1 property
ManagedCardModeDetails
object
2 properties
CardMerchantSettlementMerchantTransactionType
string
ManagedCardsAuthorisationEvent
object
29 properties
9 required
ManagedCardsUpgradeToPhysicalEvent
object
3 properties
3 required
ManagedCardsStateChangeEvent
object
6 properties
5 required
StateChangeEventType
string
DebitModeDetails
object
2 properties
MerchantData
object
14 properties
3 required
ManagedCardsReplacementEvent
object
The event that is triggered when a managed card is replaced. This can be either a virtual or physical replacement.
6 properties
4 required
LegacyCurrencyAmount
object
The object representing a monetary amount in a particular currency.
2 properties
2 required
CardAuthorisationDetailsTransactionType
string
ManagedCardsExpiryAndRenewalEvent
object
7 properties
5 required
AuthRuleChecksFailedReason
string
AuthForwardingDefaultTimeoutDecision
string
ManagedCardsCardPaymentEvent
object
Notification of a CardPayment lifecycle change. The CardPayment payload is identical in shape to the response of GET /multi/cardpayments/{id}, carrying the cur…
2 properties
2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Weavr 12
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 Cards API
Weavr Confirmation Challenges API
#Managed Cards
Where this information came from
This is an independent, third-party profile of Weavr Managed Cards API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.