Skip to main content
Weavr Multi Product BackOffice API
Reference

Schemas

IdentityId

{}
objectobject · 2 fields

ImpersonateIdentityLoginRequest

{}
objectobject · 2 fields

Error

{}
objectobject · 2 fields

TokenResponse

{}
objectobject · 1 field

CredentialId

{}
objectobject · 2 fields

ValidationError

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.

{}
objectobject · 5 fields

BulkProcessStatus

enum

Enum:SUBMITTEDRUNNINGPARTIALLY_COMPLETEDCOMPLETEDFAILEDPAUSEDCANCELLED

BulkProcessMode

enum

ON_FAILURE_STOP : the execution of the bulk process stops after the first bulk operation that fails (operation returns a 4xx or 5xx response code). ON_FAILURE_CONTINUE: the execution of the bulk process resumes as normal even when any of the bulk operations fail.

Enum:ON_FAILURE_STOPON_FAILURE_CONTINUE

BulkProcess

{}
objectobject · 7 fields

BulkProcessesPaged

{}
objectobject · 3 fields

SyntaxError

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.

{}
objectobject · 1 field

BulkProcessConflictErrorCode

enum

Enum:VALIDATION_FAILEDUSER_VALIDATION_FAILEDALREADY_SUBMITTEDDUPLICATE_OPERATION_TYPENO_CONFIG_FOUNDINVALID_STATETOO_MANY_REQUESTS

BulkProcessConflict

{}
objectobject · 1 field

BulkId

string

pattern ^[0-9]+$

BulkProcessOperationStatus

enum

Enum:SUBMITTEDRUNNINGCOMPLETEDFAILEDCANCELLED

BulkProcessOperationStatusCounts

{}
objectobject · 2 fields

BulkProcessDetails

{}
objectobject · 8 fields

BulkProcessOperation

{}
objectobject · 7 fields

BulkProcessOperationsPaged

{}
objectobject · 3 fields

BulkProcessExecute

{}
objectobject · 2 fields

Id

string

pattern ^[0-9]+$

InstrumentType

enum

Enum:managed_cardsmanaged_accounts

InstrumentId

{}
objectobject · 2 fields

Fee

{}
objectobject · 2 fields

TransactionId

{}
objectobject · 2 fields

Currency

string

The currency expressed in ISO-4217 code. Example: GBP, EUR, USD.

min length 3max length 3pattern ^[A-Z]*$

CurrencyAmount

The object representing a monetary amount in a particular currency.

{}
objectobject · 2 fields

TransactionState

enum

Status of the transaction.

Enum:INITIALISEDCOMPLETEDREJECTEDFAILEDPENDINGSCHEDULEDCANCELLED

ChargeFee

{}
objectobject · 7 fields

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

pattern ^[0-9]+$

Tag

string

The tag field is a custom field that can be used to search and filter.

max length 50pattern ^[a-zA-Z0-9_-]+$

ManagedInstrumentBalance

Instruments with funds have 2 balances, the availableBalance indicating the funds that are available for transactions such as purchases, and the actualBalance indicating the funds that are actually on the instrument.

{}
objectobject · 2 fields

InstrumentState

enum

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.
  • BLOCKED: The instrument is temporarily blocked and cannot be used. Any funds on the instrument are also frozen. The blockedReason provides more information as to why it was blocked.
  • DESTROYED: The instrument has been permanently destroyed. The destroyReason provides more information as to why it was destroyed.
  • NOT_ENABLED: The instrument is not enabled for use, since the linked user has not completed all necessary verification steps.

Enum:ACTIVEBLOCKEDDESTROYEDNOT_ENABLED

BlockedReason

enum

The reason why the instrument has been blocked:

  • USER: The root, or an authorized user, of the identity owning the instrument has temporarily blocked the instrument.
  • SYSTEM: The platform or an administrator of the platform has temporarily blocked the instrument.
  • LOST: The instrument has been blocked because it was marked as lost.
  • SINGLE_SPEND: The instrument has been automatically blocked after its first successful transaction (single-spend card).

Enum:USERSYSTEMLOSTSINGLE_SPEND

DestroyedReason

enum

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 an authorized user, of the identity owning the instrument has destroyed the instrument.
  • LOST: The instrument was automatically destroyed as it was marked as lost.
  • STOLEN: The instrument was automatically destroyed as it was marked as stolen.
  • EXPIRED: The instrument was automatically destroyed as it expired.
  • COMPROMISED: The instrument was automatically destroyed as it was marked as compromised.
  • SINGLE_SPEND: The instrument was automatically destroyed as it was a single-spend card that was used.

