Activate a physical card
Use this when the cardholder has received their physical card and wants to start using it.
It activates the physical card identified by the id path parameter. A card that has been printed and delivered is inactive until this call succeeds. It can't be used in person or at an ATM, and its PIN can't be read.
Fields
activationCode is the code set when the card was upgraded to physical. If you supply it, it is checked against the code recorded at upgrade, and a mismatch fails with ACTIVATION_CODE_INVALID. If you leave it out, no check is carried out and the card is activated regardless.
Conflicts
Activation applies once, to a physical card that is still usable. Repeating it fails with INSTRUMENT_ALREADY_ACTIVATED, and a card that is blocked or destroyed fails with INSTRUMENT_BLOCKED or INSTRUMENT_DESTROYED. A virtual card that was never upgraded fails with INSTRUMENT_NOT_PHYSICAL.
Next steps
Once activated, the cardholder can retrieve their PIN with Get PIN for a physical card.
Request
- Base URL: https://sandbox.weavr.io/multi
- URL: https://sandbox.weavr.io/multi/managed_cards/{id}/physical/activate
- Auth: HTTP bearer and API key in header api-key
Path parameters
The unique identifier of the managed card.
Headers
A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.
Request body
Example request
{
"activationCode": "123456"
}Response
Success
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.