Managed cards

Get a card

Returns all details of the managed card identified by the id path parameter.

get/managed_cards/{id}

Request

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

Path parameters

idstring required
Example:123456789

The unique identifier of a card.

Response

Success

idstring required

The unique identifier of the card.

profileIdstring required

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.

externalHandlestring required

A uniquely generated code used to identify a card.

This code is to be used instead of the sensitive card number in order to refer to a card when opening a support ticket.

tagstring

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

friendlyNamestring required

The friendly name given to the card.

currencystring required

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

type'VIRTUAL' | 'PHYSICAL' required

The type of card:

  • VIRTUAL: Not a printed or embedded card. The card can be used online or added to digital wallets.
  • PHYSICAL: A physical card that can be printed and shipped to your customers or embedded in a Wearable device. It can be used at physical terminals.
cardBrand'MASTERCARD' | 'VISA' required

The card scheme, or brand of the card.

cardNumberFirstSixstring required

The first six digits of the card number.

cardNumberLastFourstring required

The last four digits of the card number.

nameOnCardstring required

The card holder’s name for the card. This may be verified by merchants when the card is used online. For Physical cards, this field will be printed on the card. The maximum characters allowed will depend on the design chosen and will be provided to you by Weavr when setting up your plastic cards.

nameOnCardLine2string

Line 2 of the 'name on card' field. For Physical cards, this field will be printed on the card. The maximum characters allowed will depend on the design chosen and will be provided to you by Weavr when setting up your plastic cards.

startMmyystring required

The start date of this card, in MMYY format.

expiryMmyystring required

The end date of this card, in MMYY format.

cardLevelClassification'CONSUMER' | 'CORPORATE' required

The card classification determines whether the card is from Consumer or Corporate BINs.

expiryPeriodMonthsinteger required

The validity timeframe of the card, in months.

renewalType'RENEW' | 'NO_RENEW' required

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

The timestamp when the card will be renewed, expressed in Epoch timestamp using millisecond precision.

creationTimestampinteger required

The timestamp when the card was created, expressed in Epoch timestamp using millisecond precision.

cardholderMobileNumberstring

The mobile number including country code of the card holder, needed for 3DS challenge.

authForwardingDefaultTimeoutDecision'APPROVE' | 'DECLINE'

Default decision for auth forwarding on timeout

modestring required

The mode with which this card was created:

  • A prepaid mode card has its own balance and can have funds transferred to or from it.
  • A debit mode card does not have its own balance but will be able to spend funds belonging to its parent managed account, subject to a configurable spend limit.
userIdstring
singleSpendboolean

Indicates if the card is configured for single-spend mode. When true, the card will be automatically blocked after the first successful transaction.

Example response

{
  "id": "234567890",
  "profileId": "10001",
  "externalHandle": "7F3E2B1A9C",
  "tag": "customer-123",
  "friendlyName": "Travel card",
  "currency": "GBP",
  "cardNumber": {
    "value": "4532015112830366"
  },
  "cvv": {
    "value": "123"
  },
  "cardNumberFirstSix": "453201",
  "cardNumberLastFour": "0366",
  "nameOnCard": "Alex Smith",
  "nameOnCardLine2": "Acme Ltd",
  "startMmyy": "0826",
  "expiryMmyy": "0829",
  "expiryPeriodMonths": 36,
  "renewalTimestamp": 1880236800000,
  "creationTimestamp": 1786118400000,
  "cardholderMobileNumber": "+447700900123",
  "billingAddress": {
    "addressLine1": "1 High Street",
    "addressLine2": "Flat 2",
    "city": "London",
    "postCode": "W1A 1AA",
    "state": "Greater London",
    "country": "GB"
  },
  "physicalCardDetails": {
    "bulkDelivery": true,
    "productReference": "PRD_001",
    "carrierType": "STANDARD",
    "replacement": {
      "replacementId": "345678901"
    },
    "deliveryAddress": {
      "name": "Alex",
      "surname": "Smith",
      "addressLine1": "1 High Street",
      "addressLine2": "Flat 2",
      "city": "London",
      "postCode": "W1A 1AA",
      "state": "Greater London",
      "country": "GB",
      "contactNumber": "+447700900123"
    },
    "deliveryTrackingCode": "JD0002231234567890",
    "deliveryTrackingMethod": "ROYAL_MAIL",
    "deliveryTrackingUrl": "https://www.royalmail.com/track-your-item#/tracking-results/JD0002231234567890",
    "nameOnCardLine2": "Acme Ltd"
  },
  "digitalWallets": {
    "pushProvisioningEnabled": true,
    "walletsEnabled": true,
    "artworkReference": "ART_001"
  },
  "threeDSecureAuthConfig": {
    "linkedUserId": "987654321"
  },
  "mode": "PREPAID_MODE",
  "externalData": [
    {
      "name": "Alex Smith",
      "value": "INV-1042"
    }
  ],
  "userId": "987654321",
  "replacement": {
    "id": "345678901"
  }
}

Changes

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