Enum:SYSTEMUSERLOSTSTOLENEXPIREDCOMPROMISEDSINGLE_SPEND

ManagedInstrumentState

{}
objectobject · 3 fields

AccountLowBalanceThreshold

integer · int64

Sends a low balance notification webhook when the available balance drops below this amount. Currency is inherited from the managed account.

ManagedAccount

{}
objectobject · 9 fields

StatementTransactionType

enum

Enum:AUTHORISATIONSETTLEMENTMANUAL_TRANSACTIONTRANSFERSENDDEPOSITAUTHORISATION_REVERSALAUTHORISATION_EXPIRYAUTHORISATION_DECLINEAUTHORISATION_MANUAL_CLOSEMERCHANT_REFUNDMERCHANT_REFUND_REVERSALORIGINAL_CREDIT_TRANSACTIONSETTLEMENT_REVERSALADJUSTMENTCHARGE_FEEWITHDRAWAL_RESERVEWITHDRAWAL_RELEASEFEE_REVERSALOUTGOING_WIRE_TRANSFERAUTHORISATION_CANCELLATIONSYSTEM_TRANSACTIONOUTGOING_DIRECT_DEBIT_COLLECTIONOUTGOING_DIRECT_DEBIT_REFUNDCORRESPONDENT_BANK_TRANSFER

StatementEntryState

enum

The transaction entry state, as follows:

  • PENDING: The transaction has started and some of the fund movements have completed, however additional fund movements are still pending to finalize the transaction.
  • COMPLETED: All fund movements for a transaction have completed.

Enum:PENDINGCOMPLETED

ScaledAmount

A floating point number, represented as a value and its scale. Its actual value can be obtained using the equation: value * pow(10, -scale).

{}
objectobject · 2 fields

UserCurrencyTransactionDetails

The object representing the user transaction's currency, amount and rate.

{}
objectobject · 2 fields

StatementEntry

{}
objectobject · 16 fields

Statement

The list of statement entries.

{}
objectobject · 6 fields

ManagedCard

{}
objectobject · 33 fields

Accepted shapes

Selected by mode

Prepaid Mode CardPREPAID_MODEobject
balances
object
Debit Mode CardDEBIT_MODEobject
parentManagedAccountId*
string
userCurrency
enum
availableToSpend
array<AvailableToSpend · object>

PrepaidModeCard

{}
objectobject · 34 fields

SupportedUserCurrency

enum

Enum:JPYBGNCZKDKKHUFPLNRONSEKCHFISKNOKTRYAUDBRLCADCNYHKDIDRILSINRKRWMXNMYRNZDPHPSGDTHBZAREURUSDGBP

SpendLimitInterval

enum

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 Monday of current week to following Sunday 23:59:59 UTC

  • MONTHLY: 1st of current calendar month to end of current calendar month

  • QUARTERLY: starting from beginning of current quarter where quarters are defined as follows:

  • 1 January 00:00:00 UTC to 31 March 23:59:59 UTC

  • 1 April 00:00:00 UTC to 30 Jun 23:59:59 UTC

  • 1 July 00:00:00 UTC to 30 September 23:59:59 UTC

  • 1 October 00:00:00 UTC to 31 December 23:59:59 UTC

  • YEARLY: 1 January 00:00:00 UTC of current calendar year to 31 December 23:59:59 UTC of current calendar year.

  • ALWAYS: This indicates that the spendLimit is the total amount that can be spent through the card throughout the whole lifetime of the card.

Enum:DAILYWEEKLYMONTHLYQUARTERLYYEARLYALWAYS

AvailableToSpend

{}
objectobject · 2 fields

DebitModeCard

{}
objectobject · 36 fields

SensitiveCardNumber

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 tokenized.

To show the full unredacted card number to your user, you need to embed the Card number UI Component in your application. This accepts the tokenized card number and shows the unredacted card number to the user on screen.

In addition, it is returned only when the current session is stepped-up.

{}
objectobject · 1 field

SensitiveCvv

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 tokenized.

To show the card's CVV to your user, you need to embed the CVV UI Component in your application. This accepts the tokenized CVV and shows the plain text CVV number to the user on screen.

In addition, it is returned only when the current session is stepped-up.

{}
objectobject · 1 field

CardRenewalType

enum

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 new expiry date and CVV.
  • NO_RENEW: Once the expiry date is reached, the card is destroyed.

Enum:RENEWNO_RENEW

BillingAddress

{}
objectobject · 6 fields

BulkCardDelivery

boolean

