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 43 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 116 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.
25 operations
20 paths
116 schemas
1 DELETE8 GET4 PATCH12 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Weavr Managed 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 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 116
The contract defines 116 schemas that model the data the API accepts and returns. The most detailed are ManagedCard (33 properties), OutgoingWireTransfer (18 properties), AllLevelSpendRules (17 properties), StatementEntry (16 properties). Each schema is shown below with its type and property counts.
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…
CardPaymentEventType
string
Type of event recorded against a CardPayment. The reversal flag on each event distinguishes a reversal from the original action.
FasterPaymentsBankDetailsOrBACSBankDetails
object
Bank details used in case the wire transfer is executed over Faster Payments.
3 properties
2 required
CommonLevelSpendRules
object
12 properties
CorrespondentBankingOwtState
string
The state of the correspondent bank transfer transaction, as follows: - INVALID: The transfer has failed initial validation checks. - PENDINGCHALLENGE: The tra…
CorrespondentBankingExternalData
object
External data key-value pair.
2 properties
2 required
ExternalAccountId
object
The id of an external account, such as a Linked Account, registered with the Weavr Platform.
2 properties
2 required
UKConfirmationOfPayeeResult
object
3 properties
1 required
CorrespondentBankingIndividualAddressAndBirthInfo
object
Birth information for an individual originator.
2 properties
2 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…
PhysicalCardDetails
object
13 properties
1 required
Transfer
object
12 properties
7 required
UpdateCardLevelSpendRules
CorrespondentBankingIndividualAddressAndIdInfo
object
Personal identification for an individual originator.
2 properties
2 required
DateOfBirth
string
The date of birth in ISO 8601 format (YYYY-MM-DD).
SEPAVerificationOfPayeeResult
object
2 properties
1 required
ManufacturingState
string
Information on the manufacturing of the physical card, as follows: - REQUESTED: The upgrade of the card to physical has been requested. - SENTFORFULFILLMENT -…
FeeSummary
object
4 properties
3 required
Merchant
object
Information about a merchant — used wherever a merchant appears in card-payment flows, statement entries, and transaction activity.
16 properties
2 required
StatementEntry
object
16 properties
4 required
DeliveryAddress
object
The delivery address where the physical card is delivered.
9 properties
6 required
IncomingWireTransfer
object
An incoming wire transfer received from an external bank account.
14 properties
5 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…
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…
BillingAddress
object
6 properties
4 required
FasterPaymentsBeneficiary
object
Beneficiary details for Faster Payments wire transfers.
11 properties
4 required
OutgoingWireTransferType
string
The wire transfer rails used, from SEPA, Faster Payments, SWIFT or RIX.
DigitalWallets
object
3 properties
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
Tag
string
The tag field is a custom field that can be used to search and filter.
CurrencyAmount
object
The object representing a monetary amount in a particular currency.
2 properties
2 required
FeeSubtype
string
The category of fee — indicates the activity or instrument-lifecycle event the fee relates to.
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
Send
object
16 properties
7 required
BeneficiaryId
object
1 property
1 required
IdentityLevelSpendRules
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
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. -…
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…
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
Statement
object
The list of statement entries.
6 properties
ChallengeExemptionReason
string
The Reason the transaction was exempted from SCA verification
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
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…
InstrumentId
object
2 properties
2 required
ManagedInstrumentState
object
3 properties
1 required
RIXBeneficiary
object
Beneficiary details for RIX wire transfers.
9 properties
2 required
Currency
string
The currency expressed in ISO-4217 code. Example: GBP, EUR, USD.
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…
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
ExecutionTimestamp
string
The epoch timestamp at which the transaction was executed, transitioning to a final state such as COMPLETED, REJECTED, or FAILED.
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…
PhoneNumber
string
SpendLimit
object
3 properties
2 required
TransactionActivityDirection
string
Whether funds were credited to or debited from the instrument.
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.
TransactionState
string
Status of the transaction.
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
OutgoingWireTransferValidationOutcome
object
2 properties
2 required
CardLevelSpendRules
TransactionActivityType
string
The type of transaction: - transfers: Internal transfer between instruments of the same identity - sends: Transfer between instruments of different identities…
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
ScheduledTimestamp
string
The epoch timestamp at which the transaction is scheduled to be executed.
TransactionActivitySortBy
string
The field to sort transaction activity results by: - creationTimestamp: Sort by when the transaction was first created (default). - lastUpdatedTimestamp: Sort…
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…
TransactionId
object
2 properties
2 required
CorrespondentBankingOwt
object
15 properties
9 required
SEPABeneficiary
object
Beneficiary details for SEPA/IBAN wire transfers.
9 properties
2 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…
ExternalAccountType
string
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
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…
DeliveryTrackingUrl
string
The delivery tracking URL 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…
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…
Id
string
CorrespondentBankingSEPABeneficiary
object
CBT-specific beneficiary details for SEPA/IBAN wire transfers with Banking Circle FI-to-FI field limits.
9 properties
3 required
SWIFTBeneficiary
object
Beneficiary details for SWIFT wire transfers.
9 properties
4 required
StatementTransactionType
string
SpendLimitUpdateMethod
string
The spend limit update method to apply. Currently supported: - OVERWRITE: (default option if nothing selected). Overwrites the previous values for the spendLim…
CorrespondentBankingFasterPaymentsBeneficiary
object
CBT-specific beneficiary details for Faster Payments wire transfers with Banking Circle FI-to-FI field limits.
11 properties
5 required
CorrespondentBankingBusinessAddressAndIdInfo
object
Business identification for a business originator.
2 properties
2 required
Nationality
string
Nationality of the user - using ISO 3166 alpha-2.
DeliveryMethod
string
The delivery methods supported for delivering printed physical cards. If not specified, the STANDARDDELIVERY method will be used.
ThreeDSecureAuthConfig
object
3 properties
2 required
CorrespondentBankingRIXBeneficiary
object
CBT-specific beneficiary details for RIX wire transfers with Banking Circle FI-to-FI field limits.
9 properties
3 required
UserCurrencyTransactionDetails
object
The object representing the user transaction's currency, amount and rate.
2 properties
2 required
BaseCardLevelSpendRules
OutgoingWireTransfer
object
18 properties
6 required
ManagedCardRequest
object
14 properties
5 required
TransactionCancellationReason
string
The reason the scheduled transaction was cancelled.
UserId
string
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
AllLevelSpendRules
object
17 properties
ManagedCard
object
33 properties
20 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
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
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…
CorrespondentBankingOwtValidationOutcome
object
2 properties
2 required
OutgoingWireTransferState
string
The state of the Outgoing wire transfer transaction, as follows: - INVALID: The wire transfer has failed initial validation checks. - PENDINGCHALLENGE: The wir…
IBANDetails
object
Bank details used in case the wire transfer is executed over SEPA or RIX
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…
TransactionForex
object
Foreign exchange details when the transaction involved currency conversion.
4 properties
PhysicalCardActivationCode
string
InstrumentTransactionActivityList
object
A paginated list of transaction activity entries scoped to a single instrument.
3 properties
SystemTransactionSubtype
string
The specific kind of system-generated transaction.
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
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
ManagedCardReplacement
object
Indicates if the card is replaced by another card.
2 properties
2 required
InstrumentType
string
DeliveryTrackingMethod
string
The delivery tracking method for tracking the physical card's delivery status.
ProfileLevelSpendRules
Error
object
2 properties
CorrespondentBankingBankAccountDetails
object
Bank account details for the originator.
2 properties
2 required
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…
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