System-managed cards

List system cards

Fetch system managed cards matching the search criteria provided.

get/managed_cards/system

Request

  • Base URL: https://sandbox.weavr.io/multi
  • URL: https://sandbox.weavr.io/multi/managed_cards/system
  • Auth: HTTP bearer and API key in header api-key

Query parameters

offsetinteger

The offset value for paging, indicating the initial item number to be returned from the data set satisfying the given criteria. Leave out to fetch the first page of results.

limitinteger
Example:25

The limit of the results for paging, starting at the offset. Limit is always capped at 100.

profileIdstring

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.

Example:10001

Filter by the managed account/card profile. Leave out to fetch all managed accounts/card.

stateInstrumentState[]

Filter by one or more current instrument states. When multiple values are provided, instruments matching any of the states are returned:

  • ACTIVE: The instrument can be used in transactions.
  • BLOCKED: The instrument is temporarily blocked and cannot be used.
  • DESTROYED: The instrument has been permanently destroyed.
  • NOT_ENABLED: The instrument cannot be used because its linked user has not completed the required verification steps.

Leave this parameter out to return instruments in any state.

currencystring

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

Example:GBP

Filter by the managed account/card currency.

Currencies are expressed as an ISO 4217 code. Leave out to fetch all managed accounts/card.

externalHandlestring

Search by the card's externalHandle.

cardNumberFirstSixstring

Filter by first six digits of the card.

cardNumberLastFourstring

Filter by last four digits of the card.

createdFrominteger
Example:1767225600000

Filter for managed accounts/cards created after createdFrom timestamp. Timestamp is expressed in Epoch timestamp using millisecond precision. Leave out to fetch all managed accounts/cards.

createdTointeger
Example:1769903999999

Filter for managed accounts/cards created before createdTo timestamp. Timestamp is expressed in Epoch timestamp using millisecond precision. Leave out to fetch all managed accounts/cards.

mode'DEBIT_MODE' | 'PREPAID_MODE'

Filter by card mode (prepaid mode or debit mode).

tagstring

Filter by the managed account/card tag. The exact tag must be provided, as wildcards are not supported. Leave out to fetch all managed accounts/card.

parentManagedAccountIdstring

Filter by the Id of the parent managed account associated with the card. This is applicable only for debit mode cards.

Response

Success

countinteger

The total number of records (excluding the paging limit).

responseCountinteger

The total number of records returned in this response (always capped at 100).

Example response

{
  "cards": [
    {
      "id": "234567890",
      "profileId": "10001",
      "externalHandle": "7F3E2B1A9C",
      "tag": "customer-123",
      "currency": "GBP",
      "cardNumber": {
        "value": "4532015112830366"
      },
      "cvv": {
        "value": "123"
      },
      "cardNumberFirstSix": "453201",
      "cardNumberLastFour": "0366",
      "nameOnCard": "Alex Smith",
      "startMmyy": "0826",
      "expiryMmyy": "0829",
      "expiryPeriodMonths": 36,
      "renewalTimestamp": 1880236800000,
      "creationTimestamp": 1786118400000,
      "billingAddress": {
        "addressLine1": "1 High Street",
        "addressLine2": "Flat 2",
        "city": "London",
        "postCode": "W1A 1AA",
        "state": "Greater London",
        "country": "GB"
      },
      "mode": "PREPAID_MODE",
      "externalData": [
        {
          "name": "Alex Smith",
          "value": "INV-1042"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.