Bulk delivery is available for deliveryMethods REGISTERED_MAIL or COURIER. All cards marked as bulk and ordered within the fulfillment center’s dispatch window will be sent in bulk. Delivery address must be identical for all orders. contactNumber in the deliveryAddress object is mandatory when bulk is selected. Maximum number of cards delivered in a single box/packet is REGISTERED_MAIL = 90, COURIER = 200.

ManufacturingState

enum

Information on the manufacturing of the physical card, as follows:

  • REQUESTED: The upgrade of the card to physical has been requested.
  • SENT_FOR_FULFILLMENT - The card has been sent for printing.
  • DISPATCHED: The card has been manufactured and dispatched. You may receive a second DISPATCHED event when the manufacturer provides a tracking code.
  • DELIVERED: The card has been received and activated by the recipient.

Enum:REQUESTEDSENT_FOR_FULFILLMENTDISPATCHEDDELIVERED

PhoneNumber

string

min length 5max length 20pattern ^\+[0-9]+$

DeliveryAddress

The delivery address where the physical card is delivered.

{}
objectobject · 9 fields

DeliveryMethod

enum

The delivery methods supported for delivering printed physical cards. If not specified, the STANDARD_DELIVERY method will be used.

Enum:STANDARD_DELIVERYREGISTERED_MAILCOURIERFIRST_CLASS_MAIL

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 receive an additional dispatched notification with the delivery tracking code populated as soon as it is available.

DeliveryTrackingMethod

string

The delivery tracking method for tracking the physical card's delivery status.

DeliveryTrackingUrl

string

The delivery tracking URL for tracking the physical card's delivery status.

PhysicalCardDetails

{}
objectobject · 13 fields

DigitalWallets

{}
objectobject · 3 fields

ThreeDSecureAuthConfig

{}
objectobject · 3 fields

ExternalData

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 processed or used by Weavr but some of the values could be shown in specific reports and used as filters

{}
objectobject · 2 fields

UserId

string

pattern ^[0-9]+$

ManagedCardReplacement

Indicates if the card is replaced by another card.

{}
objectobject · 2 fields

SpendLimit

{}
objectobject · 3 fields

RolloverPolicy

The rollover policy will dictate how Weavr handles any eventual overspending. This is possible if a merchant clears more funds than authorized, or when a merchant clears funds without authorizing, resulting in the availableToSpend value to go into negative. Rollover is relative to a spendLimit.interval

{}
objectobject · 1 field

CommonLevelSpendRules

{}
objectobject · 12 fields

BaseCardLevelSpendRules

{}
objectobject · 13 fields

CardLevelSpendRules

{}
objectobject · 15 fields

ProfileLevelSpendRules

{}
objectobject · 13 fields

IdentityLevelSpendRules

{}
objectobject · 14 fields

AllLevelSpendRules

{}
objectobject · 17 fields

SpendLimitUpdateMethod

enum

The spend limit update method to apply. Currently supported:

  • OVERWRITE: (default option if nothing selected). Overwrites the previous values for the spendLimit object i.e. sets new limits
  • INCREMENT : This will increase the existing value of the spend limit by the amount input the value field. If used in conjunction with an ALWAYS interval, this can be used to increment a spend limit on a periodic basis (controlled by you, e.g. monthly), and means that any 'unused' balance from the previous period will still available to spend. See examples in our documentation

Enum:OVERWRITEINCREMENT

UpdateCardLevelSpendRules

{}
objectobject · 16 fields

ScheduledTimestamp

string

The epoch timestamp at which the transaction is scheduled to be executed.

pattern ^[0-9]+$

ExecutionTimestamp

string

The epoch timestamp at which the transaction was executed, transitioning to a final state such as COMPLETED, REJECTED, or FAILED.

pattern ^[0-9]+$

TransactionCancellationReason

string

The reason the scheduled transaction was canceled.

max length 50pattern ^[ a-zA-Z0-9_-]+$

Transfer

{}
objectobject · 12 fields

Email

string · email

E-mail Address of the user

Mobile

{}
objectobject · 2 fields

Date

{}
objectobject · 3 fields

UserLocale

string

BCP47 locale code (e.g. en, en-US). The locale determines which email and SMS user notification templates are used.

max length 5pattern ^[a-z]{2}(-[A-Z]{2})?$

Example
en-GB

Brand

string

Brand identifier used to determine the set of email and SMS user notification templates. Must be alphanumeric, up to 25 characters, and contain no spaces.

max length 25pattern ^[a-zA-Z0-9]+$

UserPredefinedRole

enum

Enum:CARD_ASSIGNEECARDS_MANAGEMENT_ROLEFUNDS_MANAGEMENT_ROLEACCESS_MANAGEMENT_ROLEADMIN

User

{}
objectobject · 13 fields