Skip to content

Get all managed cards

Request

Fetch cards matching the search criteria provided.

Security
auth_token and api-key
Query
offsetinteger, (int32), >= 0

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, (int32), [ 1 .. 100 ]

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

profileIdstring(ProfileId)^[0-9]+$

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

friendlyNamestring, [ 1 .. 50 ] characters

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

The exact name must be provided, as wildcards are not supported.

stateArray of strings, unique
state.blockedReasonArray of strings, unique
state.destroyedReasonArray of strings, unique
currencystring, = 3 characters(Currency)^[A-Z]*$

Filter by the managed account/card currency.

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

typestring

Filter by the type of the card.

Enum:"VIRTUAL""PHYSICAL"
renewalTypestring

Filter by the renewal type of the card.

Enum:"RENEW""NO_RENEW"
externalHandlestring

Search by the card's externalHandle.

cardNumberFirstSixstring^[0-9]{6}$

Filter by first six digits of the card.

cardNumberLastFourstring^[0-9]{4}$

Filter by last four digits of the card.

createdFrominteger, (int64)

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, (int64)

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.

modestring

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

Enum:"DEBIT_MODE""PREPAID_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^[0-9]+$

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

manufacturingStateArray of strings, unique
userIdstring(UserId)^[0-9]+$

The unique identifier for the user.

curl -i -X GET \
  'https://sandbox.weavr.io/multi/managed_cards?offset=0&limit=1&profileId=string&friendlyName=string&state=ACTIVE&state.blockedReason=USER&state.destroyedReason=SYSTEM&currency=str&type=VIRTUAL&renewalType=RENEW&externalHandle=string&cardNumberFirstSix=string&cardNumberLastFour=string&createdFrom=0&createdTo=0&mode=DEBIT_MODE&tag=string&parentManagedAccountId=string&manufacturingState=REQUESTED&userId=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'api-key: YOUR_API_KEY_HERE'

Responses

Success

Headers
request-refstringrequired

A request identifier. Providing this reference when contacting our support team will help us investigate your query.

Bodyapplication/json
cardsArray of objects(ManagedCard)
countinteger, (int32)

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

responseCountinteger, (int32)

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

Response
{ "cards": [ {} ], "count": 0, "responseCount": 0 }